docs: clarify drain's `-force` flag behavior with system/CSI jobs (#17703)

If you use `nomad node drain -force`, the drain deadline is set to -1ns. If you
have not prevented system and CSI node plugin allocations from being drained
with `-ignore-system`, they will be immediately drained as well. This is
typically not safe for CSI node plugins.

Also fix some broken links.

Fixes: #17696
This commit is contained in:
Tim Gross 2023-06-23 16:38:11 -04:00 committed by GitHub
parent 9aa9779d80
commit 1432af9a88
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
1 changed files with 5 additions and 1 deletions

View File

@ -65,7 +65,10 @@ capability.
- `-monitor`: Enter monitor mode directly without modifying the drain status.
- `-force`: Remove allocations off the node immediately, regardless of the
allocation's [`migrate`][] block.
allocation's [`migrate`][] block. This will include system jobs and CSI
plugins if `-ignore-system` is not also set, and is not safe for use with CSI
node plugins if the volumes are not being detached externally (for example, a
cloud VM is being terminated).
- `-no-deadline`: No deadline allows the allocations to drain off the node,
ignoring the default 1 hour deadline before allocations are removed regardless
@ -146,6 +149,7 @@ $ nomad node drain -self -monitor
[eligibility]: /nomad/docs/commands/node/eligibility
[migrate]: /nomad/docs/job-specification/migrate
[`migrate`]: /nomad/docs/job-specification/migrate
[node status]: /nomad/docs/commands/node/status
[workload migration guide]: /nomad/tutorials/manage-clusters/node-drain
[internals-csi]: /nomad/docs/concepts/plugins/csi