alphabetical

This commit is contained in:
Alex Dadgar 2017-01-25 21:16:18 -08:00
parent 3e35f453e4
commit 7e5679c321
2 changed files with 15 additions and 15 deletions

View file

@ -51,15 +51,15 @@ before the starting the task.
default value is to place the binary in `local/`. The destination is treated default value is to place the binary in `local/`. The destination is treated
as a directory and source files will be downloaded into that directory path. as a directory and source files will be downloaded into that directory path.
- `source` `(string: <required>)` - Specifies the URL of the artifact to download.
Only `http`, `https`, and `s3` URLs are supported. See [`go-getter`][go-getter]
for details.
- `options` `(map<string|string>: nil)` - Specifies configuration parameters to - `options` `(map<string|string>: nil)` - Specifies configuration parameters to
fetch the artifact. The key-value pairs map directly to parameters appended to fetch the artifact. The key-value pairs map directly to parameters appended to
the supplied `source` URL. Please see the [`go-getter` the supplied `source` URL. Please see the [`go-getter`
documentation][go-getter] for a complete list of options and examples documentation][go-getter] for a complete list of options and examples
- `source` `(string: <required>)` - Specifies the URL of the artifact to download.
Only `http`, `https`, and `s3` URLs are supported. See [`go-getter`][go-getter]
for details.
## `artifact` Examples ## `artifact` Examples
The following examples only show the `artifact` stanzas. Remember that the The following examples only show the `artifact` stanzas. Remember that the

View file

@ -47,19 +47,17 @@ README][ct].
## `template` Parameters ## `template` Parameters
- `source` `(string: "")` - Specifies the path to the template to be rendered. - `change_signal` `(string: "")` - Specifies the signal to send to the task as a
One of `source` or `data` must be specified, but not both. This source can string like `"SIGUSR1"` or `"SIGINT"`. This option is required if the
optionally be fetched using an [`artifact`][artifact] resource. This template `change_mode` is `signal`.
must exist on the machine prior to starting the task; it is not possible to
reference a template inside of a Docker container, for example.
- `destination` `(string: <required>)` - Specifies the location where the
resulting template should be rendered, relative to the task directory.
- `data` `(string: "")` - Specifies the raw template to execute. One of `source` - `data` `(string: "")` - Specifies the raw template to execute. One of `source`
or `data` must be specified, but not both. This is useful for smaller or `data` must be specified, but not both. This is useful for smaller
templates, but we recommend using `source` for larger templates. templates, but we recommend using `source` for larger templates.
- `destination` `(string: <required>)` - Specifies the location where the
resulting template should be rendered, relative to the task directory.
- `change_mode` `(string: "restart")` - Specifies the behavior Nomad should take - `change_mode` `(string: "restart")` - Specifies the behavior Nomad should take
if the rendered template changes. The possible values are: if the rendered template changes. The possible values are:
@ -67,9 +65,11 @@ README][ct].
- `"restart"` - restart the task - `"restart"` - restart the task
- `"signal"` - send a configurable signal to the task - `"signal"` - send a configurable signal to the task
- `change_signal` `(string: "")` - Specifies the signal to send to the task as a - `source` `(string: "")` - Specifies the path to the template to be rendered.
string like `"SIGUSR1"` or `"SIGINT"`. This option is required if the One of `source` or `data` must be specified, but not both. This source can
`change_mode` is `signal`. optionally be fetched using an [`artifact`][artifact] resource. This template
must exist on the machine prior to starting the task; it is not possible to
reference a template inside of a Docker container, for example.
- `splay` `(string: "5s")` - Specifies a random amount of time to wait between - `splay` `(string: "5s")` - Specifies a random amount of time to wait between
0ms and the given splay value before invoking the change mode. This is 0ms and the given splay value before invoking the change mode. This is