Knife::DigitalOcean

A knife plugin to deal with the DigitalOcean.com Cloud services.

This is a plugin for Chef's knife tool. It allows you to bootstrap virtual machines with DigitalOcean.com including the initial bootstrapping of chef on that system. You can also use knife-solo or knife-zero for chef bootstrapping or skip it altogether for another solution.

This knife plugin uses the droplet_kit rubygem.

Knife::DigitalOcean supports Chef 12, legacy support for older Chefs will be removed with 3.x.x by the end of 2015.

Installation

when using ChefDK

➜ chef gem install knife-digital_ocean

in typical Ruby setup

➜ gem install knife-digital_ocean

Overview

This plugin provides the following sub-commands:

knife digital_ocean droplet create (options)
Creates a virtual machine with or without bootstrapping chef
knife digital_ocean droplet destroy (options)
Destroys the virtual machine and its data
knife digital_ocean droplet list (options)
Lists currently running virtual machines
knife digital_ocean droplet power (options) Turn a droplet On/Off
knife digital_ocean droplet powercycle (options)
Powercycle a Droplet
knife digital_ocean droplet reboot (options)
Reboot a Droplet
knife digital_ocean droplet shutdown (options) Shutdown a droplet
knife digital_ocean droplet snapshot (options)
Take a snapshot of a Droplet
knife digital_ocean droplet rename (options)
Rename a Droplet
knife digital_ocean droplet rebuild (options)
Rebuild a Droplet
knife digital_ocean droplet resize (options)
Resize a Droplet
knife digital_ocean image destroy (options)
Destroy your private images
knife digital_ocean image list (options)
Lists available images (snapshots, backups, OS-images)
knife digital_ocean image transfer (options)
Transfer a image to another region
knife digital_ocean region list (options)
Lists the server regions/locations/data-center
knife digital_ocean size list (options)
Lists the available server sizes
knife digital_ocean domain create (options)
Creates a domain name
knife digital_ocean domain destroy (options)
Destroys a domain name
knife digital_ocean domain list (options)
Lists your domains added to Digital Ocean
knife digital_ocean domain record create (options)
Creates a record for an existing domain
knife digital_ocean domain record destroy (options)
Destroys a record for an existing domain
knife digital_ocean domain record list (options)
Lists records for an existing domain
knife digital_ocean sshkey create (options)
Creates a ssh key for use on digital ocean
knife digital_ocean sshkey destroy (options)
Destroys the ssh key
knife digital_ocean sshkey list (options)
Lists name + id of the uploaded known ssh keys
knife digital_ocean account info (options)
Shows account information

Configuration

The best way is to put your API-credentials of DigitalOcean in your knife.rb file of choice (e.g. in ~/.chef/knife.rb):

knife[:digital_ocean_access_token]   = 'YYYYYYYYYYYYYYYYYYYYYYYYYYYYYYYYYYY'

Usage

Create a Droplet

There are three different ways of creating a server/droplet instance:

If you just want to launch an instance form the command line without any bootstrapping, go for option D. If you use knife-zero try C, if you use knife-solo try B and if you are a chef-server-fan use method A:

A. With bootstrapping in an chef-server environment:

Examples

➜ knife digital_ocean droplet create --server-name awesome-vm1.vm.io \
                                      --image debian-7-0-x64 \
                                      --location nyc3 \
                                      --size 1gb \
                                      --ssh-keys 1234,1235 \
                                      --ssh-port 22

➜ knife digital_ocean droplet create --server-name awesome-vm2.vm.io \
                                      --image debian-7.0-x64 \
                                      --location sfo1 \
                                      --size 512mb \
                                      --ssh-keys 1234,1235 \
                                      --bootstrap \
                                      --bootstrap-version 11.16.4-1
                                      --run-list "role[base],role[webserver]" \
                                      --secret-file "/home/user/.ssh/secret_file" \
                                      --ssh-port 22 \
                                      --identity-file "~/.ssh/id_rsa" \
                                      --private_networking

Syntax

