mirror of https://github.com/docker/cli.git
Merge pull request #5509 from austinvazquez/cherry-pick-2f2b16a96687e50682497435a6de3b016ab1a5bc-to-27.x
[27.x backport] docs: fix inaccurate description of --restart=unless-stopped
This commit is contained in:
commit
011cb195f0
|
@ -1157,12 +1157,12 @@ Use the `--restart` flag to specify a container's *restart policy*. A restart
|
||||||
policy controls whether the Docker daemon restarts a container after exit.
|
policy controls whether the Docker daemon restarts a container after exit.
|
||||||
Docker supports the following restart policies:
|
Docker supports the following restart policies:
|
||||||
|
|
||||||
| Policy | Result |
|
| Flag | Description |
|
||||||
|:---------------------------|:-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
|
| :------------------------- | :-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
|
||||||
| `no` | Do not automatically restart the container when it exits. This is the default. |
|
| `no` | Don't automatically restart the container. (Default) |
|
||||||
| `on-failure[:max-retries]` | Restart only if the container exits with a non-zero exit status. Optionally, limit the number of restart 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. The `on-failure` policy only prompts a restart if the container exits with a failure. It doesn't restart the container if the daemon restarts. |
|
||||||
| `unless-stopped` | Restart the container unless it's explicitly stopped or Docker itself is stopped or restarted. |
|
| `always` | Always restart the container if it stops. If it's manually stopped, it's restarted only when Docker daemon restarts or the container itself is manually restarted. |
|
||||||
| `always` | Always restart the container regardless of the exit status. When you specify always, the Docker daemon tries to restart the container indefinitely. The container always starts on daemon startup, regardless of the current state of the container. |
|
| `unless-stopped` | Similar to `always`, except that when the container is stopped (manually or otherwise), it isn't restarted even after Docker daemon restarts. |
|
||||||
|
|
||||||
```console
|
```console
|
||||||
$ docker run --restart=always redis
|
$ docker run --restart=always redis
|
||||||
|
|
Loading…
Reference in New Issue