DHT based high-performance microservices framework, by Bitfinex
Switch branches/tags
Nothing to show
Clone or download
Fetching latest commit…
Cannot retrieve the latest commit at this time.
Permalink
Failed to load latest commit information.
doc docs: explain rpc, restructure docs Jun 6, 2017
logos add logos Jun 6, 2017
.gitignore add .gitignore Jun 6, 2017
LICENSE
README.md fix typo in README Jun 8, 2018

README.md

Grenache Logo

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

Grenache uses Distributed Hashtables, known from Bittorrent, to build a network between peers. It's 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.

Contents

Features

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

Implementations

Grape (the core)

Peer Implementations

Transports:

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

Patterns:

  • PUT/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.

Node.JS Clients

Ruby Clients

CLI Clients

Grape Network Composition

1. The Grape: Grenache Discovery Node

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

2. Clients: Grenache Client implementations on specific Transports

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

Grenache in Action: a RPC example

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.

DHT with 2 workers and one client

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:

Step 1: worker announces service

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

Step 2: worker announces service

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.

Step 3: worker announces service

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

Step 4: worker announces service

Articles

Background

Contribute

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

Contacts