➜ knife digital_ocean droplet create --server-name <FQDN> \
                                      --image <IMAGE SLUG> \
                                      --location <REGION SLUG> \
                                      --size <SIZE SLUG> \
                                      --ssh-keys <SSH KEY-ID(s), comma-separated> \
                                      --ssh-port <SSH PORT> \
                                      --bootstrap \
                                      --bootstrap-version <VERSION NUMBER>
                                      --run-list "<RUNLIST>" \
                                      --secret-file "<FILENAME>" \
                                      --private_networking
                                      --ipv6-enabled

Short Syntax

➜ knife digital_ocean droplet create -N <FQDN> \
                                      -I <IMAGE SLUG> \
                                      -L <REGION SLUG> \
                                      -S <SIZE SLUG> \
                                      -K <SSH KEY-ID(s), comma-separated> \
                                      -p <SSH PORT> \
                                      -B \
                                      -r "<RUNLIST>"
                                      -6

B. With knife-solo bootstrapping

You need to have knife-solo gem installed.

This will create a droplet and run knife solo bootstrap <IP> equivalent for it. Please consult the knife-solo documentation for further details.

Example

➜ knife digital_ocean droplet create --server-name awesome-vm1.vm.io \
                                      --image debian-7-0-x64 \
                                      --location lon1 \
                                      --size 2gb \
                                      --ssh-keys 1234,4567 \
                                      --run-list "<RUNLIST>" \
                                      --solo

C. With knife-zero bootstrapping

You need to have knife-zero gem installed.

This will create a droplet and run knife zero bootstrap <IP> equivalent for it. Please consult the knife-zero documentation for further details.

Example

➜ knife digital_ocean droplet create --server-name awesome-vm1.vm.io \
                                      --image debian-7-0-x64 \
                                      --location lon1 \
                                      --size 2gb \
                                      --ssh-keys 1234,4567 \
                                      --run-list "<RUNLIST>" \
                                      --zero

D. With your custom external bootstrapping script or without chef at all

This will just create a droplet and return its IP-address. Nothing else. You can now run your custom solution to provision the droplet.

Example

➜ knife digital_ocean droplet create --server-name awesome-vm1.vm.io \
                                      --image debian-7-0-x64 \
                                      --location lon1 \
                                      --size 2gb \
                                      --ssh-keys 1234,4567

List running droplets (servers)

➜ knife digital_ocean droplet list
ID     Name                  Size   Region       IPv4            Image                            Status
12345  app20.ams.nl.vm.io  1gb    Amsterdam 1  185.14.123.123  25306 (Ubuntu 12.10 x32 Server)  active
23456  awesome-vm1.vm.io   512mb  Amsterdam 1  185.14.124.125  25306 (Ubuntu 12.10 x32 Server)  active

!WARNING! Destroy a droplet (server) including all of its data!

Destroy droplet by id

➜ knife digital_ocean droplet destroy -S 23456
OK

Destroy all droplets

➜ knife digital_ocean droplet destroy --all
Delete droplet with id: 1824315
Delete droplet with id: 1824316
Delete droplet with id: 1824317

Reboot A Droplet

➜ knife digital_ocean droplet reboot -I 1824315
OK

Turn Power On/Off

➜ knife digital_ocean power -I 1824315 -a on
OK

➜ knife digital_ocean power -I 1824315 -a off
OK

Powercycle A Droplet

➜ knife digital_ocean powercycle -I 1824315
OK

Rebuild A Droplet

➜ knife digital_ocean rebuild --droplet-id 1824315 --image-id 65420
OK

Rename A Droplet

➜ knife digital_ocean rename -I 1824315 -N 'mydropletrocks.com'
OK

Resize A Droplet

➜ knife digital_ocean rename -I 1824315 -s 1gb
OK

Shutdown a droplet

➜ knife digital_ocean shutdown -I 1824315
OK

Create a droplet from a Snapshot

➜ knife digital_ocean snapshot -I 1824315 -N 'my-super-awesome-snapshot'
OK

List regions

➜ knife digital_ocean region list
Name             Slug
Amsterdam 1      ams1
Amsterdam 2      ams2
Amsterdam 3      ams3
Frankfurt 1      fra1
London 1         lon1
New York 1       nyc1
New York 2       nyc2
New York 3       nyc3
San Francisco 1  sfo1
Singapore 1      sgp1

List sizes (instance types)

➜ knife digital_ocean size list
Slug
512mb
1gb
2gb
4gb
8gb
16gb
32gb
48gb
64gb

