docs: update task leader to explain shutdown sequence. (#13498)

* docs: update task leader to explain shutdown sequence.
This commit is contained in:
Derek Strickland
2022-06-29 05:13:45 -04:00
committed by GitHub
parent c635ae0f89
commit bbd11fd9b5

View File

@@ -65,8 +65,13 @@ job "docs" {
drivers).
- `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
tasks within the task group will be gracefully shutdown.
the task group. If set to `true`, when the leader task completes, all other
tasks within the task group will be gracefully shutdown. The shutdown
process starts by applying the `shutdown_delay` if configured. It then stops the
the leader task first, followed by non-sidecar and non-poststop tasks,
and finally sidecar tasks. Once this process completes, post-stop tasks
are triggered. See the [lifecycle][] documentation for a complete description
of task lifecycle management.
- `lifecycle` <code>([Lifecycle][]: nil)</code> - Specifies when a task is run
within the lifecycle of a task group. Added in Nomad v0.11.