A HTTP Ruby API for Consul
What's Diplomat for?
Diplomat allows any ruby application to interact with Consul's distributed key value store, and also receive information about services currently available in the Consul cluster.
Does it work in rails?
Yup! In fact, we're using it in all of our rails production apps instead of any previous case where it'd be right to use environment variables according to 12Factor configuration principals. This gives us the ability to scale up without making any changes to the actual project codebase, and to move applications around the cluster with ease.
Here's what a production database.yml file might look like:
<% if Rails.env.production? %> production: adapter: postgresql encoding: unicode host: <%= Diplomat::Service.get('postgres').Address %> database: <%= Diplomat.get('project/db/name') %> pool: 5 username: <%= Diplomat.get('project/db/user') %> password: <%= Diplomat.get('project/db/pass') %> port: <%= Diplomat::Service.get('postgres').ServicePort %> <% end %>
Why would I use Consul over ZooKeeper, Doozerd, etcd, Nagios, Sensu, SmartStack, SkyDNS, Chef, Puppet, Ansible, etc?
How do I install Consul?
Here's a few examples of how diplomat works:
Getting the value of a key in the key-value store is as simple as using one of the following:
foo = Diplomat.get('foo') # => "bar"
Setting the value of a key is just as easy:
foo = Diplomat.put('foo', 'bar') # => "bar"
Looking up a service is easy as pie:
foo_service = Diplomat::Service.get('foo') # => #<OpenStruct Node="hotel", Address="22.214.171.124", ServiceID="hotel_foo", ServiceName="foo", ServiceTags=["foo"], ServicePort=5432>
Or if you have multiple nodes per service:
foo_service = Diplomat::Service.get('foo', :all) # => [#<OpenStruct Node="hotel", Address="126.96.36.199", ServiceID="hotel_foo", ServiceName="foo", ServiceTags=["foo"], ServicePort=5432>,#<OpenStruct Node="indigo", Address="188.8.131.52", ServiceID="indigo_foo", ServiceName="foo", ServiceTags=["foo"], ServicePort=5432>]
You can create a custom configuration using the following syntax:
Diplomat.configure do |config| # Set up a custom Consul URL config.url = "localhost:8888" # Set up a custom Faraday Middleware config.middleware = MyCustomMiddleware end
This is traditionally kept inside the
config/initializers directory if you're using rails. The middleware allows you to customise what happens when faraday sends and receives data. This can be useful if you want to instrument your use of diplomat, for example. You can read more about Faraday's custom middleware here.
- Updating docs with latest changes
- PUTting and DELETEing services
- Allowing the custom configuration of the consul url to connect to
Deleting KeysNeeds a test Listing available ServicesDone HealthDone MembersDone StatusDone