moby/docs/reference/api
Aaron Lehmann 6d4b527699 Service update failure thresholds and rollback
This adds support for two enhancements to swarm service rolling updates:

- Failure thresholds: In Docker 1.12, a service update could be set up
  to either pause or continue after a single failure occurs. This adds
  an --update-max-failure-ratio flag that controls how many tasks need to
  fail to update for the update as a whole to be considered a failure. A
  counterpart flag, --update-monitor, controls how long to monitor each
  task for a failure after starting it during the update.

- Rollback flag: service update --rollback reverts the service to its
  previous version. If a service update encounters task failures, or
  fails to function properly for some other reason, the user can roll back
  the update.

SwarmKit also has the ability to roll back updates automatically after
hitting the failure thresholds, but we've decided not to expose this in
the Docker API/CLI for now, favoring a workflow where the decision to
roll back is always made by an admin. Depending on user feedback, we may
add a "rollback" option to --update-failure-action in the future.

Signed-off-by: Aaron Lehmann <aaron.lehmann@docker.com>
2016-10-18 10:09:50 -07:00
..
_static retooling for hugo 2015-06-15 13:19:38 -07:00
images Implemet docker update command 2015-12-28 19:19:26 +08:00
docker-io_api.md Convert Markdown frontmatter to YAML 2016-10-14 15:44:55 -07:00
docker_io_accounts_api.md Convert Markdown frontmatter to YAML 2016-10-14 15:44:55 -07:00
docker_remote_api.md Service update failure thresholds and rollback 2016-10-18 10:09:50 -07:00
docker_remote_api_v1.18.md Improve API format examples 2016-10-16 19:54:08 -07:00
docker_remote_api_v1.19.md Improve API format examples 2016-10-16 19:54:08 -07:00
docker_remote_api_v1.20.md Improve API format examples 2016-10-16 19:54:08 -07:00
docker_remote_api_v1.21.md Improve API format examples 2016-10-16 19:54:08 -07:00
docker_remote_api_v1.22.md Improve API format examples 2016-10-16 19:54:08 -07:00
docker_remote_api_v1.23.md Improve API format examples 2016-10-16 19:54:08 -07:00
docker_remote_api_v1.24.md Improve API format examples 2016-10-16 19:54:08 -07:00
docker_remote_api_v1.25.md Service update failure thresholds and rollback 2016-10-18 10:09:50 -07:00
hub_registry_spec.md Convert Markdown frontmatter to YAML 2016-10-14 15:44:55 -07:00
index.md Convert Markdown frontmatter to YAML 2016-10-14 15:44:55 -07:00
README.md Convert Markdown frontmatter to YAML 2016-10-14 15:44:55 -07:00
remote_api_client_libraries.md Convert Markdown frontmatter to YAML 2016-10-14 15:44:55 -07:00

published
false

This directory holds the authoritative specifications of APIs defined and implemented by Docker. Currently this includes:

  • The remote API by which a docker node can be queried over HTTP
  • The registry API by which a docker node can download and upload images for storage and sharing
  • The index search API by which a docker node can search the public index for images to download
  • The docker.io OAuth and accounts API which 3rd party services can use to access account information