https://github.com/xaviershay/consul-client

Ruby client gem for Consul HTTP API.
https://github.com/xaviershay/consul-client

Last synced: about 1 month ago
JSON representation

Ruby client gem for Consul HTTP API.

• Host: GitHub
• URL: https://github.com/xaviershay/consul-client
• Owner: xaviershay
• Created: 2014-08-17T22:03:43.000Z (over 10 years ago)
• Default Branch: master
• Last Pushed: 2016-07-20T21:42:02.000Z (over 8 years ago)
• Last Synced: 2024-04-29T15:44:37.198Z (8 months ago)
• Language: Ruby
• Size: 25.4 KB
• Stars: 42
• Watchers: 7
• Forks: 7
• Open Issues: 1
• Metadata Files:
  • Readme: README.md

Awesome Lists containing this project

• awesome-consul - xaviershay/consul-client

README

        
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](https://github.com/WeAreFarmGeek/diplomat)?_

Usage

-----

It's a gem:

    gem install consul-client

Simple API usage:

```ruby

require 'consul/client'

client = Consul::Client.v1.http

client.get("/agent/self")

```

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.

Documentation

-------------

[Comprehensive YARD documentation is

available](http://rubydoc.info/github/xaviershay/consul-client/master), though

honestly you're probably better off just working from the `example` directory.