Ruby client library for automating DataCentred account management.

www.datacentred.co.uk

gem install datacentred

or

(in Gemfile or .gemspec)

gem 'datacentred'

then

require 'datacentred'

This API allows you to automate operations against your DataCentred account.

Operations include:

• Creating and managing users;
• Creating and managing roles for users;
• Managing OpenStack Project creation, quota adjustments, and user assignments;
• Viewing detailed usage/billing information for your account.

The API uses two pieces of information to authenticate access.

A unique access key specific to your DataCentred account, and a secret key which is generated once.

To get started:

1. Find your API access key and secret key at my.datacentred.io

2. Set your credentials by exporting your access key and secret key as environment variables:

export DATACENTRED_ACCESS="my_access"
export DATACENTRED_SECRET="my_secret"

Or setting your keys manually using the following methods:

Datacentred.access_key = 'my_access'
Datacentred.secret_key = 'my_secret'

NOTE: If you use this approach, the gem will ignore any values assigned to the environment variables.

The User, Project, and Role entities all support CRUD operations via the following methods:

• .all - returns an index of all entities of this type.
• .create params - creates a new entity where params is a hash of properties.
• .find id - finds the entity via the unique identifier id.

returned objects can be edited and deleted:

• object.name = "Foo" - changes the name property to Foo.
• object.save - saves any object changes so they persist on the server.
• object.destroy - removes the object from the server.

Here are some worked examples:

Datacentred::User.all
# => [#<Datacentred::Model::User id="2bd21ee25cde40fdb9454954e4fbb4b5", ...>, ...]

user = Datacentred::User.find "2bd21ee25cde40fdb9454954e4fbb4b5"
# => #<Datacentred::Model::User id="2bd21ee25cde40fdb9454954e4fbb4b5", ...>

project      = Datacentred::Project.find "6d5277716c4b10d2177814af50b77175"
project.name = "Foo"
project.save
# => #<Datacentred::Model::Project id="6d5277716c4b10d2177814af50b77175", name= "Foo", ...>

Acceptable permissions are: 'api.read', 'cloud.read', 'roles.modify', 'roles.read', 'storage.read', 'tickets.modify', 'usage.read'.

role = Datacentred::Role.create name: "foo", permissions: ["usage.read"]
# => #<Datacentred::Model::Role id="654f423e-646a-4742-849d-d8c9ab9b4f39", name="foo", admin=false, permissions=["usage.read"] ...>

role = Dataentred::Role.find  "654f423e-646a-4742-849d-d8c9ab9b4f39"
user = Datacentred::User.find "2bd21ee25cde40fdb9454954e4fbb4b5"
role.add_user user
# => true

user    = Datacentred::User.find    "2bd21ee25cde40fdb9454954e4fbb4b5"
project = Datacentred::Project.find "6d5277716c4b10d2177814af50b77175"
project.remove_user user
# => true

Usage data is returned simply by supplying a year and a month. If the year/month are current then the data will be as recent as the time contained within the last_updated_at property.

@usage = Datacentred::Usage.find 2017, 6
# => #<Datacentred::Model::Usage last_updated_at=2017-07-12 09:46:54 UTC, projects=[{:id=>"37033518a4514f12adeb8346ac3f188c"
@usage.projects.first.name
# => "wyld_stallyns"
@usage.projects.first.usage.instances.first.current_flavor.name
=> "dc1.1x1"

The gem may raise the following standard errors:

• Unauthorized - Your credentials are incorrect or your account isn't authorized for API access.
• NotFound - The entity you referred to can't be found with the ID you supplied.
• UnprocessableEntity - There was a validation issue with your request (only applies to create/delete/update operations)

Full documentation is also available via https://datacentred.github.io/datacentred-api-ruby/

Please check out the DataCentred API Documentation for a comprehensive description of the API itself.