Now proudly sponsored by DigitalOcean.
A Test Kitchen Driver for DigitalOcean.
From this version forward the driver uses API V2 only. Use of image_id, flavor_id, and region_id have been replaced with image, size, and region. You can now use slugs instead of relying on the old data.json to translate IDs. Please refer to the examples below, and the API documentation for more information.
There are no external system requirements for this driver. However you will need access to an DigitalOcean account.
Installation and Setup
You'll need to install the gem on your development machine.
gem install kitchen-digitalocean
or add it to your Gemfile if you are using Bundler
source 'https://rubygems.org' gem 'test-kitchen' gem 'kitchen-digitalocean'
At minimum, you'll need to tell test-kitchen to use the digitalocean driver.
--- driver: name: digitalocean platforms: - name: ubuntu-17
You also have the option of providing your credentials from environment variables.
export DIGITALOCEAN_ACCESS_TOKEN="1234" export DIGITALOCEAN_SSH_KEY_IDS="1234, 5678"
Note that your
SSH_KEY_ID must be the numeric id of your ssh key, not the symbolic name. To get the numeric ID
of your keys, use something like to following command to get them from the digital ocean API:
curl -X GET https://api.digitalocean.com/v2/account/keys -H "Authorization: Bearer $DIGITALOCEAN_ACCESS_TOKEN"
Please refer to the Getting Started Guide for any further documentation.
The driver now uses api v2 which provides slugs for image names, sizes, and regions.
--- platforms: - name: debian-7-0-x64 driver_config: region: ams1 - name: centos-6-4-x64 driver_config: size: 2gb # ...
Private networking is enabled by default, but will only work in certain regions. You can disable private networking by changing private_networking to false. Example below.
--- driver: - private_networking: false
IPv6 is disabled by default, you can enable this if needed. IPv6 is only available in limited regions.
--- driver: - ipv6: true
Image abbrevations we use
This is a list of abbreviate image names we provide
centos-6 centos-7 centos-8 coreos-stable oreos-beta coreos-alpha debian-9 debian-10 fedora-30 fedora-31 fedora-32 freebsd-11 freebsd-12 ubuntu-16 ubuntu-17 ubuntu-18 ubuntu-20
nyc1 New York 1 sfo1 San Francisco 1 ams2 Amsterdam 2 sgp1 Singapore 1 lon1 London 1 nyc3 New York 3 ams3 Amsterdam 3 fra1 Frankfurt 1 tor1 Toronto 1 sfo2 San Francisco 2 blr1 Bangalore 1
By default your droplets will be built in
nyc1 but you can change the default by updating the
environment variable. This should allow teams with developers across different regions to test within
their own geographic region without hard coding configs.
This allows futher customization by allowing overrides at the
driver level and the
# DIGITALOCEAN_REGION="tor1" # set as an env var # cookbook1/.kitchen.yml --- driver: name: digitalocean region: sgp1 platforms: - name: ubuntu-16 - name: ubuntu-18 region: sfo1 # cookbook2/.kitchen.yml --- driver: name: digitalocean platforms: - name: ubuntu-16 - name: ubuntu-18 region: sfo1
The above configuration when full tested would create the following images in their respective regions.
To add tags to the droplet, provide the tags attribute.
driver: tags: - test-kitchen - this-is-a-tag
DigitalOcean provides a monitoring agent that you can optionally install to your droplet. To enable this feature, set the monitoring attribute to true.
--- driver: - monitoring: true
To create the droplet with firewalls, provide a pre-existing firewall ID as a string or list of strings.
driver: firewalls: - 7a489167-a3d5-4d93-9f4a-371bd02ea8a3 - 624c1408-f101-4b59-af64-99c7f7560f7a
driver: firewalls: 624c1408-f101-4b59-af64-99c7f7560f7a
Note that your
firewalls must be the numeric ids of your firewall. To get the
numeric ID, use something like to following command to get them from the digital
curl -X GET https://api.digitalocean.com/v2/firewalls -H "Authorization: Bearer $DIGITALOCEAN_ACCESS_TOKEN"
To create the droplet with a VPC (Virtual Private Cloud), provide a pre-existing VPC ID as a string.
driver: vpcs: - 3a92ae2d-f1b7-4589-81b8-8ef144374453
Note that your
vpc_uuid must be the numeric ids of your vpc. To get the
numeric ID, use something like the following command to get them from the digital
curl -X GET https://api.digitalocean.com/v2/vpcs -H "Authorization: Bearer $DIGITALOCEAN_ACCESS_TOKEN"
Pull requests are very welcome! Make sure your patches are well tested. Ideally create a topic branch for every separate change you make. For example:
- Fork the repo
- Create your feature branch (
git checkout -b my-new-feature)
- Commit your changes (
git commit -am 'Added some feature')
- Push to the branch (
git push origin my-new-feature)
- Create new Pull Request
Will Farrington, His fork was a help during the creation of my api v2 driver.
Apache 2.0 (see LICENSE)