fyang1024 / grenache Goto Github PK

Grenache is a DHT based high-performance microservices framework by Bitfinex. Its decentralised and optimized for performance. Because its simple, it is easy to understand and to set up.

Grenache uses Distributed Hashtables, known from Bittorrent, to build a network between peers. Its based on Kademlia.

Peers can send each other commands (RPC), and they can also store values in the DHT. Pub/Sub is also possible.

The Grenache Ecosystem supports Ruby and Node.js. There are multiple transports available: HTTP (plain & TLS), Websocket (plain & TLS), ZeroMQ.

• Features
• Implementations
• Grape Network Composition
• Grenache in Action: a RPC example
• Background
• Contribute
• Contacts

• Decentralised / Distributed architecture
• Easy Bootstrap
• Indefinite scalability and shapes
• High-Performance

• https://github.com/bitfinexcom/grenache-grape

Transports:

• WebSocket transport: super-fast, great for Internet
• HTTP transport: great for Internet
• ZeroMQ transport: super-fast, perfect for internal networks

Patterns:

• PUB/GET: put/get data to/from the DHT
• RPC: simple and efficient RPC pattern
• PUB/SUB: (Work In Progress)

Note: At the moment there is no interoperability between WebSocket and ZeroMQ implementations. A Proxy implementation will come later.

• https://github.com/bitfinexcom/grenache-nodejs-ws: WebSocket based Grape microservices
• https://github.com/bitfinexcom/grenache-nodejs-http: HTTP based Grape microservices
• https://github.com/bitfinexcom/grenache-nodejs-zmq: ZeroMQ based Grape microservices
• https://github.com/bitfinexcom/grenache-nodejs-ws-tls: WebSocket based Grape microservices with TLS support
• https://github.com/bitfinexcom/grenache-nodejs-link: HTTP based connections to the DHT

• https://github.com/bitfinexcom/grenache-ruby-ws: WebSocket based Grape microservices
• https://github.com/bitfinexcom/grenache-ruby-http: HTTP based Grape microservices

Grenache-Grape builds the Grenache Network. It offers multiple DHT interaction APIs for Clients: service discovery and DHT data storage.

Features

• Announce a Service
• Lookup a Service
• Push data to DHT

Grenache supports WebSocket, HTTP (plain / TLS) and ZeroMQ as transport protocols.

Features

• Offer / Publish a Service: create and announce a service on the DHT
• Request / Subscribe to Service: find a service throught the DHT and connect to it
• Store and retrieve data in the DHT

Within a Grenache network, connected peers can interact in different ways with each other. They can store and retrieve data in the DHT. They can also work in a Pub/Sub pattern. Or they can work in RPC mode, with different workers and clients.

In the diagram above we see three Grape nodes forming the DHT network. We have two workers connected. There is also another peer which will act as client.

Our workers announce their service to the DHT:

Now peers can make use of the service and send commands to a service. They send send their remote command to the DHT.

The DHT looks up any peers that announce the service. In our case the two workers. The client receives the IP of the two workers.

Finally the client connects to both workers, who are executing the command and send back the result to the client.

• Distributed Hash Table introduction
• Kademlia on Wikipedia
• Kademlia: A Peer-to-Peer Information System Based on the XOR Metric

Any contribution in form of question, issue, idea and pull requests is well accepted

• Paolo Ardoino