Simple High-Performance High-Scalability Inbox Notification Service
JavaScript Shell
Fetching latest commit…
Cannot retrieve the latest commit at this time.
Permalink
Failed to load latest commit information.
benchmark
bin
examples
lib
rpm
test
tools
utils
.gitattributes
.jshintrc
.travis.yml
Gruntfile.js
License.txt
README.md
gjslint.conf
package.json

README.md

POPBox Build Status Dependency Status

##Simple High-Performance High-Scalability Inbox Notification Service ####Do you need really simple queues to distribute your work through a P&C schema? No configuration needed, just name your queue and use it ####Do you need huge amounts of really fast inboxes for all your clients? Redis support really shines at this ####Do you need to track the state of your notification messages? Transient and historic state management ####Are you looking for a http client blocking communication mechanism? Up to 10K concurrent connections per node, no resource gets wasted ####Stablish a SUBSCRIBE/PUSH notification mechanism over your notification boxes Connect once and receive streamed notification messages ####Do you want it 100% H-Scalable? Scalability has been taken into account from the very beginning (not dynamic yet, but soon) ####New add-ons may be included in order to suit any client need For example invoke an external accounting system every time a mesage is consumed

PopBox has been developed using:

WebStorm

Ask us for your OpenSource License

You can find some usage examples at examples folder

HTTP API DOCUMENTAION

#Getting Started The default configuration should be suitable to get started (to customize your installation see "Setup the config file" section below). Before starting the agents:

  • Make sure there is a Redis (v2.6) instance running on your machine.
  • Update PopBox dependencies executing following command from the PopBox folder:
    npm install

Once the environment is ready, start the Agent:

    bin/popbox

Your agent should be ready to accept requests!

#Installation Notes First draft of the installation manual. Please contact us at dtc_support@tid.es if you have any trouble to include further refinements.

##Architecture overview PopBox has a distributed architecture composed by processing nodes, aka. Agents, and data management nodes (Redis instances). Optionally we can provide a MongoDB in order to keep historic track of the state changes and error log.

The Agents will provide an stateless service with all the necessary operations for any of the roles: Provisioner (may produce and provision new messages to the queues), Consumers (may Pop messages from their inbox), Inspectors (may query transactions and queues to obtain right time information).

The overall architecture may be seen as a central DB cluster (with specialised nodes depending on stored data types) surrounded by N Agents interacting throught that cluster.

##Setup the config file At PopBox/lib/baseConfig.js

In this file it is mandatory to stablish where reside the Redis DBs by stabilising the following properties: ###Queue Servers

exports.redisServers = [{host:'localhost'}, {host:'localhost', port:'6789'}];

A list of Redis servers to manage the different queues of the system. Queues will be distributed among the nodes (non elastic yet). If you have more than one Agent it is important to keep the same redisServers list in all of them. ###Transaction Servers

exports.tranRedisServer = {'localhost' [, port:]};

The hostname of the Redis Server intended to keep track of the transactions and their delivery state.

The same Redis instance may be used between transactions and queues.

###Historic support (optional)

exports.evLsnr.mongoHost = 'localhost';
exports.evLsnr.mongoPort = 27017;

Optionally you may indicate a MongoDB in order to keep track of historic data.

##Links and resources dependencies

Redis: http://http://redis.io/ (v2.6 or higher required)
Mongo: http://www.mongodb.org/downloads
Node: http://nodejs.org (tested in v6.* v8.* and v10.*)

###HTTPS Support Popbox is expecting server certificates in order to stablish secure comunitions with secure boxes (BasicAuth-HTTPS).

You may enable the Secure behavior at config file:

/**
 *
 * @type {boolean}
 */
exports.enableSecure= true;

The certificates are located in /PopBox/utils/ by default, or you can choose your own path in the config file.

/**
 *
 * @type {String} absolute path for the certs and keys. Default will be chosen when empty.
 */
exports.agent.crtPath = "";

Epected files:

server.key
server.crt

To obtain them you may execute the following script (You must have openssl properly installed):

cd [PopBox]/utils/
./create_http_certificates.sh

or execute these commands:

openssl genrsa -des3 -out server.key 1024
openssl req -new -key server.key -out server.csr
cp server.key server.key.org
openssl rsa -in server.key.org -out server.key
openssl x509 -req -days 365 -in server.csr -signkey server.key -out server.crt

At this point you should be able to start all the processes: Redis External Systems (Optional) Agents (node agent.js)

##PopBox HA current approach Several PopBox replicas Master-SlaveChain may be deployed. To do so we must specify several properties in the config.js file:

exports.slave = false; //true

Enables the slave behaviour

exports.masterRedisServers = [{host: xx, port:yy},{…}];

When slave===true this property must define a one to one relationship between exports.redisServers and their masters

exports.masterTranRedisServer = {};

When slave===true this property must define a one to one relationship between exports.tranRedisServers and their master.

####Deployment architecture for HA

(Agent->node agent.js, Ri->Redis server)

Agent(slave===false) --> {R1,..,Rn}

Agent'(slave===true)  --> {R1'(slave of R1),…, Rn'(slave of Rn)}

Agent''(slave===true)  --> {R1''(slave of R1'),…, Rn''(slave of Rn')}

Slave Rx' and Rx'' nodes contain a replica of their master Rx datasets. On master node (Agent) fail over new request MUST be redirected to the Agent'(slave===true) entry point (you should configure you balancing mechanism to do so).

Once a slave Agent node receives a request it will be promoted to master, getting disconnected from previous master node and continuing processing incoming requests.

At this point we should restart the first Agent as a slave of the last one (Agent'') then sync mechanism between Rx'' and Rx will be triggered (with no impact over the new master Redis node Rx'). It's recommended to establish a cyclic relationship among the different PopBox instances Rx<-Rx'<-Rx''<-(Rx).