List images

Custom images (snapshots, backups) (default)

➜ knife digital_ocean image list
ID     Distribution  Name
11111  Ubuntu        app100.ams.nlxxxxx.net 2013-02-01
11112  Ubuntu        app100.ams.nlxxxxx.net 2013-02-03
11113  Ubuntu        init

Public images (OS)

➜ knife digital_ocean image list --public
ID        Distribution  Name                                      Slug       
10322623  CentOS        7 x64                                     centos-7-0-x64  
6372425   CentOS        5.10 x32                                  centos-5-8-x32  
6372321   CentOS        5.10 x64                                  centos-5-8-x64  
10325992  CentOS        6.5 x32                                   centos-6-5-x32  
10325922  CentOS        6.5 x64                                   centos-6-5-x64  
10679356  CoreOS        557.2.0 (stable)                          coreos-stable   
10679369  CoreOS        593.0.0 (alpha)                           coreos-alpha    
10692842  CoreOS        584.0.0 (beta)                            coreos-beta     
10322059  Debian        7.0 x64                                   debian-7-0-x64  
6372581   Debian        6.0 x64                                   debian-6-0-x64  
6372662   Debian        6.0 x32                                   debian-6-0-x32  
10322378  Debian        7.0 x32                                   debian-7-0-x32  
9640922   Fedora        21 x64                                    fedora-21-x64   
6370969   Fedora        19 x32                                    fedora-19-x32   
6370882   Fedora        20 x64                                    fedora-20-x64   
6370968   Fedora        19 x64                                    fedora-19-x64   
6370885   Fedora        20 x32                                    fedora-20-x32   
10163059  FreeBSD       FreeBSD AMP on 10.1                       freebsd-amp     
10144573  FreeBSD       10.1                                      freebsd-10-1-x64
6732690   Ubuntu        LEMP on 14.04                             lemp            
10321870  Ubuntu        10.04 x32                                 ubuntu-10-04-x32
10321777  Ubuntu        12.04.5 x32                               ubuntu-12-04-x32
10321756  Ubuntu        12.04.5 x64                               ubuntu-12-04-x64
9801948   Ubuntu        14.04 x32                                 ubuntu-14-04-x32
9801954   Ubuntu        14.10 x64                                 ubuntu-14-10-x64
9801951   Ubuntu        14.10 x32                                 ubuntu-14-10-x32
6376601   Ubuntu        Ruby on Rails on 14.04 (Nginx + Unicorn)  ruby-on-rails   
6423475   Ubuntu        WordPress on 14.04                        wordpress       
10321819  Ubuntu        10.04 x64                                 ubuntu-10-04-x64
6732691   Ubuntu        LAMP on 14.04                             lamp            
6798184   Ubuntu        MEAN on 14.04                             mean            
8375425   Ubuntu        Drupal 7.34 on 14.04                      drupal          
8412876   Ubuntu        Magento 1.9.1.0 on 14.04                  magento         
8953301   Ubuntu        ELK Logging Stack on 14.04                elk             
9918633   Ubuntu        Ghost 0.5.8 on 14.04                      ghost           
9967718   Ubuntu        Django on 14.04                           django          
9801950   Ubuntu        14.04 x64                                 ubuntu-14-04-x64
10274087  Ubuntu        GitLab 7.7.1 CE on 14.04                  gitlab          
10321359  Ubuntu        MediaWiki 1.24.0 on 14.04                 mediawiki       
10462503  Ubuntu        Drone on 14.04                            drone           
10507592  Ubuntu        node-v0.12.0 on 14.04                     node            
10563620  Ubuntu        Dokku v0.3.14 on 14.04                    dokku           
10565666  Ubuntu        ownCloud 8.0 on 14.04                     owncloud        
10581649  Ubuntu        Docker 1.5.0 on 14.04                     docker          
7572830   Ubuntu        Redmine on 14.04                          redmine

Destroy Private Images

➜ knife digital_ocean image destroy -I 11112
OK

Transfer Private Images to Another Region

➜ knife digital_ocean image destroy -I 11112 -R ams1

SSH keys

List SSH keys

