64 lines
4.2 KiB
Markdown
64 lines
4.2 KiB
Markdown
---
|
|
description: DigitalOcean driver for machine
|
|
keywords: machine, digitalocean, driver
|
|
title: DigitalOcean
|
|
---
|
|
|
|
Create Docker machines on [DigitalOcean](https://www.digitalocean.com/).
|
|
|
|
You need to create a personal access token under "Apps & API" in the DigitalOcean
|
|
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 DigitalOcean API.
|
|
- `--digitalocean-backups`: Enable DigitalOcean backups for the droplet.
|
|
- `--digitalocean-image`: The name of the DigitalOcean image to use.
|
|
- `--digitalocean-ipv6`: Enable IPv6 support for the droplet.
|
|
- `--digitalocean-monitoring`: Enable monitoring 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](https://developers.digitalocean.com/documentation/v2/#regions) for how to get a list.
|
|
- `--digitalocean-size`: The size of the DigitalOcean 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](https://developers.digitalocean.com/documentation/v2/#ssh-keys).
|
|
- `--digitalocean-ssh-key-path`: SSH private key path.
|
|
- `--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](https://developers.digitalocean.com/documentation/v2/#tags)
|
|
- `--digitalocean-userdata`: Path to file containing User Data for the droplet.
|
|
|
|
The DigitalOcean driver uses `ubuntu-16-04-x64` as the default image.
|
|
|
|
#### Environment variables and default values
|
|
|
|
| CLI option | Environment variable | Default |
|
|
| ----------------------------------- | --------------------------------- | ------------------ |
|
|
| **`--digitalocean-access-token`** | `DIGITALOCEAN_ACCESS_TOKEN` | - |
|
|
| `--digitalocean-backups` | `DIGITALOCEAN_BACKUPS` | `false` |
|
|
| `--digitalocean-image` | `DIGITALOCEAN_IMAGE` | `ubuntu-16-04-x64` |
|
|
| `--digitalocean-ipv6` | `DIGITALOCEAN_IPV6` | `false` |
|
|
| `--digitalocean-private-networking` | `DIGITALOCEAN_PRIVATE_NETWORKING` | `false` |
|
|
| `--digitalocean-region` | `DIGITALOCEAN_REGION` | `nyc3` |
|
|
| `--digitalocean-size` | `DIGITALOCEAN_SIZE` | `s-1vcpu-1gb` |
|
|
| `--digitalocean-ssh-key-fingerprint`| `DIGITALOCEAN_SSH_KEY_FINGERPRINT`| - |
|
|
| `--digitalocean-ssh-key-path` | `DIGITALOCEAN_SSH_KEY_PATH` | - |
|
|
| `--digitalocean-ssh-port` | `DIGITALOCEAN_SSH_PORT` | 22 |
|
|
| `--digitalocean-ssh-user` | `DIGITALOCEAN_SSH_USER` | `root` |
|
|
| `--digitalocean-tags` | `DIGITALOCEAN_TAGS` | - |
|
|
| `--digitalocean-userdata` | `DIGITALOCEAN_USERDATA` | - |
|
|
| `--digitalocean-monitoring` | `$DIGITALOCEAN_MONITORING` | `false` |
|