website: update required options for DO
This commit is contained in:
parent
5da56d2aa6
commit
910b16104e
|
@ -5,6 +5,7 @@ BACKWARDS INCOMPATIBILITIES:
|
|||
* The DigitalOcean builder no longer supports the v1 API which has been
|
||||
deprecated for some time. Most configurations should continue to
|
||||
work as long as you use the `api_token` field for auth.
|
||||
* builder/digitalocean: `image`, `region`, and `size` are now required.
|
||||
|
||||
FEATURES:
|
||||
|
||||
|
|
|
@ -29,28 +29,25 @@ each category, the available configuration keys are alphabetized.
|
|||
* `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.
|
||||
|
||||
* `image` (string) - The name (or slug) of the base image to use. This is the
|
||||
image that will be used to launch a new droplet and provision it.
|
||||
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.
|
||||
|
||||
* `region` (string) - The name (or slug) of the region to launch the droplet in.
|
||||
Consequently, this is the region where the snapshot will be available.
|
||||
See https://developers.digitalocean.com/documentation/v2/#list-all-regions for the accepted region names/slugs.
|
||||
|
||||
* `size` (string) - The name (or slug) of the droplet size to use.
|
||||
See https://developers.digitalocean.com/documentation/v2/#list-all-sizes for the accepted size names/slugs.
|
||||
|
||||
### Optional:
|
||||
|
||||
* `droplet_name` (string) - The name assigned to the droplet. DigitalOcean
|
||||
sets the hostname of the machine to this value.
|
||||
|
||||
* `image` (string) - The name (or slug) of the base image to use. This is the
|
||||
image that will be used to launch a new droplet and provision it. This
|
||||
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.
|
||||
|
||||
* `private_networking` (boolean) - Set to `true` to enable private networking
|
||||
for the droplet being created. This defaults to `false`, or not enabled.
|
||||
|
||||
* `region` (string) - The name (or slug) of the region to launch the droplet in.
|
||||
Consequently, this is the region where the snapshot will be available.
|
||||
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.
|
||||
|
||||
* `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.
|
||||
|
||||
* `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
|
||||
|
@ -78,6 +75,9 @@ own access tokens:
|
|||
```javascript
|
||||
{
|
||||
"type": "digitalocean",
|
||||
"api_token": "YOUR API KEY"
|
||||
"api_token": "YOUR API KEY",
|
||||
"image": "ubuntu-12-04-x64",
|
||||
"region": "nyc2",
|
||||
"size": "512mb"
|
||||
}
|
||||
```
|
||||
|
|
Loading…
Reference in New Issue