➜ knife digital_ocean sshkey list
ID    Name    Fingerprint
1234  Alice   e0:1a:1b:30:7f:bd:b2:cf:f2:4f:3b:35:3c:87:46:1c
1235  Bob     b0:ca:40:36:7f:bd:b2:cf:f2:4f:2b:45:3c:28:41:5f
1236  Chuck   g0:da:3e:15:7f:bd:b2:cf:f2:4f:3a:26:3c:34:52:2b
1237  Craig   f0:fa:2b:22:7f:bd:b2:cf:f2:4f:4c:18:3c:66:54:1c

Create a SSH key

➜ knife digital_ocean sshkey create -i ~/.ssh/id_rsa.pub -n Bob

Destroy a SSH key

➜ knife digital_ocean sshkey destroy -i 1236
OK

DNS

Create a domain

➜ knife digital_ocean domain create -N example.com -I 192.168.1.1

Destroy a domain

➜ knife digital_ocean domain destroy -D example.com
OK

List domains

➜ knife digital_ocean domain list
Name         TTL
example.com  1800

Create a domain record

➜ knife digital_ocean domain record create -D example.com -T CNAME -N www -a @

Destroy a domain record

➜ knife digital_ocean domain record destroy -D example.com -R 3355880
OK

List domain records

➜ knife digital_ocean domain record list -D example.com
ID       Type  Name  Data
3355877  NS    @     ns1.digitalocean.com
3355878  NS    @     ns2.digitalocean.com
3355879  NS    @     ns3.digitalocean.com
3355880  A     @     192.168.1.1

Account Info

➜ knife digital_ocean account info
UUID                                      Email           Droplet Limit  Email Verified
58e2e737d3b7407b042aa7f99f4da4229166f2a1  joe@example.com 10             true

Contributing

Fork it
Create your feature branch (git checkout -b my-new-feature)
Commit your changes (git commit -am 'Add some feature')
Push to the branch (git push origin my-new-feature)
Create new Pull Request

Tests

To run tests, please declare the DIGITALOCEAN_ACCESS_TOKEN environment variable, e.g.:

export DIGITALOCEAN_ACCESS_TOKEN="fake_access_token"
rspec

RuboCop / Ruby Style Guide

We want to make sure that our code complies with the Ruby Style Guide:

see:

Contributors

For more information and a complete list see the contributor page on GitHub.

License

Apache 2.0 (like Chef itself), see LICENSE.txt file.

Name		Name	Last commit message	Last commit date
Latest commit History 254 Commits
lib		lib
spec		spec
.coveralls.yml		.coveralls.yml
.gitignore		.gitignore
.rspec		.rspec
.rubocop.yml		.rubocop.yml
.travis.yml		.travis.yml
CHANGELOG.md		CHANGELOG.md
Gemfile		Gemfile
Guardfile		Guardfile
LICENSE.txt		LICENSE.txt
README.md		README.md
Rakefile		Rakefile
knife-digital_ocean.gemspec		knife-digital_ocean.gemspec

License

codeart/knife-digital_ocean

Folders and files

Latest commit

History

Repository files navigation

Knife::DigitalOcean

A knife plugin to deal with the DigitalOcean.com Cloud services.

Installation

when using ChefDK

in typical Ruby setup

Overview

Configuration

Usage

Create a Droplet

A. With bootstrapping in an chef-server environment:

B. With knife-solo bootstrapping

C. With knife-zero bootstrapping

D. With your custom external bootstrapping script or without chef at all

List running droplets (servers)

!WARNING! Destroy a droplet (server) including all of its data!

Destroy droplet by id

Destroy all droplets

Reboot A Droplet

Turn Power On/Off

Powercycle A Droplet

Rebuild A Droplet

Rename A Droplet

Resize A Droplet

Shutdown a droplet

Create a droplet from a Snapshot

List regions

List sizes (instance types)

List images

Custom images (snapshots, backups) (default)

Public images (OS)

Destroy Private Images

Transfer Private Images to Another Region

SSH keys

List SSH keys

Create a SSH key

Destroy a SSH key

DNS

Create a domain

Destroy a domain

List domains

Create a domain record

Destroy a domain record

List domain records

Account Info

Contributing

Tests

RuboCop / Ruby Style Guide

Contributors

License

Copyright

About

Resources

License

Stars

Watchers

Forks

Releases

Packages 0

Languages

Packages