Update a service
| Name | Type | Default | Description |
|---|---|---|---|
--args | command | Service command args | |
--cap-add | list | Add Linux capabilities | |
--cap-drop | list | Drop Linux capabilities | |
--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 | bool | Exit immediately instead of waiting for the service to converge | |
--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 | bool | Force update even if no changes require it | |
--generic-resource-add | list | Add a Generic resource | |
--generic-resource-rm | list | Remove a Generic resource | |
--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 | 0 | Consecutive failures needed to report unhealthy |
--health-start-interval | duration | Time between running the check during the start period (ms|s|m|h) | |
--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) | |
--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 | 0 | Limit Memory |
--limit-pids | int64 | 0 | Limit maximum number of processes (default 0 = unlimited) |
--log-driver | string | Logging driver for service | |
--log-opt | list | Logging driver options | |
--max-concurrent | uint | Number of job tasks to run concurrently (default equal to --replicas) | |
--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 | bool | Disable any container-specified HEALTHCHECK | |
--no-resolve-image | bool | Do not query the registry to resolve image digest and supported platforms | |
--oom-score-adj | int64 | 0 | Tune host's OOM preferences (-1000 to 1000) |
--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 | bool | Suppress progress output | |
--read-only | bool | Mount the container's root filesystem as read only | |
--replicas | uint | Number of tasks | |
--replicas-max-per-node | uint64 | 0 | Maximum number of tasks per node (default 0 = unlimited) |
--reserve-cpu | decimal | Reserve CPUs | |
--reserve-memory | bytes | 0 | 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 | bool | Rollback to previous specification | |
--rollback-delay | duration | 0s | 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 | 0 | Failure rate to tolerate during a rollback |
--rollback-monitor | duration | 0s | 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 | uint64 | 0 | 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 | |
--sysctl-add | list | Add or update a Sysctl option | |
--sysctl-rm | list | Remove a Sysctl option | |
-t, --tty | bool | Allocate a pseudo-TTY | |
--ulimit-add | ulimit | Add or update a ulimit option | |
--ulimit-rm | list | Remove a ulimit option | |
--update-delay | duration | 0s | 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 | 0 | Failure rate to tolerate during an update |
--update-monitor | duration | 0s | 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 | uint64 | 0 | 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 | bool | Send registry authentication details to swarm agents | |
-w, --workdir | string | Working directory inside the container |
Updates a service as described by the specified parameters. The parameters are the same as docker service create. Refer to the description there for further information.
Normally, updating a service will only cause the service's tasks to be replaced with new ones if a change to the service requires recreating the tasks for it to take effect. For example, only changing the --update-parallelism setting will not recreate the tasks, because the individual tasks are not affected by this setting. However, the --force flag will cause the tasks to be recreated anyway. This can be used to perform a rolling restart without any changes to the service parameters.
[!NOTE] This is a cluster management command, and must be executed on a swarm manager node. To learn about managers and workers, refer to the Swarm mode section in the documentation.
$ docker service update --limit-cpu 2 redis
$ docker service update --force --update-parallelism 1 --update-delay 30s redis
In this example, the --force flag causes the service's tasks to be shut down and replaced with new ones even though none of the other parameters would normally cause that to happen. The --update-parallelism 1 setting ensures that only one task is replaced at a time (this is the default behavior). The --update-delay 30s setting introduces a 30 second delay between tasks, so that the rolling restart happens gradually.
Use the --mount-add or --mount-rm options add or remove a service's bind mounts or volumes.
The following example creates a service which mounts the test-data volume to /somewhere. The next step updates the service to also mount the other-volume volume to /somewhere-elsevolume, The last step unmounts the /somewhere mount point, effectively removing the test-data volume. Each command returns the service name.
The --mount-add flag takes the same parameters as the --mount flag on service create. Refer to the volumes and bind mounts section in the service create reference for details.
The --mount-rm flag takes the target path of the mount.
$ docker service create \ --name=myservice \ --mount type=volume,source=test-data,target=/somewhere \ nginx:alpine myservice $ docker service update \ --mount-add type=volume,source=other-volume,target=/somewhere-else \ myservice myservice $ docker service update --mount-rm /somewhere myservice myservice
Use the --publish-add or --publish-rm flags to add or remove a published port for a service. You can use the short or long syntax discussed in the docker service create reference.
The following example adds a published service port to an existing service.
$ docker service update \ --publish-add published=8080,target=80 \ myservice
Use the --network-add or --network-rm flags to add or remove a network for a service. You can use the short or long syntax discussed in the docker service create reference.
The following example adds a new alias name to an existing service already connected to network my-network:
$ docker service update \ --network-rm my-network \ --network-add name=my-network,alias=web1 \ myservice
Use the --rollback option to roll back to the previous version of the service.
This will revert the service to the configuration that was in place before the most recent docker service update command.
The following example updates the number of replicas for the service from 4 to 5, and then rolls back to the previous configuration.
$ docker service update --replicas=5 web web $ docker service ls ID NAME MODE REPLICAS IMAGE 80bvrzp6vxf3 web replicated 0/5 nginx:alpine
The following example rolls back the web service:
$ docker service update --rollback web web $ docker service ls ID NAME MODE REPLICAS IMAGE 80bvrzp6vxf3 web replicated 0/4 nginx:alpine
Other options can be combined with --rollback as well, for example, --update-delay 0s to execute the rollback without a delay between tasks:
$ docker service update \ --rollback \ --update-delay 0s web web
Services can also be set up to roll back to the previous version automatically when an update fails. To set up a service for automatic rollback, use --update-failure-action=rollback. A rollback will be triggered if the fraction of the tasks which failed to update successfully exceeds the value given with --update-max-failure-ratio.
The rate, parallelism, and other parameters of a rollback operation are determined by the values passed with the following flags:
--rollback-delay--rollback-failure-action--rollback-max-failure-ratio--rollback-monitor--rollback-parallelismFor example, a service set up with --update-parallelism 1 --rollback-parallelism 3 will update one task at a time during a normal update, but during a rollback, 3 tasks at a time will get rolled back. These rollback parameters are respected both during automatic rollbacks and for rollbacks initiated manually using --rollback.
Use the --secret-add or --secret-rm options add or remove a service's secrets.
The following example adds a secret named ssh-2 and removes ssh-1:
$ docker service update \ --secret-add source=ssh-2,target=ssh-2 \ --secret-rm ssh-1 \ myservice
Some flags of service update support the use of templating. See service create for the reference.
service update supports the same --isolation flag as service create See service create for the reference.
When a service is created as a job, by setting its mode to replicated-job or to global-job when doing service create, options for updating it are limited.
Updating a Job immediately stops any Tasks that are in progress. The operation creates a new set of Tasks for the job and effectively resets its completion status. If any Tasks were running before the update, they are stopped, and new Tasks are created.
Jobs cannot be rolled out or rolled back. None of the flags for configuring update or rollback settings are valid with job modes.
To run a job again with the same parameters that it was run previously, it can be force updated with the --force flag.