clu's Introduction

clu

UNMAINTAINED – But turns out this module still works with node 6

A cluster manager with a built in CLI and a simple API for plugins. clu will spawn the requested number of workers, which will share the same port. This way the load gets distributed across all workers and multiple cores can be used effectively. It uses the node cluster API to do this.

Inspired by cluster.

Features:

built in CLI (optional)
zero downtime restarts
restarts workers one after another
add or remove workers on the fly
uses the node cluster API

Getting Started

npm install --save clu

Create a server.js that starts your app.

var clu = require('clu');

clu.createCluster({
  exec: './app.js',
  workers: 2,
  silent: false,
  silentWorkers: true,
  cli: true
});
// short: clu.createCluster('./app.js');

clu.use(clu.repl());

Start your cluster with node server start

Use node server --help for a list of all commands.

You can also start the server with node server. This will start the server in the foreground.

Documentation

Plugins

Plugins can be used like this:

var cluDnode = require('clu-dnode');
clu.use(cluDnode());
clu.use(clu.repl('myRepl.sock'));

Built in:

clu.repl() - a repl interface

Official:

clu-dnode - dnode interface for clu

3rd Party: contact me if you create any :)

License

MIT

clu's People

Contributors

Stargazers

Watchers

clu's Issues

needs more tests

add deploy command & method

Git and tar (?)

CLI does not work on Windows

Because dnode does not install.

Improve CLI error handling

`node server stop` doesn't stop processes

Hi there, trying to use clu, but it seems node server stop doesn't stop the processes. It does remove the .sock files in .clu, but the processes themselves never end, and .clu/pids/master.pid is never removed either.
(Speaking of which, should .clu/pids contain a file for each process? since that's NOT the case)

Some context: using clu v0.3.8 on Mac OS X v10.10.3 with node v0.12.4

//file: server.js
var clu = require( "clu" );

clu.createCluster( {
  exec: "./app.js",
  workers: 1,
  silent: false,
  silentWorkers: false,
  cli: true
} );
// short: clu.createCluster("./app.js");

clu.use( clu.repl() );