cluster-role

A wrapper around the native Node 'cluster' built-in, that provides a convenient interface to start up multiple workers by configuration.

Features:

• Start workers of different roles, multiple instances per role, en masse by configuration
• Automatic bootstrapping of worker processes to start the required 'role'
• Configurable number of instances per role, or bound to CPU cores
• Configurable respawning of new worker process to replace deceased ones
• Automatic port assignment for workers by role
• Send message to a group of workers by role

Installation

npm install cluster-role

Usage

The following is taken from full demo code at node-cluster-example

var cluster = require('cluster-role');
 
if (cluster.isMaster) {
    // Start a group of workers running ./worker/webhttp.js,
    // of as many instances as there are CPU cores, and respawn
    // new ones if any dies.
    // Also start another group of 2 workers running
    // ./worker/adminhttp.js, and respawn if any dies.
    cluster.spawn([
        {
            "role": "webhttp",
            "instance": "cpu",
            "respawn": true
        },
        {
            "role": "adminhttp",
            "instance": 2,
            "respawn": true
        }
    ]);
 
    // Now start a single worker running ./extra/extrahttp.js,
    // do not respawn if it dies.
    cluster.spawn({
        "role": "extrahttp"
    }, './extra');
}

API

.isMaster

True if the process is a master. This is a convenience to the underlying Node 'cluster' implementation

.isWorker

True if the process is a worker. This is a convenience to the underlying Node 'cluster' implementation

.spawn(config, [dir])

Start worker processes described by config. This may be a single role object, or an array of multiple role objects. Each may have the following properties:

• role : This should correspond to an executable JS file in dir where workers reside.
• instance (optional) : The number of worker instances to spawn, or 'cpu' to denote the number of CPU cores. Defaults to 1.
• respawn (optional) : Whether to respawn a new process when one dies. Defaults to false.
• port (optional) : A port assignment for all workers of this role, or 'auto' to use an automatic allocation. This sets process.env.PORT in worker processes, but workers may choose not to respect it.

Additionally, a custom worker directory can be specified.

• dir (optional) : The name of a directory where all worker JS files reside. Defaults to a subdirectory named worker under the same directory as the JS that initiated spawn().

.onListen(role, callback)

Receive port listening events from workers of a given role. Note that this is triggered when the first member worker of the role starts listening on a port.

• role : The role in which a group of workers have been created to participate.
• callback: A callback of signature function(worker, address, env) where
  • worker: The Node worker object;
  • address: An address object containing IP address and port;
  • env: OS environment variables in the worker process.

.send(role, message)

Send a message to all workers of a given role. In the worker process, the message is received via process.on('message', callback).

• role : The role in which a group of workers have been created to participate.
• message: The message, which may be JSON.

License

(The MIT License)

Copyright (c) 2014 Leonard Wu [e-mail]

Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the 'Software'), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:

The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED 'AS IS', WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.