fog/fog-digitalocean

Name: fog-digitalocean

Owner: fog

Description: Fog for DigitalOcean Platform ? Edit

Created: 2016-03-30 15:21:23.0

Updated: 2018-05-23 05:43:24.0

Pushed: 2018-04-01 15:09:02.0

Homepage:

Size: 102

Language: Ruby

GitHub Committers

UserMost Recent Commit# Commits

Other Committers

UserEmailMost Recent Commit# Commits

README

Fog::DigitalOcean

Gem Version Build Status Dependency Status Coverage Status Code Climate Join the chat at https://gitter.im/fog/fog-digitalocean

This is the plugin Gem to talk to Digitalocean clouds via fog.

The main maintainers for the Digitalocean sections are @jjasghar and @h0lyalg0rithm. Please send CC them on pull requests.

Installation

Add this line to your application's Gemfile:

'fog-digitalocean'

And then execute:

$ bundle

Or install it yourself as:

$ gem install fog-digitalocean
Usage
Initial Setup

Getting started: the compute service

You'll need a DigitalOcean account and an API token to use this provider.

Get one from https://cloud.digitalocean.com/settings/tokens/new

Write down the Access Token.

Connecting, retrieving and managing server objects

Before we start, I guess it will be useful to the reader to know that Fog servers are 'droplets' in DigitalOcean's parlance. 'Server' is the Fog way to name VMs, and we have respected that in the DigitalOcean's Fog provider.

First, create a connection to the host:

ire 'fog'

an = Fog::Compute.new({
rovider => 'DigitalOcean',
igitalocean_token   => 'poiuweoruwoeiuroiwuer', # your Access Token here

SSH Key Management

Access to DigitalOcean servers can be managed with SSH keys. These can be assigned to servers at creation time so you can access them without having to use a password.

Creating a key:

an.ssh_keys.create(
ame        => 'Default SSH Key',
sh_pub_key => File.read('~/.ssh/id_rsa.pub'))

Listing all keys:

an.ssh_keys.each do | key |
ts key.name
ts key.public_key
ts key.id

Destroying a key:

an.ssh_keys.destroy(:id => '27100')
Listing servers

Listing servers and attributes:

an.servers.each do |server|
remember, servers are droplets
ts server.id
ts server.name
ts server.status
ts (server.image['slug'] || server.image['name']) # slug is only for public images, private images use name
ts server.size['slug']
ts server.region['slug']

Server creation and life-cycle management

Creating a new server (droplet):

er = docean.servers.create :name => 'foobar',
                           # use the last image listed
                           :image  => docean.images.last.id,
                           # use the first flavor (aka size) listed
                           :size => docean.flavors.first.slug,
                           # use the first region listed
                           :region => docean.regions.first.slug

The server is automatically started after that.

Development

After checking out the repo, run bin/setup to install dependencies. Then, run rake spec 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.

Contributing

Bug reports and pull requests are welcome on GitHub at https://github.com/[USERNAME]/fog-digitalocean. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the Contributor Covenant code of conduct.

License

The gem is available as open source under the terms of the MIT License.


This work is supported by the National Institutes of Health's National Center for Advancing Translational Sciences, Grant Number U24TR002306. This work is solely the responsibility of the creators and does not necessarily represent the official views of the National Institutes of Health.