Skip to content

Commit

Permalink
docs: update task leader to explain shutdown sequence. (#13498)
Browse files Browse the repository at this point in the history
* docs: update task leader to explain shutdown sequence.
  • Loading branch information
DerekStrickland committed Jun 29, 2022
1 parent c635ae0 commit bbd11fd
Showing 1 changed file with 7 additions and 2 deletions.
9 changes: 7 additions & 2 deletions website/content/docs/job-specification/task.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -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.
Expand Down

0 comments on commit bbd11fd

Please sign in to comment.