Consul Client

Ruby client library for Consul HTTP API, providing both a thin wrapper around the raw API and higher level behaviours for operating in a Consul environment.

This library is experimental and unmaintained! You probably shouldn't use it! Have you tried Diplomat?


It's a gem:

gem install consul-client

Simple API usage:

require 'consul/client'

client = Consul::Client.v1.http

See example directory for more:

  • puts_service.rb is a minimum server that demostrates coordinated shutdown.
  • http_service.rb builds on top of webrick for an auto-updating server with coordinated restart.

A Vagrantfile is provided that makes three Consul nodes, which is handy for playing around.


Comprehensive YARD documentation is available, though honestly you're probably better off just working from the example directory.