|
|
|
|
@ -24,31 +24,13 @@ There are many configuration options available for the builder. They are
|
|
|
|
|
segmented below into two categories: required and optional parameters. Within
|
|
|
|
|
each category, the available configuration keys are alphabetized.
|
|
|
|
|
|
|
|
|
|
### Required v1 api:
|
|
|
|
|
### Required:
|
|
|
|
|
|
|
|
|
|
* `api_key` (string) - The API key to use to access your account. You can
|
|
|
|
|
retrieve this on the "API" page visible after logging into your account
|
|
|
|
|
on DigitalOcean.
|
|
|
|
|
If not specified, Packer will use the environment variable
|
|
|
|
|
`DIGITALOCEAN_API_KEY`, if set.
|
|
|
|
|
|
|
|
|
|
* `client_id` (string) - The client ID to use to access your account. You can
|
|
|
|
|
find this on the "API" page visible after logging into your account on
|
|
|
|
|
DigitalOcean.
|
|
|
|
|
If not specified, Packer will use the environment variable
|
|
|
|
|
`DIGITALOCEAN_CLIENT_ID`, if set.
|
|
|
|
|
|
|
|
|
|
### Required v2 api:
|
|
|
|
|
|
|
|
|
|
* `api_token` (string) - The client TOKEN to use to access your account. If it
|
|
|
|
|
specified, then use v2 api (current), if not then used old (v1) deprecated api.
|
|
|
|
|
Also it can be specified via environment variable `DIGITALOCEAN_API_TOKEN`, if set.
|
|
|
|
|
* `api_token` (string) - The client TOKEN to use to access your account.
|
|
|
|
|
It can also be specified via environment variable `DIGITALOCEAN_API_TOKEN`, if set.
|
|
|
|
|
|
|
|
|
|
### Optional:
|
|
|
|
|
|
|
|
|
|
* `api_url` (string) - API endpoint, by default use https://api.digitalocean.com
|
|
|
|
|
Also it can be specified via environment variable `DIGITALOCEAN_API_URL`, if set.
|
|
|
|
|
|
|
|
|
|
* `droplet_name` (string) - The name assigned to the droplet. DigitalOcean
|
|
|
|
|
sets the hostname of the machine to this value.
|
|
|
|
|
|
|
|
|
|
@ -57,10 +39,6 @@ each category, the available configuration keys are alphabetized.
|
|
|
|
|
defaults to 'ubuntu-12-04-x64' which is the slug for "Ubuntu 12.04.4 x64".
|
|
|
|
|
See https://developers.digitalocean.com/documentation/v2/#list-all-images for details on how to get a list of the the accepted image names/slugs.
|
|
|
|
|
|
|
|
|
|
* `image_id` (integer) - The ID of the base image to use. This is the image that
|
|
|
|
|
will be used to launch a new droplet and provision it.
|
|
|
|
|
This setting is deprecated. Use `image` instead.
|
|
|
|
|
|
|
|
|
|
* `private_networking` (boolean) - Set to `true` to enable private networking
|
|
|
|
|
for the droplet being created. This defaults to `false`, or not enabled.
|
|
|
|
|
|
|
|
|
|
@ -69,17 +47,10 @@ each category, the available configuration keys are alphabetized.
|
|
|
|
|
This defaults to "nyc3", which is the slug for "New York 3".
|
|
|
|
|
See https://developers.digitalocean.com/documentation/v2/#list-all-regions for the accepted region names/slugs.
|
|
|
|
|
|
|
|
|
|
* `region_id` (integer) - The ID of the region to launch the droplet in. Consequently,
|
|
|
|
|
this is the region where the snapshot will be available.
|
|
|
|
|
This setting is deprecated. Use `region` instead.
|
|
|
|
|
|
|
|
|
|
* `size` (string) - The name (or slug) of the droplet size to use.
|
|
|
|
|
This defaults to "512mb", which is the slug for "512MB".
|
|
|
|
|
See https://developers.digitalocean.com/documentation/v2/#list-all-sizes for the accepted size names/slugs.
|
|
|
|
|
|
|
|
|
|
* `size_id` (integer) - The ID of the droplet size to use.
|
|
|
|
|
This setting is deprecated. Use `size` instead.
|
|
|
|
|
|
|
|
|
|
* `snapshot_name` (string) - The name of the resulting snapshot that will
|
|
|
|
|
appear in your account. This must be unique.
|
|
|
|
|
To help make this unique, use a function like `timestamp` (see
|
|
|
|
|
@ -107,20 +78,6 @@ own access tokens:
|
|
|
|
|
```javascript
|
|
|
|
|
{
|
|
|
|
|
"type": "digitalocean",
|
|
|
|
|
"client_id": "YOUR CLIENT ID",
|
|
|
|
|
"api_key": "YOUR API KEY"
|
|
|
|
|
"api_token": "YOUR API KEY"
|
|
|
|
|
}
|
|
|
|
|
```
|
|
|
|
|
|
|
|
|
|
## Finding Image, Region, and Size IDs
|
|
|
|
|
|
|
|
|
|
Unfortunately, finding a list of available values for `image_id`, `region_id`,
|
|
|
|
|
and `size_id` is not easy at the moment. Basically, it has to be done through
|
|
|
|
|
the [DigitalOcean API](https://www.digitalocean.com/api_access) using the
|
|
|
|
|
`/images`, `/regions`, and `/sizes` endpoints. You can use `curl` for this
|
|
|
|
|
or request it in your browser.
|
|
|
|
|
|
|
|
|
|
If you're comfortable installing RubyGems, [Tugboat](https://github.com/pearkes/tugboat)
|
|
|
|
|
is a fantastic DigitalOcean command-line client that has commands to
|
|
|
|
|
find the available images, regions, and sizes. For example, to see all the
|
|
|
|
|
global images, you can run `tugboat images --global`.
|
|
|
|
|
|