Consul Servant is a Consul based cluster manager and orchestrator. It is a single executable that installs consul in the current directory and starts a new cluster:
VERY ALPHA STAGE, use at your own risk
Consul Servant allows to build an arbitrary big cluster based in Consul and adds job management queues and a command line client (consul_visa)
+---------------------------------------+ +----------------------------------------+
| | | |
| | | |
| +-------------------------------+ | | +---------------------------------+ |
| | | | | | | |
| | Consul_servant | | | | Consul_servant | |
| | | | | | | |
| | | | | | | |
| | | | | | | | Any number of nodes
| | +-------------+ | | | | +---------------+ | |
| | | | | | | | | | | |
| | | Consul +--------------------------------------------+ Consul | | |
| | | | | | | | | | | |
| | ^ +-------------+ | | | | +---------------+ | |
| | | | | | +---------------+---------------+-+ |
| +-------------------------------+ | | |
+---+-------------------------------+---+ +----------------------------------------+
|
| Node1 Node2
|
|
|
|
|
|
X+XXXXXXXX XXXXXXXX
XX XX
X Consul_visa CLI X
X XX
XXX XX
XXXXXXXXXXXXXXXXX
Execute
curl https://raw.githubusercontent.com/jmcarbo/consul_servant/master/bin/install_servant | bash
in each node you whant to integrate in the cluster.
Consul_servant is tested to run in Ubuntu and OSX.
Run make start_cluster to run a sample docker cluster. Note that consul_servant is no limited to docker at all
but this is a quick way to test the environment.
Run make run_client to start a container shell. Inside the container shell run ./consul_servant -join $CIP &
You now have a 4 node consul cluster. Then you are ready to start using the CLI enviroment via consul_visa. Try:
./consul_visa start -c "echo hello world" job1
or from a file
echo { "ID": "job1", Command": "echo hello world" } >job1.job
./consul_visa start job1.job
The job will be runned in any of the 4 nodes in the cluster. To see job execution status run:
./consul_visa show job1
If you wish to schedule the job to node1 use:
./consul_visa start -n node1 -c "echo hello world" job1
If you wish to schedule the job to all cluster nodes use:
./consul_visa start -all -c "echo hello world" job1
I borrowed some commands from github.com/bryanl/consulcli and added them to consul_visa. A list of consul visa commands:
NAME:
consul_visa - access consul_servant cluster from the command line
USAGE:
consul_visa [global options] command [command options] [arguments...]
VERSION:
0.0.0
COMMANDS:
kv-get get an item from the kv store
kv-keys list keys in the kv store
kv-list list items in the kv store
kv-deltree delete trees in the kv store
node-eject eject node
node-list list nodes
start, s Start a job in the cluster
show, w Show job status
help, h Shows a list of commands or help for one command
GLOBAL OPTIONS:
--help, -h show help
--version, -v print the version
./consul_servant
To add more nodes run the following command in another machine (virtual or metal)
./consul_servant -join <firt node ip> [-server]
Note that you can add either server or client nodes to the consul mesh.
Now you have an orchestrated consul server with two job queues http://localhost:8500/v1/kv/jobs and http://localhost:8500/v1/kv/queues/. The first queue "jobs" is honoured by any consul node, while the queue is honoured only by the named node.
To submit a job just type
curl -X PUT -d '{ "Command": "echo hello world" }' http://localhost:8500/v1/kv/jobs/<job id>
or
curl -X PUT -d '{ "Command": "echo hello world" }' http://localhost:8500/v1/kv/queues/<node name>/<job id>
The job will be runned by the first node that gets the job payroll. Note that job id must be unique across the cluster.
Job results can be found at:
curl -X GET http://localhost:8500/v1/kv/jdone_jid/jobs/<job id>?raw
or
curl -X GET http://localhost:8500/v1/kv/queues/<node name>/jdone_jid/jobs/<job id>?raw
Current extra job parameters are:
{ "Command": "command to run",
"NoWait": true|false,
"Timeout": <timeout in seconds default 60 seconds>,
"Type": "<shell| ...>",
"Services": [ {"ID": "service id", "Name": "service Name", ... }]
}
Job with service registration:
curl -X PUT -d '{"Command": "docker ps", "Timeout": 3, "Services": [ { "ID": "blu3", "Name": "blu3", "Port": "80", "Check": {"TTL": "23s"}} ] }' http://localhost:8500/v1/kv/jobs/61
Thats all for now. I accept further development suggestions.