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

docs: describe shutdown order on lifecycle page (#26035)

Browse Source 
We have a description of the order of shutdown in the `task.leader` docs, but
the `lifecycle` block is an intuitive place to look for this same information,
and the behavior is largely governed by that feature anyways.
This commit is contained in:
Tim Gross
2025-06-12 15:45:40 -04:00
committed by GitHub
parent 23fd87d9c9
commit 4eb78f1348
2 changed files with 13 additions and 6 deletions
Download Patch File Download Diff File Expand all files Collapse all files

7
website/content/docs/job-specification/lifecycle.mdx
View File

@@ -25,6 +25,11 @@ tasks or "sidecar" tasks that are expected to run for the duration of the main t
The absence of the sidecar flag indicates that the task is ephemeral
and should not be restarted if it completes successfully.
The `lifecycle` block also controls the order Nomad stops tasks in an
allocation. Nomad first waits for the group's [shutdown_delay][]. It then stops
the [leader][] task, if present. Then Nomad stops any non-sidecar and
non-poststop tasks, and finally any sidecar tasks.
Learn more about [Nomad's task dependencies][learn-taskdeps].
## Parameters
@@ -45,6 +50,8 @@ Learn more about [Nomad's task dependencies][learn-taskdeps].
restarted as long as the allocation is running.
[learn-taskdeps]: /nomad/tutorials/task-deps
[shutdown_delay]: /nomad/docs/job-specification/group#shutdown_delay
[leader]: /nomad/docs/job-specification/task#leader
## Examples

12
website/content/docs/job-specification/task.mdx
View File

@@ -72,12 +72,12 @@ job "docs" {
- `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 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.
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, if any, 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.