From 5b9322c70a46fd762a3008a5b184989730a927d3 Mon Sep 17 00:00:00 2001 From: Tim Gross Date: Wed, 14 Jun 2023 15:58:53 -0400 Subject: [PATCH] docs: clarify node pool apply/delete behavior (#17529) --- command/node_pool_apply.go | 6 ++++-- command/node_pool_delete.go | 4 ++++ website/content/docs/commands/node-pool/apply.mdx | 4 +++- website/content/docs/commands/node-pool/delete.mdx | 4 ++++ 4 files changed, 15 insertions(+), 3 deletions(-) diff --git a/command/node_pool_apply.go b/command/node_pool_apply.go index 5ce976d83..dc7ba116b 100644 --- a/command/node_pool_apply.go +++ b/command/node_pool_apply.go @@ -34,8 +34,10 @@ Usage: nomad node pool apply [options] Apply is used to create or update a node pool. The specification file is read from stdin by specifying "-", otherwise a path to the file is expected. - If ACLs are enabled, this command requires a token with the 'write' - capability in a 'node_pool' policy that matches the node pool being targeted. + If ACLs are enabled, this command requires a token with the 'write' capability + in a 'node_pool' policy that matches the node pool being targeted. In + federated clusters, the node pool will be created in the authoritative region + and will be replicated to all federated regions. General Options: diff --git a/command/node_pool_delete.go b/command/node_pool_delete.go index 20398ac20..085827a1c 100644 --- a/command/node_pool_delete.go +++ b/command/node_pool_delete.go @@ -33,6 +33,10 @@ Usage: nomad node pool delete [options] If ACLs are enabled, this command requires a token with the 'delete' capability in a 'node_pool' policy that matches the node pool being targeted. + You cannot delete a node pool that has nodes or non-terminal jobs. In + federated clusters, you cannot delete a node pool that has nodes or + non-terminal jobs in any of the federated regions. + General Options: ` + generalOptionsUsage(usageOptsDefault) diff --git a/website/content/docs/commands/node-pool/apply.mdx b/website/content/docs/commands/node-pool/apply.mdx index b98652c80..7c462f7ff 100644 --- a/website/content/docs/commands/node-pool/apply.mdx +++ b/website/content/docs/commands/node-pool/apply.mdx @@ -19,7 +19,9 @@ Apply is used to create or update a node pool. The specification file is read from stdin by specifying `-`, otherwise a path to the file is expected. If ACLs are enabled, this command requires a token with the `write` capability -in a `node_pool` policy that matches the node pool being targeted. +in a `node_pool` policy that matches the node pool being targeted. In federated +clusters, the node pool will be created in the authoritative region and will be +replicated to all federated regions. ## General Options diff --git a/website/content/docs/commands/node-pool/delete.mdx b/website/content/docs/commands/node-pool/delete.mdx index 45353da29..bc9748cc9 100644 --- a/website/content/docs/commands/node-pool/delete.mdx +++ b/website/content/docs/commands/node-pool/delete.mdx @@ -18,6 +18,10 @@ nomad node pool delete [options] If ACLs are enabled, this command requires a token with the 'delete' capability in a `node_pool` policy that matches the node pool being targeted. +You cannot delete a node pool that has nodes or non-terminal jobs. In federated +clusters, you cannot delete a node pool that has nodes or non-terminal jobs in +any of the federated regions. + ## General Options @include 'general_options_no_namespace.mdx'