engine-consistent-hashing-service

README

engine-consistent-hashing-service

engine-consistent-hashing-service is designed to provide high available consistent-hashing service, and supported by HA policies (replication + oplog).

Get Started

Prerequisites

• OS: Linux
• Golang: v1.12+

Installation

Clone

• Clone this repo to your local machine using https://github.com/amazingchow/engine-consistent-hashing-service.git.

Setup

# build the binary
make build

# start the service
./engine-consistent-hashing-service --conf=conf/worker.json

Example

# add shard
curl -XPOST -d \
    '{"shard": {"uuid": "192.168.0.11"}, "record": true, "replay": false, "sender": "SENDER_TYPE_CLIENT"}' \
    http://localhost:18181/v1/shard

# list shards
curl http://localhost:18181/v1/shards

# delete shard
curl -XPOST -d \
    '{"uuid": "192.168.0.11", "record": true, "replay": false, "sender": "SENDER_TYPE_CLIENT"}' \
    http://localhost:18181/v1/delshard

# map key
curl -XPOST -d \
    '{"key":{"key": "foo"}, "record": true, "replay": false, "sender": "SENDER_TYPE_CLIENT"}' \
    http://localhost:18181/v1/key

Documentation

Api Design

• refer to swagger.

Reference

• Consistent Hashing, Danny Lewin, and the Creation of Akamai - MIT Prof. Tom Leighton
• Consistent Hashing and Random Trees: Distributed Caching Protocols for Relieving Hot Spots on the World Wide Web
• Consistent Hashing with Bounded Loads
• A Fast, Minimal Memory, Consistent Hash Algorithm

Contributing

Step 1

• 🍴 Fork this repo!

Step 2

• 🔨 HACK AWAY!

Step 3

• 🔃 Create a new PR using https://github.com/amazingchow/engine-consistent-hashing-service/compare!

Support

• Reach out to me at jianzhou42@163.com.

License

• This project is licensed under the MIT License - see the MIT license for details.