Browse code

Merge pull request #23773 from dnephin/allow-remove-during-update

Add remove flags for service update

Vincent Demeester authored on 2016/07/14 18:10:30
Showing 5 changed files
... ...
@@ -28,7 +28,15 @@ func newCreateCommand(dockerCli *client.DockerCli) *cobra.Command {
28 28
 	flags := cmd.Flags()
29 29
 	flags.StringVar(&opts.mode, flagMode, "replicated", "Service mode (replicated or global)")
30 30
 	addServiceFlags(cmd, opts)
31
-	cmd.Flags().SetInterspersed(false)
31
+
32
+	flags.VarP(&opts.labels, flagLabel, "l", "Service labels")
33
+	flags.VarP(&opts.env, flagEnv, "e", "Set environment variables")
34
+	flags.Var(&opts.mounts, flagMount, "Attach a mount to the service")
35
+	flags.StringSliceVar(&opts.constraints, flagConstraint, []string{}, "Placement constraints")
36
+	flags.StringSliceVar(&opts.networks, flagNetwork, []string{}, "Network attachments")
37
+	flags.VarP(&opts.endpoint.ports, flagPublish, "p", "Publish a port as a node port")
38
+
39
+	flags.SetInterspersed(false)
32 40
 	return cmd
33 41
 }
34 42
 
