mirror of https://github.com/docker/cli.git
Add support for rollback flags
Signed-off-by: Aaron Lehmann <aaron.lehmann@docker.com>
This commit is contained in:
Aaron Lehmann
Tibor Vass
parent
8271c2a624
commit
33ae729456
|
|
@ -21,54 +21,61 @@ Usage: docker service create [OPTIONS] IMAGE [COMMAND] [ARG...]
|
||||||
Create a new service
|
Create a new service
|
||||||
|
|
||||||
Options:
|
Options:
|
||||||
--constraint list Placement constraints (default [])
|
--constraint list Placement constraints (default [])
|
||||||
--container-label list Container labels (default [])
|
--container-label list Container labels (default [])
|
||||||
--dns list Set custom DNS servers (default [])
|
--dns list Set custom DNS servers (default [])
|
||||||
--dns-option list Set DNS options (default [])
|
--dns-option list Set DNS options (default [])
|
||||||
--dns-search list Set custom DNS search domains (default [])
|
--dns-search list Set custom DNS search domains (default [])
|
||||||
--endpoint-mode string Endpoint mode ("vip"|"dnsrr") (default "vip")
|
--endpoint-mode string Endpoint mode ("vip"|"dnsrr") (default "vip")
|
||||||
-e, --env list Set environment variables (default [])
|
-e, --env list Set environment variables (default [])
|
||||||
--env-file list Read in a file of environment variables (default [])
|
--env-file list Read in a file of environment variables (default [])
|
||||||
--group list Set one or more supplementary user groups for the container (default [])
|
--group list Set one or more supplementary user groups for the container (default [])
|
||||||
--health-cmd string Command to run to check health
|
--health-cmd string Command to run to check health
|
||||||
--health-interval duration Time between running the check (ns|us|ms|s|m|h)
|
--health-interval duration Time between running the check (ns|us|ms|s|m|h)
|
||||||
--health-retries int Consecutive failures needed to report unhealthy
|
--health-retries int Consecutive failures needed to report unhealthy
|
||||||
--health-timeout duration Maximum time to allow one check to run (ns|us|ms|s|m|h)
|
--health-timeout duration Maximum time to allow one check to run (ns|us|ms|s|m|h)
|
||||||
--help Print usage
|
--help Print usage
|
||||||
--host list Set one or more custom host-to-IP mappings (host:ip) (default [])
|
--host list Set one or more custom host-to-IP mappings (host:ip) (default [])
|
||||||
--hostname string Container hostname
|
--hostname string Container hostname
|
||||||
-l, --label list Service labels (default [])
|
-l, --label list Service labels (default [])
|
||||||
--limit-cpu decimal Limit CPUs (default 0.000)
|
--limit-cpu decimal Limit CPUs (default 0.000)
|
||||||
--limit-memory bytes Limit Memory
|
--limit-memory bytes Limit Memory
|
||||||
--log-driver string Logging driver for service
|
--log-driver string Logging driver for service
|
||||||
--log-opt list Logging driver options (default [])
|
--log-opt list Logging driver options (default [])
|
||||||
--mode string Service mode (replicated or global) (default "replicated")
|
--mode string Service mode (replicated or global) (default "replicated")
|
||||||
--mount mount Attach a filesystem mount to the service
|
--mount mount Attach a filesystem mount to the service
|
||||||
--name string Service name
|
--name string Service name
|
||||||
--network list Network attachments (default [])
|
--network list Network attachments (default [])
|
||||||
--no-healthcheck Disable any container-specified HEALTHCHECK
|
--no-healthcheck Disable any container-specified HEALTHCHECK
|
||||||
--placement-pref pref Add a placement preference
|
--placement-pref pref Add a placement preference
|
||||||
-p, --publish port Publish a port as a node port
|
-p, --publish port Publish a port as a node port
|
||||||
--read-only Mount the container's root filesystem as read only
|
--read-only Mount the container's root filesystem as read only
|
||||||
--replicas uint Number of tasks
|
--replicas uint Number of tasks
|
||||||
--reserve-cpu decimal Reserve CPUs (default 0.000)
|
--reserve-cpu decimal Reserve CPUs (default 0.000)
|
||||||
--reserve-memory bytes Reserve Memory
|
--reserve-memory bytes Reserve Memory
|
||||||
--restart-condition string Restart when condition is met ("none"|"on-failure"|"any")
|
--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-delay duration Delay between restart attempts (ns|us|ms|s|m|h)
|
||||||
--restart-max-attempts uint Maximum number of restarts before giving up
|
--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)
|
--restart-window duration Window used to evaluate the restart policy (ns|us|ms|s|m|h)
|
||||||
--secret secret Specify secrets to expose to the service
|
--rollback-delay duration Delay between task rollbacks (ns|us|ms|s|m|h) (default 0s)
|
||||||
--stop-grace-period duration Time to wait before force killing a container (ns|us|ms|s|m|h)
|
--rollback-failure-action string Action on rollback failure ("pause"|"continue") (default "pause")
|
||||||
--stop-signal string Signal to stop the container
|
--rollback-max-failure-ratio float Failure rate to tolerate during a rollback
|
||||||
-t, --tty Allocate a pseudo-TTY
|
--rollback-monitor duration Duration after each task rollback to monitor for failure
|
||||||
--update-delay duration Delay between updates (ns|us|ms|s|m|h) (default 0s)
|
(ns|us|ms|s|m|h) (default 0s)
|
||||||
--update-failure-action string Action on update failure ("pause"|"continue"|"rollback") (default "pause")
|
--rollback-parallelism uint Maximum number of tasks rolled back simultaneously (0 to roll
|
||||||
--update-max-failure-ratio float Failure rate to tolerate during an update
|
back all at once) (default 1)
|
||||||
--update-monitor duration Duration after each task update to monitor for failure (ns|us|ms|s|m|h) (default 0s)
|
--secret secret Specify secrets to expose to the service
|
||||||
--update-parallelism uint Maximum number of tasks updated simultaneously (0 to update all at once) (default 1)
|
--stop-grace-period duration Time to wait before force killing a container (ns|us|ms|s|m|h)
|
||||||
-u, --user string Username or UID (format: <name|uid>[:<group|gid>])
|
--stop-signal string Signal to stop the container
|
||||||
--with-registry-auth Send registry authentication details to swarm agents
|
-t, --tty Allocate a pseudo-TTY
|
||||||
-w, --workdir string Working directory inside the container
|
--update-delay duration Delay between updates (ns|us|ms|s|m|h) (default 0s)
|
||||||
|
--update-failure-action string Action on update failure ("pause"|"continue"|"rollback") (default "pause")
|
||||||
|
--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) (default 0s)
|
||||||
|
--update-parallelism uint Maximum number of tasks updated simultaneously (0 to update all at once) (default 1)
|
||||||
|
-u, --user string Username or UID (format: <name|uid>[:<group|gid>])
|
||||||
|
--with-registry-auth Send registry authentication details to swarm agents
|
||||||
|
-w, --workdir string Working directory inside the container
|
||||||
```
|
```
|
||||||
|
|
||||||
## Description
|
## Description
|
||||||
|
|
|
||||||
|
|
@ -21,67 +21,74 @@ Usage: docker service update [OPTIONS] SERVICE
|
||||||
Update a service
|
Update a service
|
||||||
|
|
||||||
Options:
|
Options:
|
||||||
--args string Service command args
|
--args string Service command args
|
||||||
--constraint-add list Add or update a placement constraint (default [])
|
--constraint-add list Add or update a placement constraint (default [])
|
||||||
--constraint-rm list Remove a constraint (default [])
|
--constraint-rm list Remove a constraint (default [])
|
||||||
--container-label-add list Add or update a container label (default [])
|
--container-label-add list Add or update a container label (default [])
|
||||||
--container-label-rm list Remove a container label by its key (default [])
|
--container-label-rm list Remove a container label by its key (default [])
|
||||||
--dns-add list Add or update a custom DNS server (default [])
|
--dns-add list Add or update a custom DNS server (default [])
|
||||||
--dns-option-add list Add or update a DNS option (default [])
|
--dns-option-add list Add or update a DNS option (default [])
|
||||||
--dns-option-rm list Remove a DNS option (default [])
|
--dns-option-rm list Remove a DNS option (default [])
|
||||||
--dns-rm list Remove a custom DNS server (default [])
|
--dns-rm list Remove a custom DNS server (default [])
|
||||||
--dns-search-add list Add or update a custom DNS search domain (default [])
|
--dns-search-add list Add or update a custom DNS search domain (default [])
|
||||||
--dns-search-rm list Remove a DNS search domain (default [])
|
--dns-search-rm list Remove a DNS search domain (default [])
|
||||||
--endpoint-mode string Endpoint mode ("vip"|"dnsrr") (default "vip")
|
--endpoint-mode string Endpoint mode ("vip"|"dnsrr") (default "vip")
|
||||||
--env-add list Add or update an environment variable (default [])
|
--env-add list Add or update an environment variable (default [])
|
||||||
--env-rm list Remove an environment variable (default [])
|
--env-rm list Remove an environment variable (default [])
|
||||||
--force Force update even if no changes require it
|
--force Force update even if no changes require it
|
||||||
--group-add list Add an additional supplementary user group to the container (default [])
|
--group-add list Add an additional supplementary user group to the container (default [])
|
||||||
--group-rm list Remove a previously added supplementary user group from the container (default [])
|
--group-rm list Remove a previously added supplementary user group from the container (default [])
|
||||||
--health-cmd string Command to run to check health
|
--health-cmd string Command to run to check health
|
||||||
--health-interval duration Time between running the check (ns|us|ms|s|m|h)
|
--health-interval duration Time between running the check (ns|us|ms|s|m|h)
|
||||||
--health-retries int Consecutive failures needed to report unhealthy
|
--health-retries int Consecutive failures needed to report unhealthy
|
||||||
--health-timeout duration Maximum time to allow one check to run (ns|us|ms|s|m|h)
|
--health-timeout duration Maximum time to allow one check to run (ns|us|ms|s|m|h)
|
||||||
--help Print usage
|
--help Print usage
|
||||||
--host-add list Add or update a custom host-to-IP mapping (host:ip) (default [])
|
--host-add list Add or update a custom host-to-IP mapping (host:ip) (default [])
|
||||||
--host-rm list Remove a custom host-to-IP mapping (host:ip) (default [])
|
--host-rm list Remove a custom host-to-IP mapping (host:ip) (default [])
|
||||||
--hostname string Container hostname
|
--hostname string Container hostname
|
||||||
--image string Service image tag
|
--image string Service image tag
|
||||||
--label-add list Add or update a service label (default [])
|
--label-add list Add or update a service label (default [])
|
||||||
--label-rm list Remove a label by its key (default [])
|
--label-rm list Remove a label by its key (default [])
|
||||||
--limit-cpu decimal Limit CPUs (default 0.000)
|
--limit-cpu decimal Limit CPUs (default 0.000)
|
||||||
--limit-memory bytes Limit Memory
|
--limit-memory bytes Limit Memory
|
||||||
--log-driver string Logging driver for service
|
--log-driver string Logging driver for service
|
||||||
--log-opt list Logging driver options (default [])
|
--log-opt list Logging driver options (default [])
|
||||||
--mount-add mount Add or update a mount on a service
|
--mount-add mount Add or update a mount on a service
|
||||||
--mount-rm list Remove a mount by its target path (default [])
|
--mount-rm list Remove a mount by its target path (default [])
|
||||||
--no-healthcheck Disable any container-specified HEALTHCHECK
|
--no-healthcheck Disable any container-specified HEALTHCHECK
|
||||||
--placement-pref-add pref Add a placement preference
|
--placement-pref-add pref Add a placement preference
|
||||||
--placement-pref-rm pref Remove a placement preference
|
--placement-pref-rm pref Remove a placement preference
|
||||||
--publish-add port Add or update a published port
|
--publish-add port Add or update a published port
|
||||||
--publish-rm port Remove a published port by its target port
|
--publish-rm port Remove a published port by its target port
|
||||||
--read-only Mount the container's root filesystem as read only
|
--read-only Mount the container's root filesystem as read only
|
||||||
--replicas uint Number of tasks
|
--replicas uint Number of tasks
|
||||||
--reserve-cpu decimal Reserve CPUs (default 0.000)
|
--reserve-cpu decimal Reserve CPUs (default 0.000)
|
||||||
--reserve-memory bytes Reserve Memory
|
--reserve-memory bytes Reserve Memory
|
||||||
--restart-condition string Restart when condition is met ("none"|"on-failure"|"any")
|
--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-delay duration Delay between restart attempts (ns|us|ms|s|m|h)
|
||||||
--restart-max-attempts uint Maximum number of restarts before giving up
|
--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)
|
--restart-window duration Window used to evaluate the restart policy (ns|us|ms|s|m|h)
|
||||||
--rollback Rollback to previous specification
|
--rollback Rollback to previous specification
|
||||||
--secret-add secret Add or update a secret on a service
|
--rollback-delay duration Delay between task rollbacks (ns|us|ms|s|m|h) (default 0s)
|
||||||
--secret-rm list Remove a secret (default [])
|
--rollback-failure-action string Action on rollback failure ("pause"|"continue") (default "pause")
|
||||||
--stop-grace-period duration Time to wait before force killing a container (ns|us|ms|s|m|h)
|
--rollback-max-failure-ratio float Failure rate to tolerate during a rollback
|
||||||
--stop-signal string Signal to stop the container
|
--rollback-monitor duration Duration after each task rollback to monitor for failure
|
||||||
-t, --tty Allocate a pseudo-TTY
|
(ns|us|ms|s|m|h) (default 0s)
|
||||||
--update-delay duration Delay between updates (ns|us|ms|s|m|h) (default 0s)
|
--rollback-parallelism uint Maximum number of tasks rolled back simultaneously (0 to roll
|
||||||
--update-failure-action string Action on update failure ("pause"|"continue"|"rollback") (default "pause")
|
back all at once) (default 1)
|
||||||
--update-max-failure-ratio float Failure rate to tolerate during an update
|
--secret-add secret Add or update a secret on a service
|
||||||
--update-monitor duration Duration after each task update to monitor for failure (ns|us|ms|s|m|h) (default 0s)
|
--secret-rm list Remove a secret (default [])
|
||||||
--update-parallelism uint Maximum number of tasks updated simultaneously (0 to update all at once) (default 1)
|
--stop-grace-period duration Time to wait before force killing a container (ns|us|ms|s|m|h)
|
||||||
-u, --user string Username or UID (format: <name|uid>[:<group|gid>])
|
--stop-signal string Signal to stop the container
|
||||||
--with-registry-auth Send registry authentication details to swarm agents
|
-t, --tty Allocate a pseudo-TTY
|
||||||
-w, --workdir string Working directory inside the container
|
--update-delay duration Delay between updates (ns|us|ms|s|m|h) (default 0s)
|
||||||
|
--update-failure-action string Action on update failure ("pause"|"continue"|"rollback") (default "pause")
|
||||||
|
--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) (default 0s)
|
||||||
|
--update-parallelism uint Maximum number of tasks updated simultaneously (0 to update all at once) (default 1)
|
||||||
|
-u, --user string Username or UID (format: <name|uid>[:<group|gid>])
|
||||||
|
--with-registry-auth Send registry authentication details to swarm agents
|
||||||
|
-w, --workdir string Working directory inside the container
|
||||||
```
|
```
|
||||||
|
|
||||||
## Description
|
## Description
|
||||||
|
|
@ -202,6 +209,26 @@ 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-parallelism`
|
||||||
|
|
||||||
|
For 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`.
|
||||||
|
|
||||||
### Add or remove secrets
|
### Add or remove secrets
|
||||||
|
|
||||||
Use the `--secret-add` or `--secret-rm` options add or remove a service's
|
Use the `--secret-add` or `--secret-rm` options add or remove a service's
|
||||||
|
|
|
||||||
Loading…
Reference in New Issue