You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
{{ message }}
This repository was archived by the owner on Sep 25, 2020. It is now read-only.
(This project is no longer under active development.)
Ringpop is a library that brings cooperation and coordination to distributed
applications. It maintains a consistent hash ring on top of a membership protocol
and provides request forwarding as a routing convenience. It can be used to
shard your application in a way that's scalable and fault tolerant.
Requirements
Node 0.10 (0.10.32 or higher)
Installation
To install Ringpop for usage as a library:
npm install ringpop
Prepare the current directory for development:
npm install
To be able to run the tests, make sure you have your open file limit
restriction on at least 4K:
ulimit -n 4096
Tick Cluster
An example application tools/tick-cluster.js is included in ringpop-common
repository. It just launches a ringpop cluster of a given size. Using this
application is the quickest way to start a ringpop cluster.
Run a 2-node Ringpop cluster from the command-line. Install Ringpop
and TChannel, copy/paste the below into your editor and run!
varRingpop=require('ringpop');varTChannel=require('tchannel');functionCluster(opts){this.name=opts.name;this.size=opts.size;this.basePort=opts.basePort;this.bootstrapNodes=[];// Create the bootstrap list of nodes that'll// be used to seed Ringpop for its join request.for(vari=0;i<this.size;i++){this.bootstrapNodes.push('127.0.0.1:'+(this.basePort+i));}}Cluster.prototype.launch=functionlaunch(callback){varself=this;vardone=after(self.size,callback);for(vari=0;i<this.size;i++){varaddr=this.bootstrapNodes[i];varaddrParts=addr.split(':');vartchannel=newTChannel();varringpop=newRingpop({app: this.name,hostPort: addr,channel: tchannel.makeSubChannel({serviceName: 'ringpop',trace: false})});ringpop.setupChannel();// First make sure TChannel is accepting connections.tchannel.listen(+addrParts[1],addrParts[0],listenCb(ringpop));}functionlistenCb(ringpop){// When TChannel is listening, bootstrap Ringpop. It'll// try to join its friends in the bootstrap list.returnfunctiononListen(){ringpop.bootstrap(self.bootstrapNodes,done);};}};// IGNORE THIS! It's a little utility function that invokes// a callback after a specified number of invocations// of its shim.functionafter(count,callback){varcountdown=count;returnfunctionshim(err){if(typeofcallback!=='function')return;if(err){callback(err);callback=null;return;}if(--countdown===0){callback();callback=null;}};}if(require.main===module){// Launch a Ringpop cluster of arbitrary size.varcluster=newCluster({name: 'mycluster',size: 2,basePort: 3000});// When all nodes have been bootstrapped, your// Ringpop cluster will be ready for use.cluster.launch(functiononLaunch(err){if(err){console.error('Error: failed to launch cluster');process.exit(1);}console.log('Ringpop cluster is ready!');});}