Add --init option to docker service create

Signed-off-by: Timothy Higinbottom <[email protected]>
Signed-off-by: Vincent Demeester <[email protected]>

cli/command/formatter/service.go

@@ -85,6 +85,7 @@ ContainerSpec:
 {{- if .ContainerWorkDir }}
  Dir:		{{ .ContainerWorkDir }}
 {{- end -}}
+ Init:		{{ .ContainerInit }}
 {{- if .ContainerUser }}
  User: {{ .ContainerUser }}
 {{- end }}
@@ -372,6 +373,14 @@ func (ctx *serviceInspectContext) ContainerUser() string {
 	return ctx.Service.Spec.TaskTemplate.ContainerSpec.User
 }
 
+func (ctx *serviceInspectContext) HasContainerInit() bool {
+	return ctx.Service.Spec.TaskTemplate.ContainerSpec.Init != nil
+}
+
+func (ctx *serviceInspectContext) ContainerInit() bool {
+	return *ctx.Service.Spec.TaskTemplate.ContainerSpec.Init
+}
+
 func (ctx *serviceInspectContext) ContainerMounts() []mounttypes.Mount {
 	return ctx.Service.Spec.TaskTemplate.ContainerSpec.Mounts
 }

cli/command/service/create.go

@@ -58,6 +58,8 @@ func newCreateCommand(dockerCli command.Cli) *cobra.Command {
 	flags.SetAnnotation(flagDNSSearch, "version", []string{"1.25"})
 	flags.Var(&opts.hosts, flagHost, "Set one or more custom host-to-IP mappings (host:ip)")
 	flags.SetAnnotation(flagHost, "version", []string{"1.25"})
+	flags.BoolVar(&opts.init, flagInit, false, "Use an init inside each service container to forward signals and reap processes")
+	flags.SetAnnotation(flagInit, "version", []string{"1.37"})
 
 	flags.Var(cliopts.NewListOptsRef(&opts.resources.resGenericResources, ValidateSingleGenericResource), "generic-resource", "User defined resources")
 	flags.SetAnnotation(flagHostAdd, "version", []string{"1.32"})

cli/command/service/opts.go

@@ -480,6 +480,7 @@ type serviceOptions struct {
 	user            string
 	groups          opts.ListOpts
 	credentialSpec  credentialSpecOpt
+	init            bool
 	stopSignal      string
 	tty             bool
 	readOnly        bool
@@ -624,6 +625,7 @@ func (options *serviceOptions) ToService(ctx context.Context, apiClient client.N
 				TTY:        options.tty,
 				ReadOnly:   options.readOnly,
 				Mounts:     options.mounts.Value(),
+				Init:       &options.init,
 				DNSConfig: &swarm.DNSConfig{
 					Nameservers: options.dns.GetAll(),
 					Search:      options.dnsSearch.GetAll(),
@@ -875,6 +877,7 @@ const (
 	flagRollbackMonitor         = "rollback-monitor"
 	flagRollbackOrder           = "rollback-order"
 	flagRollbackParallelism     = "rollback-parallelism"
+	flagInit                    = "init"
 	flagStopGracePeriod         = "stop-grace-period"
 	flagStopSignal              = "stop-signal"
 	flagTTY                     = "tty"

cli/command/service/update.go

@@ -94,6 +94,8 @@ func newUpdateCommand(dockerCli command.Cli) *cobra.Command {
 	flags.SetAnnotation(flagDNSSearchAdd, "version", []string{"1.25"})
 	flags.Var(&options.hosts, flagHostAdd, "Add a custom host-to-IP mapping (host:ip)")
 	flags.SetAnnotation(flagHostAdd, "version", []string{"1.25"})
+	flags.BoolVar(&options.init, flagInit, false, "Use an init inside each service container to forward signals and reap processes")
+	flags.SetAnnotation(flagInit, "version", []string{"1.37"})
 
 	// Add needs parsing, Remove only needs the key
 	flags.Var(newListOptsVar(), flagGenericResourcesRemove, "Remove a Generic resource")
@@ -235,6 +237,11 @@ func runUpdate(dockerCli command.Cli, flags *pflag.FlagSet, options *serviceOpti
 
 // nolint: gocyclo
 func updateService(ctx context.Context, apiClient client.NetworkAPIClient, flags *pflag.FlagSet, spec *swarm.ServiceSpec) error {
+	updateBool := func(flag string, field *bool) {
+		if flags.Changed(flag) {
+			*field, _ = flags.GetBool(flag)
+		}
+	}
 	updateString := func(flag string, field *string) {
 		if flags.Changed(flag) {
 			*field, _ = flags.GetString(flag)
@@ -306,6 +313,7 @@ func updateService(ctx context.Context, apiClient client.NetworkAPIClient, flags
 	updateString(flagWorkdir, &cspec.Dir)
 	updateString(flagUser, &cspec.User)
 	updateString(flagHostname, &cspec.Hostname)
+	updateBool(flagInit, cspec.Init)
 	if err := updateIsolation(flagIsolation, &cspec.Isolation); err != nil {
 		return err
 	}

cli/command/service/update_test.go

@@ -547,6 +547,32 @@ func TestUpdateReadOnly(t *testing.T) {
 	assert.Check(t, !cspec.ReadOnly)
 }
 
+func TestUpdateInit(t *testing.T) {
+	spec := &swarm.ServiceSpec{
+		TaskTemplate: swarm.TaskSpec{
+			ContainerSpec: &swarm.ContainerSpec{},
+		},
+	}
+	cspec := spec.TaskTemplate.ContainerSpec
+
+	// Update with --init=true
+	flags := newUpdateCommand(nil).Flags()
+	flags.Set("init", "true")
+	updateService(nil, nil, flags, spec)
+	assert.Check(t, is.Equal(true, cspec.Init))
+
+	// Update without --init, no change
+	flags = newUpdateCommand(nil).Flags()
+	updateService(nil, nil, flags, spec)
+	assert.Check(t, is.Equal(true, cspec.Init))
+
+	// Update with --init=false
+	flags = newUpdateCommand(nil).Flags()
+	flags.Set("init", "false")
+	updateService(nil, nil, flags, spec)
+	assert.Check(t, is.Equal(false, cspec.Init))
+}
+
 func TestUpdateStopSignal(t *testing.T) {
 	spec := &swarm.ServiceSpec{
 		TaskTemplate: swarm.TaskSpec{

docs/reference/commandline/service_create.md

@@ -43,6 +43,7 @@ Options:
       --help                               Print usage
       --host list                          Set one or more custom host-to-IP mappings (host:ip)
       --hostname string                    Container hostname
+      --init bool                          Use an init inside each service container to forward signals and reap processes
       --isolation string                   Service container isolation mode
   -l, --label list                         Service labels
       --limit-cpu decimal                  Limit CPUs

docs/reference/commandline/service_update.md

@@ -5,12 +5,12 @@ keywords: "service, update"
 ---
 
 <!-- This file is maintained within the docker/cli GitHub
-     repository at https://github.com/docker/cli/. Make all
-     pull requests against that repo. If you see this file in
-     another repository, consider it read-only there, as it will
-     periodically be overwritten by the definitive file. Pull
-     requests which include edits to this file in other repositories
-     will be rejected.
+	 repository at https://github.com/docker/cli/. Make all
+	 pull requests against that repo. If you see this file in
+	 another repository, consider it read-only there, as it will
+	 periodically be overwritten by the definitive file. Pull
+	 requests which include edits to this file in other repositories
+	 will be rejected.
 -->
 
 # service update
@@ -21,86 +21,87 @@ Usage:  docker service update [OPTIONS] SERVICE
 Update a service
 
 Options:
-      --args command                       Service command args
-      --config-add config                  Add or update a config file on a service
-      --config-rm list                     Remove a configuration file
-      --constraint-add list                Add or update a placement constraint
-      --constraint-rm list                 Remove a constraint
-      --container-label-add list           Add or update a container label
-      --container-label-rm list            Remove a container label by its key
-      --credential-spec credential-spec    Credential spec for managed service account (Windows only)
+	  --args command                       Service command args
+	  --config-add config                  Add or update a config file on a service
+	  --config-rm list                     Remove a configuration file
+	  --constraint-add list                Add or update a placement constraint
+	  --constraint-rm list                 Remove a constraint
+	  --container-label-add list           Add or update a container label
+	  --container-label-rm list            Remove a container label by its key
+	  --credential-spec credential-spec    Credential spec for managed service account (Windows only)
   -d, --detach                             Exit immediately instead of waiting for the service to converge (default true)
-      --dns-add list                       Add or update a custom DNS server
-      --dns-option-add list                Add or update a DNS option
-      --dns-option-rm list                 Remove a DNS option
-      --dns-rm list                        Remove a custom DNS server
-      --dns-search-add list                Add or update a custom DNS search domain
-      --dns-search-rm list                 Remove a DNS search domain
-      --endpoint-mode string               Endpoint mode (vip or dnsrr)
-      --entrypoint command                 Overwrite the default ENTRYPOINT of the image
-      --env-add list                       Add or update an environment variable
-      --env-rm list                        Remove an environment variable
-      --force                              Force update even if no changes require it
-      --generic-resource-add list          Add an additional generic resource to the service's resources requirements
-      --generic-resource-rm list           Remove a previously added generic resource to the service's resources requirements
-      --group-add list                     Add an additional supplementary user group to the container
-      --group-rm list                      Remove a previously added supplementary user group from the container
-      --health-cmd string                  Command to run to check health
-      --health-interval duration           Time between running the check (ms|s|m|h)
-      --health-retries int                 Consecutive failures needed to report unhealthy
-      --health-start-period duration       Start period for the container to initialize before counting retries towards unstable (ms|s|m|h)
-      --health-timeout duration            Maximum time to allow one check to run (ms|s|m|h)
-      --help                               Print usage
-      --host-add list                      Add a custom host-to-IP mapping (host:ip)
-      --host-rm list                       Remove a custom host-to-IP mapping (host:ip)
-      --hostname string                    Container hostname
-      --image string                       Service image tag
-      --isolation string                   Service container isolation mode
-      --label-add list                     Add or update a service label
-      --label-rm list                      Remove a label by its key
-      --limit-cpu decimal                  Limit CPUs
-      --limit-memory bytes                 Limit Memory
-      --log-driver string                  Logging driver for service
-      --log-opt list                       Logging driver options
-      --mount-add mount                    Add or update a mount on a service
-      --mount-rm list                      Remove a mount by its target path
-      --network-add network                Add a network
-      --network-rm list                    Remove a network
-      --no-healthcheck                     Disable any container-specified HEALTHCHECK
-      --no-resolve-image                   Do not query the registry to resolve image digest and supported platforms
-      --placement-pref-add pref            Add a placement preference
-      --placement-pref-rm pref             Remove a placement preference
-      --publish-add port                   Add or update a published port
-      --publish-rm port                    Remove a published port by its target port
+	  --dns-add list                       Add or update a custom DNS server
+	  --dns-option-add list                Add or update a DNS option
+	  --dns-option-rm list                 Remove a DNS option
+	  --dns-rm list                        Remove a custom DNS server
+	  --dns-search-add list                Add or update a custom DNS search domain
+	  --dns-search-rm list                 Remove a DNS search domain
+	  --endpoint-mode string               Endpoint mode (vip or dnsrr)
+	  --entrypoint command                 Overwrite the default ENTRYPOINT of the image
+	  --env-add list                       Add or update an environment variable
+	  --env-rm list                        Remove an environment variable
+	  --force                              Force update even if no changes require it
+	  --generic-resource-add list          Add an additional generic resource to the service's resources requirements
+	  --generic-resource-rm list           Remove a previously added generic resource to the service's resources requirements
+	  --group-add list                     Add an additional supplementary user group to the container
+	  --group-rm list                      Remove a previously added supplementary user group from the container
+	  --health-cmd string                  Command to run to check health
+	  --health-interval duration           Time between running the check (ms|s|m|h)
+	  --health-retries int                 Consecutive failures needed to report unhealthy
+	  --health-start-period duration       Start period for the container to initialize before counting retries towards unstable (ms|s|m|h)
+	  --health-timeout duration            Maximum time to allow one check to run (ms|s|m|h)
+	  --help                               Print usage
+	  --host-add list                      Add a custom host-to-IP mapping (host:ip)
+	  --host-rm list                       Remove a custom host-to-IP mapping (host:ip)
+	  --hostname string                    Container hostname
+	  --image string                       Service image tag
+	  --init bool                          Use an init inside each service container to forward signals and reap processes
+	  --isolation string                   Service container isolation mode
+	  --label-add list                     Add or update a service label
+	  --label-rm list                      Remove a label by its key
+	  --limit-cpu decimal                  Limit CPUs
+	  --limit-memory bytes                 Limit Memory
+	  --log-driver string                  Logging driver for service
+	  --log-opt list                       Logging driver options
+	  --mount-add mount                    Add or update a mount on a service
+	  --mount-rm list                      Remove a mount by its target path
+	  --network-add network                Add a network
+	  --network-rm list                    Remove a network
+	  --no-healthcheck                     Disable any container-specified HEALTHCHECK
+	  --no-resolve-image                   Do not query the registry to resolve image digest and supported platforms
+	  --placement-pref-add pref            Add a placement preference
+	  --placement-pref-rm pref             Remove a placement preference
+	  --publish-add port                   Add or update a published port
+	  --publish-rm port                    Remove a published port by its target port
   -q, --quiet                              Suppress progress output
-      --read-only                          Mount the container's root filesystem as read only
-      --replicas uint                      Number of tasks
-      --reserve-cpu decimal                Reserve CPUs
-      --reserve-memory bytes               Reserve Memory
-      --restart-condition string           Restart when condition is met ("none"|"on-failure"|"any")
-      --restart-delay duration             Delay between restart attempts (ns|us|ms|s|m|h)
-      --restart-max-attempts uint          Maximum number of restarts before giving up
-      --restart-window duration            Window used to evaluate the restart policy (ns|us|ms|s|m|h)
-      --rollback                           Rollback to previous specification
-      --rollback-delay duration            Delay between task rollbacks (ns|us|ms|s|m|h)
-      --rollback-failure-action string     Action on rollback failure ("pause"|"continue")
-      --rollback-max-failure-ratio float   Failure rate to tolerate during a rollback
-      --rollback-monitor duration          Duration after each task rollback to monitor for failure (ns|us|ms|s|m|h)
-      --rollback-order string              Rollback order ("start-first"|"stop-first")
-      --rollback-parallelism uint          Maximum number of tasks rolled back simultaneously (0 to roll back all at once)
-      --secret-add secret                  Add or update a secret on a service
-      --secret-rm list                     Remove a secret
-      --stop-grace-period duration         Time to wait before force killing a container (ns|us|ms|s|m|h)
-      --stop-signal string                 Signal to stop the container
+	  --read-only                          Mount the container's root filesystem as read only
+	  --replicas uint                      Number of tasks
+	  --reserve-cpu decimal                Reserve CPUs
+	  --reserve-memory bytes               Reserve Memory
+	  --restart-condition string           Restart when condition is met ("none"|"on-failure"|"any")
+	  --restart-delay duration             Delay between restart attempts (ns|us|ms|s|m|h)
+	  --restart-max-attempts uint          Maximum number of restarts before giving up
+	  --restart-window duration            Window used to evaluate the restart policy (ns|us|ms|s|m|h)
+	  --rollback                           Rollback to previous specification
+	  --rollback-delay duration            Delay between task rollbacks (ns|us|ms|s|m|h)
+	  --rollback-failure-action string     Action on rollback failure ("pause"|"continue")
+	  --rollback-max-failure-ratio float   Failure rate to tolerate during a rollback
+	  --rollback-monitor duration          Duration after each task rollback to monitor for failure (ns|us|ms|s|m|h)
+	  --rollback-order string              Rollback order ("start-first"|"stop-first")
+	  --rollback-parallelism uint          Maximum number of tasks rolled back simultaneously (0 to roll back all at once)
+	  --secret-add secret                  Add or update a secret on a service
+	  --secret-rm list                     Remove a secret
+	  --stop-grace-period duration         Time to wait before force killing a container (ns|us|ms|s|m|h)
+	  --stop-signal string                 Signal to stop the container
   -t, --tty                                Allocate a pseudo-TTY
-      --update-delay duration              Delay between updates (ns|us|ms|s|m|h)
-      --update-failure-action string       Action on update failure ("pause"|"continue"|"rollback")
-      --update-max-failure-ratio float     Failure rate to tolerate during an update
-      --update-monitor duration            Duration after each task update to monitor for failure (ns|us|ms|s|m|h)
-      --update-order string                Update order ("start-first"|"stop-first")
-      --update-parallelism uint            Maximum number of tasks updated simultaneously (0 to update all at once)
+	  --update-delay duration              Delay between updates (ns|us|ms|s|m|h)
+	  --update-failure-action string       Action on update failure ("pause"|"continue"|"rollback")
+	  --update-max-failure-ratio float     Failure rate to tolerate during an update
+	  --update-monitor duration            Duration after each task update to monitor for failure (ns|us|ms|s|m|h)
+	  --update-order string                Update order ("start-first"|"stop-first")
+	  --update-parallelism uint            Maximum number of tasks updated simultaneously (0 to update all at once)
   -u, --user string                        Username or UID (format: <name|uid>[:<group|gid>])
-      --with-registry-auth                 Send registry authentication details to swarm agents
+	  --with-registry-auth                 Send registry authentication details to swarm agents
   -w, --workdir string                     Working directory inside the container
 ```
 
@@ -157,18 +158,18 @@ service name.
 
 ```bash
 $ docker service create \
-    --name=myservice \
-    --mount \
-      type=volume,source=test-data,target=/somewhere \
-    nginx:alpine \
-    myservice
+	--name=myservice \
+	--mount \
+	  type=volume,source=test-data,target=/somewhere \
+	nginx:alpine \
+	myservice
 
 myservice
 
 $ docker service update \
-    --mount-add \
-      type=volume,source=other-volume,target=/somewhere-else \
-    myservice
+	--mount-add \
+	  type=volume,source=other-volume,target=/somewhere-else \
+	myservice
 
 myservice
 
@@ -282,9 +283,9 @@ The following example adds a secret named `ssh-2` and removes `ssh-1`:
 
 ```bash
 $ docker service update \
-    --secret-add source=ssh-2,target=ssh-2 \
-    --secret-rm ssh-1 \
-    myservice
+	--secret-add source=ssh-2,target=ssh-2 \
+	--secret-rm ssh-1 \
+	myservice
 ```
 
 ### Update services using templates