kemko/nomad
1
0
Fork 0
mirror of https://github.com/kemko/nomad.git synced 2026-01-08 11:25:41 +03:00
Code Issues Packages Projects Releases Wiki Activity

Add template to JSON objects documentation

Browse Source 
Closes #2237
This commit is contained in:
Igor Yamolov
2017-01-24 16:46:17 +03:00
parent 1176e4ae97
commit bf7f839fc0
1 changed files with 45 additions and 0 deletions
Download Patch File Download Diff File Expand all files Collapse all files

45
website/source/docs/http/json-jobs.html.md
View File

@@ -119,6 +119,15 @@ Below is an example of a JSON object that submits a `periodic` job to Nomad:
"MaxFiles":10,
"MaxFileSizeMB":10
},
"Templates":[
{
"SourcePath": "local/config.conf.tpl",
"DestPath": "local/config.conf",
"ChangeMode": "signal",
"ChangeSignal": "SIGUSR1",
"Splay": 5000000000
}
],
"Artifacts":[
{
"GetterSource":"http://foo.com/artifact.tar.gz",
@@ -377,6 +386,7 @@ The `Task` object supports the following keys:
* `Args`: Additional arguments to the `command` for script based health
checks.
* `Templates` - Array of `Template` objects which describe renderable templates.
* `User` - Set the user that will run the task. It defaults to the same user
the Nomad client is being run as. This can only be set on Linux platforms.
@@ -590,3 +600,38 @@ Virtual hosted based style
]
}
```
### Template
Nomad allows runtime template rendering, that could be used for populating configs using Nomad Consul KV data, Nomad runtime variables or Vault data.
Consul-Template is utilized for template rendering.
`Template` object supports following attributes:
* `SourcePath` - Specifies the path to the template to be rendered. Mutally exclusive with `EmbeddedTmpl` attribute.
* `EmbeddedTmpl` - Specifies the raw template to execute. Mutally exclusive with `SourcePath` attribute.
* `DestPath` - Specifies the location where the resulting template should be rendered, relative to the task directory.
* `ChangeMode` - Specifies the behavior Nomad should take if the rendered template changes. The possible values are: `noop`, `restart`, `signal`
* `ChangeSignal` - Specifies the signal to send to the task as a string like "SIGUSR1" or "SIGINT". This option is required if the `change_mode` is `signal`.
* `Splay` - Specifies a random amount of time to wait between 0ms and the given splay value before invoking the change mode. Should be specified in nanoseconds.
```json
{
"Templates": [
{
"SourcePath": "local/config.conf.tpl",
"DestPath": "local/config.conf",
"ChangeMode": "signal",
"ChangeSignal": "SIGUSR1",
"Splay": 5000000000
}
]
}
```