From e35c5b5b809de21d0eb46004739adebaf5f647b2 Mon Sep 17 00:00:00 2001 From: Michael Schurter Date: Fri, 9 Apr 2021 12:57:19 -0700 Subject: [PATCH] docs: clarify alloc signal behavior The API docs don't make it immediately clear that the alloc signal API signals *all* tasks in an allocation if the `Task` parameter is omitted. You have to dig all the way down into the alloc runner to discover that behavior: https://github.com/hashicorp/nomad/blob/v1.0.4/client/allocrunner/alloc_runner.go#L1189-L1213 --- website/content/api-docs/allocations.mdx | 2 ++ 1 file changed, 2 insertions(+) diff --git a/website/content/api-docs/allocations.mdx b/website/content/api-docs/allocations.mdx index a00d4836e..aaad60d62 100644 --- a/website/content/api-docs/allocations.mdx +++ b/website/content/api-docs/allocations.mdx @@ -656,6 +656,8 @@ The table below shows this endpoint's support for } ``` +If `Task` is omitted, the signal will be sent to all tasks in the allocation. + ### Sample Request ```shell-session