docs: clarify node pool apply/delete behavior (#17529)

This commit is contained in:
Tim Gross 2023-06-14 15:58:53 -04:00 committed by GitHub
parent dc9fae34ca
commit 5b9322c70a
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
4 changed files with 15 additions and 3 deletions

View File

@ -34,8 +34,10 @@ Usage: nomad node pool apply [options] <input>
Apply is used to create or update a node pool. The specification file is read 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. from stdin by specifying "-", otherwise a path to the file is expected.
If ACLs are enabled, this command requires a token with the 'write' If ACLs are enabled, this command requires a token with the 'write' capability
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: General Options:

View File

@ -33,6 +33,10 @@ Usage: nomad node pool delete [options] <node-pool>
If ACLs are enabled, this command requires a token with the 'delete' 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. 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: General Options:
` + generalOptionsUsage(usageOptsDefault) ` + generalOptionsUsage(usageOptsDefault)

View File

@ -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. 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 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 ## General Options

View File

@ -18,6 +18,10 @@ nomad node pool delete [options] <node-pool>
If ACLs are enabled, this command requires a token with the 'delete' 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. 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 ## General Options
@include 'general_options_no_namespace.mdx' @include 'general_options_no_namespace.mdx'