Rancher::Api is a Ruby wrapper around Rancher API built with Her
Connect to Rancher and execute requests from your ruby scripts. It allows you to use some of the super nice features from Rancher:
- provision VMs from different cloud providers (behind the scenes Rancher uses docker-machine, so that means you can create VMs in DigitalOcean, AWS, Rackspace and many more, check list of supported drivers by Docker Machine)
- deploy your containers
- watch your containers
- scale your containers as you wish
Add this line to your application's Gemfile:
gem 'rancher-api'
And then execute:
$ bundle
Or install it yourself as:
$ gem install rancher-api
Tested with: Rancher v0.63.1
Configure Rancher::Api first by providing url, access and secret keys:
- Project Top level object that represents "Environment" in Rancher UI
- Service Service (combines containers from the same image)
- Machine Physical docker hosts
- Instance represents containers that were ever installed via Rancher. Better to query containers as nested resource, cuz there can be thousands of containers that were running before and still available to query via API. Removed containers are marked as 'removed' respectively
- Environment In Rancher UI these are known as Stack, though in API they are environments. We're sticking to API resource name
- Host These are hosts, with detailed information about docker installation and resources
require 'rancher/api'
Rancher::Api.configure do |config|
config.url = 'http://127.0.0.1:8080/v1/'
config.access_key = '8604A1FC8C108BAFB1E3'
config.secret_key = '4BhuyyyAaaaaBbbbi7yaZzzAaa3y13pC6D7e569'
end
You can configure rancher-api
gem using rancher-compose
-compatible environment variables:
- RANCHER_URL
- RANCHER_ACCESS_KEY
- RANCHER_SECRET_KEY
Rancher::Api.setup!
Now, you're able to query entities like this:
project = Rancher::Api::Project.all.to_a
machine = Rancher::Api::Machine.find('1ph1')
rancher/api
gem uses ORM Her which hence inherently supports all of the features that Her has to offer. To get more details, review this page https://github.com/remiprev/her#fetching-data
Some of the example queries include:
project = Rancher::Api::Project.all.to_a.first
project.machines
# exact machine name
project.machines.where(name: 'ciqa01')
# machine's name not equal to
project.machines.where(name_ne: 'qa')
# machine's name starts with
project.machines.where(name_prefix: 'qa')
# other attributes
# state not active
project.machines.where(state_ne: 'active')
# state activating
project.machines.where(state: 'activating')
Creating new machine using Digital Ocean driver:
NOTICE: First specify driver, so that driver_config= accessor can correctly map config on the right attribute. I.e. for 'digitalocean' config attribute is 'digitaloceanConfig'.
project = Rancher::Api::Project.all.to_a.first
new_machine = project.machines.build
new_machine.driver = Rancher::Api::Machine::DIGITAL_OCEAN
new_machine.driver_config = Rancher::Api::Machine::DriverConfig.new(
accessToken: 'xyz',
size: '1gb',
region: 'ams3',
image: 'ubuntu-14-04-x64'
)
new_machine.save
project = Rancher::Api::Project.all.to_a.first
new_machine = project.machines.build
new_machine.name = 'api-test'
new_machine.driver = Rancher::Api::Machine::VMWARE_VSPHERE
new_machine.driver_config = Rancher::Api::Machine::DriverConfig.new(
boot2dockerUrl: nil,
cpuCount: '1',
datacenter: 'ha-dc',
datastore: 'prod',
diskSize: '10000',
memorySize: '1024',
network: 'prod',
password: 'holamundo',
pool: nil,
username: 'myuser',
vcenter: 'vcenter.happyops.com',
vcenterPort: nil
)
new_machine.save
container = Rancher::Api::Instance.find('1i382')
puts container.execute('whoami').response
puts container.execute(['bundle', 'exec', 'rake', 'db:create', 'db:migrate']).response
To load environment with pry run pry -I lib -r rancher/api
After checking out the repo, run bin/setup
to install dependencies. Then, run rake rspec
to run the tests. You can also run bin/console
for an interactive prompt that will allow you to experiment.
To install this gem onto your local machine, run bundle exec rake install
. To release a new version, update the version number in version.rb
, and then run bundle exec rake release
, which will create a git tag for the version, push git commits and tags, and push the .gem
file to rubygems.org.
Bug reports and pull requests are welcome on GitHub at https://github.com/akurkin/rancher-api.
The gem is available as open source under the terms of the MIT License.