Skip to content

Commit caaf53a

Browse files
diogomonicaTibor Vass
diogomonica
authored and
Tibor Vass
committed
Add --force to node removal
Signed-off-by: Diogo Monica <diogo.monica@gmail.com> (cherry picked from commit a327c23) Signed-off-by: Tibor Vass <tibor@docker.com>
1 parent b32462e commit caaf53a

File tree

7 files changed

+87
-10
lines changed

7 files changed

+87
-10
lines changed

‎api/client/node/remove.go‎

Lines changed: 15 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -7,26 +7,36 @@ import (
77

88
"github.com/docker/docker/api/client"
99
"github.com/docker/docker/cli"
10+
"github.com/docker/engine-api/types"
1011
"github.com/spf13/cobra"
1112
)
1213

14+
type removeOptions struct {
15+
force bool
16+
}
17+
1318
func newRemoveCommand(dockerCli *client.DockerCli) *cobra.Command {
14-
return &cobra.Command{
15-
Use: "rm NODE [NODE...]",
19+
opts := removeOptions{}
20+
21+
cmd := &cobra.Command{
22+
Use: "rm [OPTIONS] NODE [NODE...]",
1623
Aliases: []string{"remove"},
1724
Short: "Remove one or more nodes from the swarm",
1825
Args: cli.RequiresMinArgs(1),
1926
RunE: func(cmd *cobra.Command, args []string) error {
20-
return runRemove(dockerCli, args)
27+
return runRemove(dockerCli, args, opts)
2128
},
2229
}
30+
flags := cmd.Flags()
31+
flags.BoolVar(&opts.force, "force", false, "Force remove an active node")
32+
return cmd
2333
}
2434

25-
func runRemove(dockerCli *client.DockerCli, args []string) error {
35+
func runRemove(dockerCli *client.DockerCli, args []string, opts removeOptions) error {
2636
client := dockerCli.Client()
2737
ctx := context.Background()
2838
for _, nodeID := range args {
29-
err := client.NodeRemove(ctx, nodeID)
39+
err := client.NodeRemove(ctx, nodeID, types.NodeRemoveOptions{Force: opts.force})
3040
if err != nil {
3141
return err
3242
}

‎api/server/router/swarm/backend.go‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -20,7 +20,7 @@ type Backend interface {
2020
GetNodes(basictypes.NodeListOptions) ([]types.Node, error)
2121
GetNode(string) (types.Node, error)
2222
UpdateNode(string, uint64, types.NodeSpec) error
23-
RemoveNode(string) error
23+
RemoveNode(string, bool) error
2424
GetTasks(basictypes.TaskListOptions) ([]types.Task, error)
2525
GetTask(string) (types.Task, error)
2626
}

‎api/server/router/swarm/cluster_routes.go‎

Lines changed: 7 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -219,7 +219,13 @@ func (sr *swarmRouter) updateNode(ctx context.Context, w http.ResponseWriter, r
219219
}
220220

221221
func (sr *swarmRouter) removeNode(ctx context.Context, w http.ResponseWriter, r *http.Request, vars map[string]string) error {
222-
if err := sr.backend.RemoveNode(vars["id"]); err != nil {
222+
if err := httputils.ParseForm(r); err != nil {
223+
return err
224+
}
225+
226+
force := httputils.BoolValue(r, "force")
227+
228+
if err := sr.backend.RemoveNode(vars["id"], force); err != nil {
223229
logrus.Errorf("Error removing node %s: %v", vars["id"], err)
224230
return err
225231
}

‎daemon/cluster/cluster.go‎

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1023,7 +1023,7 @@ func (c *Cluster) UpdateNode(nodeID string, version uint64, spec types.NodeSpec)
10231023
}
10241024

10251025
// RemoveNode removes a node from a cluster
1026-
func (c *Cluster) RemoveNode(input string) error {
1026+
func (c *Cluster) RemoveNode(input string, force bool) error {
10271027
c.RLock()
10281028
defer c.RUnlock()
10291029

@@ -1039,7 +1039,7 @@ func (c *Cluster) RemoveNode(input string) error {
10391039
return err
10401040
}
10411041

1042-
if _, err := c.client.RemoveNode(ctx, &swarmapi.RemoveNodeRequest{NodeID: node.ID}); err != nil {
1042+
if _, err := c.client.RemoveNode(ctx, &swarmapi.RemoveNodeRequest{NodeID: node.ID, Force: force}); err != nil {
10431043
return err
10441044
}
10451045
return nil

‎docs/reference/commandline/node_rm.md‎

Lines changed: 20 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -13,14 +13,15 @@ parent = "smn_cli"
1313
# node rm
1414

1515
```markdown
16-
Usage: docker node rm NODE [NODE...]
16+
Usage: docker node rm [OPTIONS] NODE [NODE...]
1717

1818
Remove one or more nodes from the swarm
1919

2020
Aliases:
2121
rm, remove
2222

2323
Options:
24+
--force Force remove an active node
2425
--help Print usage
2526
```
2627

@@ -32,6 +33,24 @@ Example output:
3233
$ docker node rm swarm-node-02
3334
Node swarm-node-02 removed from swarm
3435

36+
Removes nodes from the swarm that are in the down state. Attempting to remove
37+
an active node will result in an error:
38+
39+
```bash
40+
$ docker node rm swarm-node-03
41+
Error response from daemon: rpc error: code = 9 desc = node swarm-node-03 is not down and can't be removed
42+
```
43+
44+
If a worker node becomes compromised, exhibits unexpected or unwanted behavior, or if you lose access to it so
45+
that a clean shutdown is impossible, you can use the force option.
46+
47+
```bash
48+
$ docker node rm --force swarm-node-03
49+
Node swarm-node-03 removed from swarm
50+
```
51+
52+
Note that manager nodes have to be demoted to worker nodes before they can be removed
53+
from the cluster.
3554
3655
## Related information
3756

‎integration-cli/daemon_swarm.go‎

Lines changed: 11 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -208,6 +208,17 @@ func (d *SwarmDaemon) getNode(c *check.C, id string) *swarm.Node {
208208
return &node
209209
}
210210

211+
func (d *SwarmDaemon) removeNode(c *check.C, id string, force bool) {
212+
url := "/nodes/" + id
213+
if force {
214+
url += "?force=1"
215+
}
216+
217+
status, out, err := d.SockRequest("DELETE", url, nil)
218+
c.Assert(status, checker.Equals, http.StatusOK, check.Commentf("output: %q", string(out)))
219+
c.Assert(err, checker.IsNil)
220+
}
221+
211222
func (d *SwarmDaemon) updateNode(c *check.C, id string, f ...nodeConstructor) {
212223
for i := 0; ; i++ {
213224
node := d.getNode(c, id)

‎integration-cli/docker_api_swarm_test.go‎

Lines changed: 31 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -510,6 +510,37 @@ func (s *DockerSwarmSuite) TestApiSwarmNodeUpdate(c *check.C) {
510510
c.Assert(n.Spec.Availability, checker.Equals, swarm.NodeAvailabilityPause)
511511
}
512512

513+
func (s *DockerSwarmSuite) TestApiSwarmNodeRemove(c *check.C) {
514+
testRequires(c, Network)
515+
d1 := s.AddDaemon(c, true, true)
516+
d2 := s.AddDaemon(c, true, false)
517+
_ = s.AddDaemon(c, true, false)
518+
519+
nodes := d1.listNodes(c)
520+
c.Assert(len(nodes), checker.Equals, 3, check.Commentf("nodes: %#v", nodes))
521+
522+
// Getting the info so we can take the NodeID
523+
d2Info, err := d2.info()
524+
c.Assert(err, checker.IsNil)
525+
526+
// forceful removal of d2 should work
527+
d1.removeNode(c, d2Info.NodeID, true)
528+
529+
nodes = d1.listNodes(c)
530+
c.Assert(len(nodes), checker.Equals, 2, check.Commentf("nodes: %#v", nodes))
531+
532+
// Restart the node that was removed
533+
err = d2.Restart()
534+
c.Assert(err, checker.IsNil)
535+
536+
// Give some time for the node to rejoin
537+
time.Sleep(1 * time.Second)
538+
539+
// Make sure the node didn't rejoin
540+
nodes = d1.listNodes(c)
541+
c.Assert(len(nodes), checker.Equals, 2, check.Commentf("nodes: %#v", nodes))
542+
}
543+
513544
func (s *DockerSwarmSuite) TestApiSwarmNodeDrainPause(c *check.C) {
514545
testRequires(c, Network)
515546
d1 := s.AddDaemon(c, true, true)

0 commit comments

Comments
 (0)