From 74d363d3427ed2d97537fd38128e5e7fbeb5beca Mon Sep 17 00:00:00 2001 From: James Nugent Date: Tue, 21 Feb 2017 13:52:29 -0600 Subject: [PATCH] docs: Add note about max_kill_timeout to tasks 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. --- website/source/docs/job-specification/task.html.md | 5 ++++- 1 file changed, 4 insertions(+), 1 deletion(-) diff --git a/website/source/docs/job-specification/task.html.md b/website/source/docs/job-specification/task.html.md index 76be98ca1..f2de3a8a0 100644 --- a/website/source/docs/job-specification/task.html.md +++ b/website/source/docs/job-specification/task.html.md @@ -50,7 +50,9 @@ job "docs" { - `kill_timeout` `(string: "5s")` - Specifies the duration to wait for an 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 - 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 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" [user_drivers]: /docs/agent/configuration/client.html#_quot_user_checked_drivers_quot_ [user_blacklist]: /docs/agent/configuration/client.html#_quot_user_blacklist_quot_ +[max_kill]: /docs/agent/configuration/client.html#max_kill_timeout