isabella232 / nomad_client

Ruby client gem for interacting with Hashicorp Nomad HTTP API

NomadClient

Client gem for interacting with Hashicorp's Nomad HTTP API.

Installation

Add this line to your application's Gemfile:

gem 'nomad_client'

And then execute:

$ bundle

Or install it yourself as:

$ gem install nomad_client

Usage

Initialisation

For a default client

nomad_client = NomadClient::Connection.new('https://nomad.local')

Or to override default configuration

nomad_client = NomadClient::Connection.new('https://nomad.local') do |config|
  config.port = 4647
  config.api_base_path = '/v2'
end

Querying endpoints

job = nomad_client.job.get('my-job-id') # returns a Faraday::Response

if job.success?
  job.body # A Hashie::Mash of the JSON payload returning from the job/my-job-id API endpoint
else
  # handling of errors here
end

Docs

For documentation about all the endpoints available in the gem, please see the doc directory, or clone the repository and run bundle exec rake yard to get the latest docs if they're out of date.

Contributing

Bug reports and pull requests are welcome on GitHub at https://github.com/xyzjace/nomad_client.

Please ensure to include test coverage with any pull requests opened against the repository.