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 for chef bootstrapping or skip it altogether for another solution.
This knife plugin uses the digital_ocean rubygem.
➜ gem install knife-digital_oceanThis 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 image list (options) Lists available images (snapshots, backups, OS-images)
-
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 sshkey list Lists name + id of the uploaded known ssh keys
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_client_id] = 'XXXXXXXXXXXX'
knife[:digital_ocean_api_key] = 'YYYYYYYYYYYYYYYYYYYYYYYYYYYYYYYYYYY'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 C.
If you use knife-solo try B and if you are a chef-server-fan
use method A:
Examples
➜ knife digital_ocean droplet create --server-name awesome-vm1.chef.io \
--image 25306 \
--location 2 \
--size 66 \
--ssh-keys 1234,1235 \
--ssh-port 22➜ knife digital_ocean droplet create --server-name awesome-vm2.chef.io \
--image 25306 \
--location 4 \
--size 66 \
--ssh-keys 1234,1235 \
--bootstrap \
--run-list "role[base],role[webserver]" \
--secret-file "~/.ssh/secret_file" \
--ssh-port 22 \
--identity-file "~/.ssh/id_rsa" \
--private_networkingSyntax
➜ knife digital_ocean droplet create --server-name <FQDN> \
--image <IMAGE ID> \
--location <REGION ID> \
--size <SIZE ID> \
--ssh-keys <SSH KEY-ID(s), comma-separated> \
--ssh-port <SSH PORT> \
--bootstrap \
--run-list "<RUNLIST>" \
--secret-file "<FILENAME>" \
--private_networkingShort Syntax
➜ knife digital_ocean droplet create -N <FQDN> \
-I <IMAGE ID> \
-L <REGION ID> \
-S <SIZE ID> \
-K <SSH KEY-ID(s), comma-separated> \
-p <SSH PORT> \
-B \
-r "<RUNLIST>"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.chef.io \
--image 25306 \
--location 2 \
--size 66 \
--ssh-keys 1234,4567 \
--run-list "<RUNLIST>" \
--soloThis 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.chef.io \
--image 25306 \
--location 2 \
--size 66 \
--ssh-keys 1234,4567➜ knife digital_ocean droplet list
ID Name Size Region IPv4 Image Status
12345 app20.ams.nl.chef.io 1GB Amsterdam 1 185.14.123.123 25306 (Ubuntu 12.10 x32 Server) active
23456 awesome-vm1.chef.io 512MB Amsterdam 1 185.14.124.125 25306 (Ubuntu 12.10 x32 Server) active➜ knife digital_ocean droplet destroy -S 23456
OK➜ knife digital_ocean region list
ID Name
1 New York 1
2 Amsterdam 1
3 San Francisco 1
4 New York 2
5 Amsterdam 2
6 Singapore 1➜ knife digital_ocean size list
ID Name
63 1GB
62 2GB
64 4GB
65 8GB
61 16GB
60 32GB
70 48GB
69 64GB
66 512MB➜ knife digital_ocean image list
ID Distribution Name Global
11111 Ubuntu app100.ams.nlxxxxx.net 2013-02-01 -
11112 Ubuntu app100.ams.nlxxxxx.net 2013-02-03 -
11113 Ubuntu init -➜ knife digital_ocean image list --global
ID Distribution Name Global
361740 Arch Linux Arch Linux 2013.05 x32 +
350424 Arch Linux Arch Linux 2013.05 x64 +
1602 CentOS CentOS 5.8 x32 +
1601 CentOS CentOS 5.8 x64 +
376568 CentOS CentOS 6.4 x32 +
562354 CentOS CentOS 6.4 x64 +
3240847 CentOS CentOS 6.5 x32 +
3240850 CentOS CentOS 6.5 x64 +
12575 Debian Debian 6.0 x32 +
12573 Debian Debian 6.0 x64 +
3102384 Debian Debian 7.0 x32 +
3102387 Debian Debian 7.0 x64 +
3102721 Fedora Fedora 19 x32 +
3102879 Fedora Fedora 19 x64 +
3243143 Fedora Fedora 20 x32 +
3243145 Fedora Fedora 20 x64 +
3104894 Ubuntu Docker 0.10 on Ubuntu 13.10 x64 +
3288841 Ubuntu Dokku v0.2.3 on Ubuntu 14.04 +
3121555 Ubuntu Ghost 0.4.2 on Ubuntu 12.04 +
3118238 Ubuntu GitLab 6.6.5 CE +
3120115 Ubuntu LAMP on Ubuntu 12.04 +
3118235 Ubuntu MEAN on Ubuntu 12.04.4 +
3137903 Ubuntu Redmine on Ubuntu 12.04 +
3137635 Ubuntu Ruby on Rails on Ubuntu 12.10 (Nginx + Unicorn) +
14098 Ubuntu Ubuntu 10.04 x32 +
14097 Ubuntu Ubuntu 10.04 x64 +
3100616 Ubuntu Ubuntu 12.04.4 x32 +
3101045 Ubuntu Ubuntu 12.04.4 x64 +
3101888 Ubuntu Ubuntu 12.10 x32 +
3101891 Ubuntu Ubuntu 12.10 x64 +
3104282 Ubuntu Ubuntu 12.10 x64 Desktop +
3101580 Ubuntu Ubuntu 13.10 x32 +
3101918 Ubuntu Ubuntu 13.10 x64 +
3240033 Ubuntu Ubuntu 14.04 x32 +
3240036 Ubuntu Ubuntu 14.04 x64 +
3135725 Ubuntu Wordpress on Ubuntu 13.10 +➜ knife digital_ocean sshkey list
ID Name
1234 Alice
1235 Bob
1236 Chuck
1237 CraigCommercial support is available. Please contact https://roland.io/ or http://moriz.com/
- 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
For more information and a complete list see the contributor page on GitHub.
Apache 2.0 (like Chef itself), see LICENSE.txt file.
Ever wanted to control your DigitalOcean Droplets with your iPhone, iPad or iPod Touch?
Copyright © 2014 Roland Moriz, Moriz GmbH
