From 40494e64a95b594e042de32cdce4aebf6c1d8581 Mon Sep 17 00:00:00 2001 From: Luiz Aoqui Date: Fri, 3 Mar 2023 14:44:49 -0500 Subject: [PATCH] docs: fix alloc stop `no_shutdown_delay` (#16282) --- command/alloc_stop.go | 2 +- website/content/api-docs/allocations.mdx | 7 +++++++ 2 files changed, 8 insertions(+), 1 deletion(-) diff --git a/command/alloc_stop.go b/command/alloc_stop.go index 8a130cbaa..bbb8a341a 100644 --- a/command/alloc_stop.go +++ b/command/alloc_stop.go @@ -39,7 +39,7 @@ Stop Specific Options: eval-status command. -no-shutdown-delay - Ignore the the group and task shutdown_delay configuration so there is no + Ignore the the group and task shutdown_delay configuration so there is no delay between service deregistration and task shutdown. Note that using this flag will result in failed network connections to the allocation being stopped. diff --git a/website/content/api-docs/allocations.mdx b/website/content/api-docs/allocations.mdx index 88a9b28ba..88aa46d82 100644 --- a/website/content/api-docs/allocations.mdx +++ b/website/content/api-docs/allocations.mdx @@ -647,6 +647,11 @@ The table below shows this endpoint's support for must be the full UUID, not the short 8-character one. This is specified as part of the path. +- `no_shutdown_delay` `(bool: false)` - Ignore the group and task + [`shutdown_delay`] configuration so that there is no delay between service + deregistration and task shutdown. Note that using this parameter will result + in failed network connections to the allocation being stopped. + ### Sample Request ```shell-session @@ -905,3 +910,5 @@ $ curl \ } ] ``` + +[`shutdown_delay`]: /nomad/docs/job-specification/group#shutdown_delay