Merge pull request #13894 from usha-mandya/max-retries-format

Clarify the max-retries option
This commit is contained in:
Usha Mandya 2021-11-26 16:16:43 +00:00 committed by GitHub
commit 2477a2a449
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
1 changed files with 1 additions and 1 deletions

View File

@ -27,7 +27,7 @@ any of the following:
| Flag | Description |
|:-----------------|:------------------------------------------------------------------------------------------------|
| `no` | Do not automatically restart the container. (the default) |
| `on-failure`(optional:`max-retries`) | Restart the container if it exits due to an error, which manifests as a non-zero exit code. Optionally, limit the number of retries the Docker daemon attempts. |
| `on-failure[:max-retries]` | Restart the container if it exits due to an error, which manifests as a non-zero exit code. Optionally, limit the number of times the Docker daemon attempts to restart the container using the `:max-retries` option. |
| `always` | Always restart the container if it stops. If it is manually stopped, it is restarted only when Docker daemon restarts or the container itself is manually restarted. (See the second bullet listed in [restart policy details](#restart-policy-details)) |
| `unless-stopped` | Similar to `always`, except that when the container is stopped (manually or otherwise), it is not restarted even after Docker daemon restarts. |