... ...
@@ -459,12 +459,9 @@ func (opts *serviceOptions) ToService() (swarm.ServiceSpec, error) {
459 459
 func addServiceFlags(cmd *cobra.Command, opts *serviceOptions) {
460 460
 	flags := cmd.Flags()
461 461
 	flags.StringVar(&opts.name, flagName, "", "Service name")
462
-	flags.VarP(&opts.labels, flagLabel, "l", "Service labels")
463 462
 
464
-	flags.VarP(&opts.env, "env", "e", "Set environment variables")
465 463
 	flags.StringVarP(&opts.workdir, "workdir", "w", "", "Working directory inside the container")
466 464
 	flags.StringVarP(&opts.user, flagUser, "u", "", "Username or UID")
467
-	flags.Var(&opts.mounts, flagMount, "Attach a mount to the service")
468 465
 
469 466
 	flags.Var(&opts.resources.limitCPU, flagLimitCPU, "Limit CPUs")
470 467
 	flags.Var(&opts.resources.limitMemBytes, flagLimitMemory, "Limit Memory")
... ...
@@ -479,29 +476,38 @@ func addServiceFlags(cmd *cobra.Command, opts *serviceOptions) {
479 479
 	flags.Var(&opts.restartPolicy.maxAttempts, flagRestartMaxAttempts, "Maximum number of restarts before giving up")
480 480
 	flags.Var(&opts.restartPolicy.window, flagRestartWindow, "Window used to evaluate the restart policy")
481 481
 
482
-	flags.StringSliceVar(&opts.constraints, flagConstraint, []string{}, "Placement constraints")
483
-
484 482
 	flags.Uint64Var(&opts.update.parallelism, flagUpdateParallelism, 0, "Maximum number of tasks updated simultaneously")
485 483
 	flags.DurationVar(&opts.update.delay, flagUpdateDelay, time.Duration(0), "Delay between updates")
486 484
 
487
-	flags.StringSliceVar(&opts.networks, flagNetwork, []string{}, "Network attachments")
488 485
 	flags.StringVar(&opts.endpoint.mode, flagEndpointMode, "", "Endpoint mode (vip or dnsrr)")
489
-	flags.VarP(&opts.endpoint.ports, flagPublish, "p", "Publish a port as a node port")
490 486
 
491 487
 	flags.BoolVar(&opts.registryAuth, flagRegistryAuth, false, "Send registry authentication details to Swarm agents")
492 488
 }
493 489
 
494 490
 const (
495 491
 	flagConstraint         = "constraint"
492
+	flagConstraintRemove   = "constraint-rm"
493
+	flagConstraintAdd      = "constraint-add"
496 494
 	flagEndpointMode       = "endpoint-mode"
495
+	flagEnv                = "env"
496
+	flagEnvRemove          = "env-rm"
497
+	flagEnvAdd             = "env-add"
497 498
 	flagLabel              = "label"
499
+	flagLabelRemove        = "label-rm"
500
+	flagLabelAdd           = "label-add"
498 501
 	flagLimitCPU           = "limit-cpu"
499 502
 	flagLimitMemory        = "limit-memory"
500 503
 	flagMode               = "mode"
501 504
 	flagMount              = "mount"
505
+	flagMountRemove        = "mount-rm"
506
+	flagMountAdd           = "mount-add"
502 507
 	flagName               = "name"
503 508
 	flagNetwork            = "network"
509
+	flagNetworkRemove      = "network-rm"
510
+	flagNetworkAdd         = "network-add"
504 511
 	flagPublish            = "publish"
512
+	flagPublishRemove      = "publish-rm"
513
+	flagPublishAdd         = "publish-add"
505 514
 	flagReplicas           = "replicas"
506 515
 	flagReserveCPU         = "reserve-cpu"
507 516
 	flagReserveMemory      = "reserve-memory"
... ...
@@ -2,6 +2,7 @@ package service
2 2
 
3 3
 import (
4 4
 	"fmt"
5
+	"strings"
5 6
 	"time"
6 7
 
7 8
 	"golang.org/x/net/context"
... ...
@@ -34,9 +35,26 @@ func newUpdateCommand(dockerCli *client.DockerCli) *cobra.Command {
34 34
 	flags.String("image", "", "Service image tag")
35 35
 	flags.String("args", "", "Service command args")
36 36
 	addServiceFlags(cmd, opts)
37
+
38
+	flags.Var(newListOptsVar(), flagEnvRemove, "Remove an environment variable")
39
+	flags.Var(newListOptsVar(), flagLabelRemove, "Remove a label by its key")
40
+	flags.Var(newListOptsVar(), flagMountRemove, "Remove a mount by its target path")
41
+	flags.Var(newListOptsVar(), flagPublishRemove, "Remove a published port by its target port")
42
+	flags.Var(newListOptsVar(), flagNetworkRemove, "Remove a network by name")
43
+	flags.Var(newListOptsVar(), flagConstraintRemove, "Remove a constraint")
44
+	flags.Var(&opts.labels, flagLabelAdd, "Add or update service labels")
45
+	flags.Var(&opts.env, flagEnvAdd, "Add or update environment variables")
46
+	flags.Var(&opts.mounts, flagMountAdd, "Add or update a mount on a service")
47
+	flags.StringSliceVar(&opts.constraints, flagConstraintAdd, []string{}, "Add or update placement constraints")
48
+	flags.StringSliceVar(&opts.networks, flagNetworkAdd, []string{}, "Add or update network attachments")
49
+	flags.Var(&opts.endpoint.ports, flagPublishAdd, "Add or update a published port")
37 50
 	return cmd
38 51
 }
39 52
 
53
+func newListOptsVar() *opts.ListOpts {
54
+	return opts.NewListOptsRef(&[]string{}, nil)
55
+}
56
+
40 57
 func runUpdate(dockerCli *client.DockerCli, flags *pflag.FlagSet, serviceID string) error {
41 58
 	apiClient := dockerCli.Client()
42 59
 	ctx := context.Background()
... ...
@@ -85,13 +103,6 @@ func updateService(flags *pflag.FlagSet, spec *swarm.ServiceSpec) error {
85 85
 		}
86 86
 	}
87 87
 
88
-	updateListOpts := func(flag string, field *[]string) {
89
-		if flags.Changed(flag) {
90
-			value := flags.Lookup(flag).Value.(*opts.ListOpts)
91
-			*field = value.GetAll()
92
-		}
93
-	}
94
-
95 88
 	updateInt64Value := func(flag string, field *int64) {
96 89
 		if flags.Changed(flag) {
97 90
 			*field = flags.Lookup(flag).Value.(int64Value).Value()
... ...
@@ -136,7 +147,7 @@ func updateService(flags *pflag.FlagSet, spec *swarm.ServiceSpec) error {
136 136
 	updateLabels(flags, &spec.Labels)
137 137
 	updateString("image", &cspec.Image)
138 138
 	updateStringToSlice(flags, "args", &cspec.Args)
139
-	updateListOpts("env", &cspec.Env)
139
+	updateEnvironment(flags, &cspec.Env)
140 140
 	updateString("workdir", &cspec.Dir)
141 141
 	updateString(flagUser, &cspec.User)
142 142
 	updateMounts(flags, &cspec.Mounts)
... ...
@@ -169,7 +180,12 @@ func updateService(flags *pflag.FlagSet, spec *swarm.ServiceSpec) error {
169 169
 		updateDurationOpt((flagRestartWindow), task.RestartPolicy.Window)
170 170
 	}
171 171
 
172
-	// TODO: The constraints field is fixed in #23773
172
+	if anyChanged(flags, flagConstraintAdd, flagConstraintRemove) {
173
+		if task.Placement == nil {
174
+			task.Placement = &swarm.Placement{}
175
+		}
176
+		updatePlacement(flags, task.Placement)
177
+	}
173 178
 
174 179
 	if err := updateReplicas(flags, &spec.Mode); err != nil {
175 180
 		return err
... ...
@@ -189,7 +205,7 @@ func updateService(flags *pflag.FlagSet, spec *swarm.ServiceSpec) error {
189 189
 		spec.EndpointSpec.Mode = swarm.ResolutionMode(value)
190 190
 	}
191 191
 
192
-	if flags.Changed(flagPublish) {
192
+	if anyChanged(flags, flagPublishAdd, flagPublishRemove) {
193 193
 		if spec.EndpointSpec == nil {
194 194
 			spec.EndpointSpec = &swarm.EndpointSpec{}
195 195
 		}
... ...
@@ -209,65 +225,154 @@ func updateStringToSlice(flags *pflag.FlagSet, flag string, field *[]string) err
209 209
 	return err
210 210
 }
211 211
 
212
+func anyChanged(flags *pflag.FlagSet, fields ...string) bool {
213
+	for _, flag := range fields {
214
+		if flags.Changed(flag) {
215
+			return true
216
+		}
217
+	}
218
+	return false
219
+}
220
+
221
+func updatePlacement(flags *pflag.FlagSet, placement *swarm.Placement) {
222
+	field, _ := flags.GetStringSlice(flagConstraintAdd)
223
+	placement.Constraints = append(placement.Constraints, field...)
224
+
225
+	toRemove := buildToRemoveSet(flags, flagConstraintRemove)
226
+	placement.Constraints = removeItems(placement.Constraints, toRemove, itemKey)
227
+}
228
+
212 229
 func updateLabels(flags *pflag.FlagSet, field *map[string]string) {
213
-	if !flags.Changed(flagLabel) {
214
-		return
230
+	if flags.Changed(flagLabelAdd) {
231
+		if field == nil {
232
+			*field = map[string]string{}
233
+		}
234
+
235
+		values := flags.Lookup(flagLabelAdd).Value.(*opts.ListOpts).GetAll()
236
+		for key, value := range runconfigopts.ConvertKVStringsToMap(values) {
237
+			(*field)[key] = value
238
+		}
215 239
 	}
216 240
 
217
-	values := flags.Lookup(flagLabel).Value.(*opts.ListOpts).GetAll()
241
+	if field != nil && flags.Changed(flagLabelRemove) {
242
+		toRemove := flags.Lookup(flagLabelRemove).Value.(*opts.ListOpts).GetAll()
243
+		for _, label := range toRemove {
244
+			delete(*field, label)
245
+		}
246
+	}
247
+}
218 248
 
219
-	localLabels := map[string]string{}
220
-	for key, value := range runconfigopts.ConvertKVStringsToMap(values) {
221
-		localLabels[key] = value
249
+func updateEnvironment(flags *pflag.FlagSet, field *[]string) {
250
+	if flags.Changed(flagEnvAdd) {
251
+		value := flags.Lookup(flagEnvAdd).Value.(*opts.ListOpts)
252
+		*field = append(*field, value.GetAll()...)
222 253
 	}
223
-	*field = localLabels
254
+	toRemove := buildToRemoveSet(flags, flagEnvRemove)
255
+	*field = removeItems(*field, toRemove, envKey)
224 256
 }
225 257
 
226
-func anyChanged(flags *pflag.FlagSet, fields ...string) bool {
227
-	for _, flag := range fields {
228
-		if flags.Changed(flag) {
229
-			return true
258
+func envKey(value string) string {
259
+	kv := strings.SplitN(value, "=", 2)
260
+	return kv[0]
261
+}
262
+
263
+func itemKey(value string) string {
264
+	return value
265
+}
266
+
267
+func buildToRemoveSet(flags *pflag.FlagSet, flag string) map[string]struct{} {
268
+	var empty struct{}
269
+	toRemove := make(map[string]struct{})
270
+
271
+	if !flags.Changed(flag) {
272
+		return toRemove
273
+	}
274
+
275
+	toRemoveSlice := flags.Lookup(flag).Value.(*opts.ListOpts).GetAll()
276
+	for _, key := range toRemoveSlice {
277
+		toRemove[key] = empty
278
+	}
279
+	return toRemove
280
+}
281
+
282
+func removeItems(
283
+	seq []string,
284
+	toRemove map[string]struct{},
285
+	keyFunc func(string) string,
286
+) []string {
287
+	newSeq := []string{}
288
+	for _, item := range seq {
289
+		if _, exists := toRemove[keyFunc(item)]; !exists {
290
+			newSeq = append(newSeq, item)
230 291
 		}
231 292
 	}
232
-	return false
293
+	return newSeq
233 294
 }
234 295
 
235
-// TODO: should this override by destination path, or does swarm handle that?
236 296
 func updateMounts(flags *pflag.FlagSet, mounts *[]swarm.Mount) {
237
-	if !flags.Changed(flagMount) {
238
-		return
297
+	if flags.Changed(flagMountAdd) {
298
+		values := flags.Lookup(flagMountAdd).Value.(*MountOpt).Value()
299
+		*mounts = append(*mounts, values...)
239 300
 	}
301
+	toRemove := buildToRemoveSet(flags, flagMountRemove)
240 302
 
241
-	*mounts = flags.Lookup(flagMount).Value.(*MountOpt).Value()
303
+	newMounts := []swarm.Mount{}
304
+	for _, mount := range *mounts {
305
+		if _, exists := toRemove[mount.Target]; !exists {
306
+			newMounts = append(newMounts, mount)
307
+		}
308
+	}
309
+	*mounts = newMounts
242 310
 }
243 311
 
244
-// TODO: should this override by name, or does swarm handle that?
245 312
 func updatePorts(flags *pflag.FlagSet, portConfig *[]swarm.PortConfig) {
246
-	if !flags.Changed(flagPublish) {
247
-		return
248
-	}
313
+	if flags.Changed(flagPublishAdd) {
314
+		values := flags.Lookup(flagPublishAdd).Value.(*opts.ListOpts).GetAll()
315
+		ports, portBindings, _ := nat.ParsePortSpecs(values)
249 316
 
250
-	values := flags.Lookup(flagPublish).Value.(*opts.ListOpts).GetAll()
251
-	ports, portBindings, _ := nat.ParsePortSpecs(values)
317
+		for port := range ports {
318
+			*portConfig = append(*portConfig, convertPortToPortConfig(port, portBindings)...)
319
+		}
320
+	}
252 321
 
253
-	var localPortConfig []swarm.PortConfig
254
-	for port := range ports {
255
-		localPortConfig = append(localPortConfig, convertPortToPortConfig(port, portBindings)...)
322
+	if !flags.Changed(flagPublishRemove) {
323
+		return
256 324
 	}
257
-	*portConfig = localPortConfig
325
+	toRemove := flags.Lookup(flagPublishRemove).Value.(*opts.ListOpts).GetAll()
326
+	newPorts := []swarm.PortConfig{}
327
+portLoop:
328
+	for _, port := range *portConfig {
329
+		for _, rawTargetPort := range toRemove {
330
+			targetPort := nat.Port(rawTargetPort)
331
+			if equalPort(targetPort, port) {
332
+				continue portLoop
333
+			}
334
+		}
335
+		newPorts = append(newPorts, port)
336
+	}
337
+	*portConfig = newPorts
338
+}
339
+
340
+func equalPort(targetPort nat.Port, port swarm.PortConfig) bool {
341
+	return (string(port.Protocol) == targetPort.Proto() &&
342
+		port.TargetPort == uint32(targetPort.Int()))
258 343
 }
259 344
 
260 345
 func updateNetworks(flags *pflag.FlagSet, attachments *[]swarm.NetworkAttachmentConfig) {
261
-	if !flags.Changed(flagNetwork) {
262
-		return
346
+	if flags.Changed(flagNetworkAdd) {
347
+		networks, _ := flags.GetStringSlice(flagNetworkAdd)
348
+		for _, network := range networks {
349
+			*attachments = append(*attachments, swarm.NetworkAttachmentConfig{Target: network})
350
+		}
263 351
 	}
264
-	networks, _ := flags.GetStringSlice(flagNetwork)
265
-
266
-	var localAttachments []swarm.NetworkAttachmentConfig
267
-	for _, network := range networks {
268
-		localAttachments = append(localAttachments, swarm.NetworkAttachmentConfig{Target: network})
352
+	toRemove := buildToRemoveSet(flags, flagNetworkRemove)
353
+	newNetworks := []swarm.NetworkAttachmentConfig{}
354
+	for _, network := range *attachments {
355
+		if _, exists := toRemove[network.Target]; !exists {
356
+			newNetworks = append(newNetworks, network)
357
+		}
269 358
 	}
270
-	*attachments = localAttachments
359
+	*attachments = newNetworks
271 360
 }
272 361
 
273 362
 func updateReplicas(flags *pflag.FlagSet, serviceMode *swarm.ServiceMode) error {
... ...
@@ -18,3 +18,116 @@ func TestUpdateServiceArgs(t *testing.T) {
18 18
 	updateService(flags, spec)
19 19
 	assert.EqualStringSlice(t, cspec.Args, []string{"the", "new args"})
20 20
 }
21
+
22
+func TestUpdateLabels(t *testing.T) {
23
+	flags := newUpdateCommand(nil).Flags()
24
+	flags.Set("label-add", "toadd=newlabel")
25
+	flags.Set("label-rm", "toremove")
26
+
27
+	labels := map[string]string{
28
+		"toremove": "thelabeltoremove",
29
+		"tokeep":   "value",
30
+	}
31
+
32
+	updateLabels(flags, &labels)
33
+	assert.Equal(t, len(labels), 2)
34
+	assert.Equal(t, labels["tokeep"], "value")
35
+	assert.Equal(t, labels["toadd"], "newlabel")
36
+}
37
+
38
+func TestUpdateLabelsRemoveALabelThatDoesNotExist(t *testing.T) {
39
+	flags := newUpdateCommand(nil).Flags()
40
+	flags.Set("label-rm", "dne")
41
+
42
+	labels := map[string]string{"foo": "theoldlabel"}
43
+	updateLabels(flags, &labels)
44
+	assert.Equal(t, len(labels), 1)
45
+}
46
+
47
+func TestUpdatePlacement(t *testing.T) {
48
+	flags := newUpdateCommand(nil).Flags()
49
+	flags.Set("constraint-add", "node=toadd")
50
+	flags.Set("constraint-rm", "node!=toremove")
51
+
52
+	placement := &swarm.Placement{
53
+		Constraints: []string{"node!=toremove", "container=tokeep"},
54
+	}
55
+
56
+	updatePlacement(flags, placement)
57
+	assert.Equal(t, len(placement.Constraints), 2)
58
+	assert.Equal(t, placement.Constraints[0], "container=tokeep")
59
+	assert.Equal(t, placement.Constraints[1], "node=toadd")
60
+}
61
+
62
+func TestUpdateEnvironment(t *testing.T) {
63
+	flags := newUpdateCommand(nil).Flags()
64
+	flags.Set("env-add", "toadd=newenv")
65
+	flags.Set("env-rm", "toremove")
66
+
67
+	envs := []string{"toremove=theenvtoremove", "tokeep=value"}
68
+
69
+	updateEnvironment(flags, &envs)
70
+	assert.Equal(t, len(envs), 2)
71
+	assert.Equal(t, envs[0], "tokeep=value")
72
+	assert.Equal(t, envs[1], "toadd=newenv")
73
+}
74
+
75
+func TestUpdateEnvironmentWithDuplicateValues(t *testing.T) {
76
+	flags := newUpdateCommand(nil).Flags()
77
+	flags.Set("env-add", "foo=newenv")
78
+	flags.Set("env-add", "foo=dupe")
79
+	flags.Set("env-rm", "foo")
80
+
81
+	envs := []string{"foo=value"}
82
+
83
+	updateEnvironment(flags, &envs)
84
+	assert.Equal(t, len(envs), 0)
85
+}
86
+
87
+func TestUpdateMounts(t *testing.T) {
88
+	flags := newUpdateCommand(nil).Flags()
89
+	flags.Set("mount-add", "type=volume,target=/toadd")
90
+	flags.Set("mount-rm", "/toremove")
91
+
92
+	mounts := []swarm.Mount{
93
+		{Target: "/toremove", Type: swarm.MountType("BIND")},
94
+		{Target: "/tokeep", Type: swarm.MountType("BIND")},
95
+	}
96
+
97
+	updateMounts(flags, &mounts)
98
+	assert.Equal(t, len(mounts), 2)
99
+	assert.Equal(t, mounts[0].Target, "/tokeep")
100
+	assert.Equal(t, mounts[1].Target, "/toadd")
101
+}
102
+
103
+func TestUpdateNetworks(t *testing.T) {
104
+	flags := newUpdateCommand(nil).Flags()
105
+	flags.Set("network-add", "toadd")
106
+	flags.Set("network-rm", "toremove")
107
+
108
+	attachments := []swarm.NetworkAttachmentConfig{
109
+		{Target: "toremove", Aliases: []string{"foo"}},
110
+		{Target: "tokeep"},
111
+	}
112
+
113
+	updateNetworks(flags, &attachments)
114
+	assert.Equal(t, len(attachments), 2)
115
+	assert.Equal(t, attachments[0].Target, "tokeep")
116
+	assert.Equal(t, attachments[1].Target, "toadd")
117
+}
118
+
119
+func TestUpdatePorts(t *testing.T) {
120
+	flags := newUpdateCommand(nil).Flags()
121
+	flags.Set("publish-add", "1000:1000")
122
+	flags.Set("publish-rm", "333/udp")
123
+
124
+	portConfigs := []swarm.PortConfig{
125
+		{TargetPort: 333, Protocol: swarm.PortConfigProtocol("udp")},
126
+		{TargetPort: 555},
127
+	}
128
+
129
+	updatePorts(flags, &portConfigs)
130
+	assert.Equal(t, len(portConfigs), 2)
131
+	assert.Equal(t, portConfigs[0].TargetPort, uint32(555))
132
+	assert.Equal(t, portConfigs[1].TargetPort, uint32(1000))
133
+}
... ...
@@ -22,7 +22,7 @@ func (s *DockerSwarmSuite) TestServiceUpdatePort(c *check.C) {
22 22
 	waitAndAssert(c, defaultReconciliationTimeout, d.checkActiveContainerCount, checker.Equals, 1)
23 23
 
24 24
 	// Update the service: changed the port mapping from 8080:8081 to 8082:8083.
25
-	_, err = d.Cmd("service", "update", "-p", "8082:8083", serviceName)
25
+	_, err = d.Cmd("service", "update", "--publish-add", "8082:8083", "--publish-rm", "8081", serviceName)
26 26
 	c.Assert(err, checker.IsNil)
27 27
 
28 28
 	// Inspect the service and verify port mapping