Digital Ocean

Estimated reading time: 2 minutes

Create Docker machines on Digital Ocean.

You need to create a personal access token under “Apps & API” in the Digital Ocean Control Panel and pass that to docker-machine create with the --digitalocean-access-token option.

Usage

$ docker-machine create --driver digitalocean --digitalocean-access-token=aa9399a2175a93b17b1c86c807e08d3fc4b79876545432a629602f61cf6ccd6b test-this

When explicitly passing environment variables

export DIGITALOCEAN_ACCESS_TOKEN="yourtoken"; export DIGITALOCEAN_SSH_KEY_FINGERPRINT="from your DO's profile security-ssh keys"; \ export DIGITALOCEAN_IMAGE="centos-7-x64"; export DIGITALOCEAN_REGION="tor1"
 
$ docker-machine create --driver digitalocean --digitalocean-access-token $DIGITALOCEAN_ACCESS_TOKEN --digitalocean-ssh-key-fingerprint $DIGITALOCEAN_SSH_KEY_FINGERPRINT --digitalocean-image $DIGITALOCEAN_IMAGE --digitalocean-region $DIGITALOCEAN_REGION

When passing a boolean value to any option

$ docker-machine create --driver digitalocean --digitalocean-access-token=aa9399a2175a93b17b1c86c807e08d3fc4b79876545432a629602f61cf6ccd6b --digitalocean-size 1gb --digitalocean-backups=true test-this

Options

  • --digitalocean-access-token: required. Your personal access token for the Digital Ocean API.
  • --digitalocean-backups: Enable Digital Ocean backups for the droplet.
  • --digitalocean-image: The name of the Digital Ocean image to use.
  • --digitalocean-ipv6: Enable IPv6 support for the droplet.
  • --digitalocean-private-networking: Enable private networking support for the droplet.
  • --digitalocean-region: The region to create the droplet in, see Regions API for how to get a list.
  • --digitalocean-size: The size of the Digital Ocean droplet (larger than default options are of the form 2gb).
  • --digitalocean-ssh-key-fingerprint: Use an existing SSH key instead of creating a new one, see SSH keys.
  • --digitalocean-ssh-port: SSH port.
  • --digitalocean-ssh-user: SSH username.
  • --digitalocean-tags: Comma-separated list of tags to apply to the Droplet, see Droplet tagging
  • --digitalocean-userdata: Path to file containing User Data for the droplet.

The DigitalOcean driver will use ubuntu-16-04-x64 as the default image.

Environment variables and default values

CLI optionEnvironment variableDefault
--digitalocean-access-tokenDIGITALOCEAN_ACCESS_TOKEN-
--digitalocean-backupsDIGITALOCEAN_BACKUPSfalse
--digitalocean-imageDIGITALOCEAN_IMAGEubuntu-16-04-x64
--digitalocean-ipv6DIGITALOCEAN_IPV6false
--digitalocean-private-networkingDIGITALOCEAN_PRIVATE_NETWORKINGfalse
--digitalocean-regionDIGITALOCEAN_REGIONnyc3
--digitalocean-sizeDIGITALOCEAN_SIZE512mb
--digitalocean-ssh-key-fingerprintDIGITALOCEAN_SSH_KEY_FINGERPRINT-
--digitalocean-ssh-portDIGITALOCEAN_SSH_PORT22
--digitalocean-ssh-userDIGITALOCEAN_SSH_USERroot
--digitalocean-tagsDIGITALOCEAN_TAGS-
--digitalocean-userdataDIGITALOCEAN_USERDATA-
machine, Digital Ocean, driver