luxolus/open-nomad
2
0
Fork 0
Code Issues 1 Pull requests Packages Releases Wiki Activity

docs: Add note about max_kill_timeout to tasks

Browse source 
This commit makes an explicit note in the documentation for the Nomad
task specification about capping of `max_kill_timeout` based on agent
configuration as well as task configuration.
This commit is contained in:
James Nugent 2017-02-21 13:52:29 -06:00
parent e8391ae1df
commit 74d363d342
1 changed files with 4 additions and 1 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

5
website/source/docs/job-specification/task.html.md
View file

@ -50,7 +50,9 @@ job "docs" {
- `kill_timeout` `(string: "5s")` - Specifies the duration to wait for an - `kill_timeout` `(string: "5s")` - Specifies the duration to wait for an
application to gracefully quit before force-killing. Nomad sends an `SIGINT`. application to gracefully quit before force-killing. Nomad sends an `SIGINT`.
If the task does not exit before the configured timeout, `SIGKILL` is sent to If the task does not exit before the configured timeout, `SIGKILL` is sent to
the task. the task. Note that the value set here is capped at the value set for
[`max_kill_timeout`][max_kill] on the agent running the task, which has a
default value of 30 seconds.
- `leader` `(bool: false)` - Specifies whether the task is the leader task of - `leader` `(bool: false)` - Specifies whether the task is the leader task of
the task group. If set to true, when the leader task completes, all other the task group. If set to true, when the leader task completes, all other
@ -183,3 +185,4 @@ task "server" {
[template]: /docs/job-specification/template.html "Nomad template Job Specification" [template]: /docs/job-specification/template.html "Nomad template Job Specification"
[user_drivers]: /docs/agent/configuration/client.html#_quot_user_checked_drivers_quot_ [user_drivers]: /docs/agent/configuration/client.html#_quot_user_checked_drivers_quot_
[user_blacklist]: /docs/agent/configuration/client.html#_quot_user_blacklist_quot_ [user_blacklist]: /docs/agent/configuration/client.html#_quot_user_blacklist_quot_
[max_kill]: /docs/agent/configuration/client.html#max_kill_timeout