/ey-provisioner

Ruby client gem for the EngineYard instance provisioning API

Primary LanguageRubyMIT LicenseMIT

Ey::Provisioner

Build Status Code Climate

The EY Provisioner is a Ruby based client gem for interacting with the EngineYard Instance Provisioning V2 API. See this blog post

Installation

Add this line to your application's Gemfile:

gem 'ey-provisioner'

And then execute:

$ bundle

Or install it yourself as:

$ gem install ey-provisioner

Usage

To use the ey-provisioner start by creating a connection:

connection = Ey::Provisioner::Connection.new(token)

Via the connection, you get the relevant environment:

env = connection.environment(1234)

On the connection you can now add or remove instances:

env.add_instance(:name => "my-instance", :role => "util", :instance_size => 'xlarge')
env.remove_instances(:role => "util") # Will shutdown all util servers

Getting your token

See the EY docs for instructions on how to get your token.

Getting the environment ID

Within the EngineYard interface, click on the deployment history link within the Environment. The page's URL will be of the form .../environments/x/deployments. X will be the environment ID.

Limitations

The Gem does not currently support retrieving provisioning status nor does it allow you to list all environments for the account.

Documentation

Full documentation can be found here.

Contributing

  1. Fork it
  2. Create your feature branch (git checkout -b my-new-feature)
  3. Commit your changes (git commit -am 'Added some feature')
  4. Push to the branch (git push origin my-new-feature)
  5. Create new Pull Request