diff --git a/components/cli/docs/reference/commandline/node_rm.md b/components/cli/docs/reference/commandline/node_rm.md index e2f913e1a8..f5d5daaf1c 100644 --- a/components/cli/docs/reference/commandline/node_rm.md +++ b/components/cli/docs/reference/commandline/node_rm.md @@ -11,7 +11,7 @@ parent = "smn_cli" # node rm ```markdown -Usage: docker node rm NODE [NODE...] +Usage: docker node rm [OPTIONS] NODE [NODE...] Remove one or more nodes from the swarm @@ -19,6 +19,7 @@ Aliases: rm, remove Options: + --force Force remove an active node --help Print usage ``` @@ -30,6 +31,24 @@ Example output: $ docker node rm swarm-node-02 Node swarm-node-02 removed from swarm +Removes nodes from the swarm that are in the down state. Attempting to remove +an active node will result in an error: + +```bash +$ docker node rm swarm-node-03 +Error response from daemon: rpc error: code = 9 desc = node swarm-node-03 is not down and can't be removed +``` + +If a worker node becomes compromised, exhibits unexpected or unwanted behavior, or if you lose access to it so +that a clean shutdown is impossible, you can use the force option. + +```bash +$ docker node rm --force swarm-node-03 +Node swarm-node-03 removed from swarm +``` + +Note that manager nodes have to be demoted to worker nodes before they can be removed +from the cluster. ## Related information