Guest24897
/
DockerCLI
mirror of https://github.com/docker/cli.git
1
0
Fork 0
Code Issues Packages Projects Releases Wiki Activity

Docs: add restart-policies to 'Run reference' 

This moves some information on restart-policies from
the "command line" page to "run reference".

Also fixes some minor typos and adds a "NOTE"
about --rm and --restart not allowed to be combined.

Also removes inline CSS styles from tables,
which will be styled by the stylesheet, and fixes
some minor MarkDown errors (`<` -> &lt;)

depends on https://github.com/docker/docs-base/pull/1

resolves #11069

Signed-off-by: Sebastiaan van Stijn <github@gone.nl>
This commit is contained in:
Sebastiaan van Stijn 2015-03-01 21:13:33 +01:00 committed by Tibor Vass
parent d69dea3c44
commit 99a47ff600
2 changed files with 157 additions and 50 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

75
docs/sources/reference/commandline/cli.md
View File

@ -1931,41 +1931,56 @@ application change:
#### Restart Policies #### Restart Policies
Using the `--restart` flag on Docker run you can specify a restart policy for Use Docker's `--restart` to specify a container's *restart policy*. A restart
how a container should or should not be restarted on exit. policy controls whether the Docker daemon restarts a container after exit.
Docker supports the following restart policies:
An ever increasing delay (double the previous delay, starting at 100 milliseconds) <table>
is added before each restart to prevent flooding the server. This means the daemaon <thead>
will wait for 100 mS, then 200 mS, 400, 800, 1600, and so on until either the <tr>
`on-failure` limit is hit, or when you `docker stop` or even `docker rm -f` <th>Policy</th>
the container. <th>Result</th>
</tr>
When a restart policy is active on a container, it will be shown in `docker ps` </thead>
as either `Up` or `Restarting` in `docker ps`. It can also be useful to use <tbody>
`docker events` to see the restart policy in effect. <tr>
<td><strong>no</strong></td>
** no ** - Do not restart the container when it exits. <td>
Do not automatically restart the container when it exits. This is the
** on-failure ** - Restart the container only if it exits with a non zero exit status. default.
</td>
** always ** - Always restart the container regardless of the exit status. </tr>
<tr>
You can also specify the maximum amount of times Docker will try to <td>
restart the container when using the ** on-failure ** policy. The <span style="white-space: nowrap">
default is that Docker will try forever to restart the container. <strong>on-failure</strong>[:max-retries]
</span>
</td>
<td>
Restart only if the container exits with a non-zero exit status.
Optionally, limit the number of restart retries the Docker
daemon attempts.
</td>
</tr>
<tr>
<td><strong>always</strong></td>
<td>
Always restart the container regardless of the exit status.
When you specify always, the Docker daemon will try to restart
the container indefinitely.
</td>
</tr>
</tbody>
</table>
$ sudo docker run --restart=always redis $ sudo docker run --restart=always redis
This will run the `redis` container with a restart policy of ** always ** so that if This will run the `redis` container with a restart policy of **always**
the container exits, Docker will restart it. so that if the container exits, Docker will restart it.
$ sudo docker run --restart=on-failure:10 redis More detailed information on restart policies can be found in the
[Restart Policies (--restart)](/reference/run/#restart-policies-restart) section
This will run the `redis` container with a restart policy of ** of the Docker run reference page.
on-failure ** and a maximum restart count of 10. If the `redis`
container exits with a non-zero exit status more than 10 times in a row
Docker will abort trying to restart the container. Providing a maximum
restart limit is only valid for the ** on-failure ** policy.
### Adding entries to a container hosts file ### Adding entries to a container hosts file

128
docs/sources/reference/run.md
View File

@ -52,6 +52,7 @@ following options.
- [PID Equivalent](#pid-equivalent) - [PID Equivalent](#pid-equivalent)
- [IPC Settings](#ipc-settings) - [IPC Settings](#ipc-settings)
- [Network Settings](#network-settings) - [Network Settings](#network-settings)
- [Restart Policies<br />(--restart)](#restart-policies-restart)
- [Clean Up (--rm)](#clean-up-rm) - [Clean Up (--rm)](#clean-up-rm)
- [Runtime Constraints on CPU and Memory](#runtime-constraints-on-cpu-and-memory) - [Runtime Constraints on CPU and Memory](#runtime-constraints-on-cpu-and-memory)
- [Runtime Privilege, Linux Capabilities, and LXC Configuration](#runtime-privilege-linux-capabilities-and-lxc-configuration) - [Runtime Privilege, Linux Capabilities, and LXC Configuration](#runtime-privilege-linux-capabilities-and-lxc-configuration)
@ -256,6 +257,99 @@ container itself as well as `localhost` and a few other common things. The
::1 localhost ip6-localhost ip6-loopback ::1 localhost ip6-localhost ip6-loopback
86.75.30.9 db-static 86.75.30.9 db-static
## Restart policies (--restart)
Using the `--restart` flag on Docker run you can specify a restart policy for
how a container should or should not be restarted on exit.
When a restart policy is active on a container, it will be shown as either `Up`
or `Restarting` in [`docker ps`](/reference/commandline/cli/#ps). It can also be
useful to use [`docker events`](/reference/commandline/cli/#events) to see the
restart policy in effect.
Docker supports the following restart policies:
<table>
<thead>
<tr>
<th>Policy</th>
<th>Result</th>
</tr>
</thead>
<tbody>
<tr>
<td><strong>no</strong></td>
<td>
Do not automatically restart the container when it exits. This is the
default.
</td>
</tr>
<tr>
<td>
<span style="white-space: nowrap">
<strong>on-failure</strong>[:max-retries]
</span>
</td>
<td>
Restart only if the container exits with a non-zero exit status.
Optionally, limit the number of restart retries the Docker
daemon attempts.
</td>
</tr>
<tr>
<td><strong>always</strong></td>
<td>
Always restart the container regardless of the exit status.
When you specify always, the Docker daemon will try to restart
the container indefinitely.
</td>
</tr>
</tbody>
</table>
An ever increasing delay (double the previous delay, starting at 100
milliseconds) is added before each restart to prevent flooding the server.
This means the daemon will wait for 100 ms, then 200 ms, 400, 800, 1600,
and so on until either the `on-failure` limit is hit, or when you `docker stop`
or `docker rm -f` the container.
If a container is succesfully restarted (the container is started and runs
for at least 10 seconds), the delay is reset to its default value of 100 ms.
You can specify the maximum amount of times Docker will try to restart the
container when using the **on-failure** policy. The default is that Docker
will try forever to restart the container. The number of (attempted) restarts
for a container can be obtained via [`docker inspect`](
/reference/commandline/cli/#inspect). For example, to get the number of restarts
for container "my-container";
$ sudo docker inspect -f "{{ .RestartCount }}" my-container
# 2
Or, to get the last time the container was (re)started;
$ docker inspect -f "{{ .State.StartedAt }}" my-container
# 2015-03-04T23:47:07.691840179Z
You cannot set any restart policy in combination with
["clean up (--rm)"](#clean-up-rm). Setting both `--restart` and `--rm`
results in an error.
###Examples
$ sudo docker run --restart=always redis
This will run the `redis` container with a restart policy of **always**
so that if the container exits, Docker will restart it.
$ sudo docker run --restart=on-failure:10 redis
This will run the `redis` container with a restart policy of **on-failure**
and a maximum restart count of 10. If the `redis` container exits with a
non-zero exit status more than 10 times in a row Docker will abort trying to
restart the container. Providing a maximum restart limit is only valid for the
**on-failure** policy.
## Clean up (--rm) ## Clean up (--rm)
By default a container's file system persists even after the container By default a container's file system persists even after the container
@ -317,15 +411,15 @@ We have four ways to set memory usage:
- memory=inf, memory-swap=inf (not specify any of them) - memory=inf, memory-swap=inf (not specify any of them)
There is no memory limit, you can use as much as you want. There is no memory limit, you can use as much as you want.
- memory=L<inf, memory-swap=inf (specify memory and set memory-swap as `-1`) - memory=L&lt;inf, memory-swap=inf (specify memory and set memory-swap as `-1`)
It is not allowed to use more than L bytes of memory, but use as much swap It is not allowed to use more than L bytes of memory, but use as much swap
as you want (only if the host supports swap memory). as you want (only if the host supports swap memory).
- memory=L<inf, memory-swap=2*L (specify memory without memory-swap) - memory=L&lt;inf, memory-swap=2*L (specify memory without memory-swap)
It is not allowed to use more than L bytes of memory, swap *plus* memory It is not allowed to use more than L bytes of memory, swap *plus* memory
usage is double of that. usage is double of that.
- memory=L<inf, memory-swap=S<inf, L<=S (specify both memory and memory-swap) - memory=L&lt;inf, memory-swap=S&lt;inf, L&lt;=S (specify both memory and memory-swap)
It is not allowed to use more than L bytes of memory, swap *plus* memory It is not allowed to use more than L bytes of memory, swap *plus* memory
usage is limited by S. usage is limited by S.
@ -556,34 +650,32 @@ client container to help indicate which interface and port to use.
When a new container is created, Docker will set the following environment When a new container is created, Docker will set the following environment
variables automatically: variables automatically:
<table width=100%> <table>
<tr style="background-color:#C0C0C0"> <tr>
<td> <b>Variable</b> </td> <th>Variable</th>
<td style="padding-left:10px"> <b>Value</b> </td> <th>Value</th>
</tr> </tr>
<tr> <tr>
<td><code>HOME</code></td> <td><code>HOME</code></td>
<td style="padding-left:10px"> <td>
Set based on the value of <code>USER</code> Set based on the value of <code>USER</code>
</td> </td>
</tr> </tr>
<tr style="background-color:#E8E8E8"> <tr>
<td valign=top> <code>HOSTNAME</code> </td> <td><code>HOSTNAME</code></td>
<td style="padding-left:10px"> <td>
The hostname associated with the container The hostname associated with the container
</td> </td>
</tr> </tr>
<tr> <tr>
<td valign=top> <code>PATH</code> </td> <td><code>PATH</code></td>
<td style="padding-left:10px"> <td>
Includes popular directories, such as :<br> Includes popular directories, such as :<br>
<code>/usr/local/sbin:/usr/local/bin:/usr/sbin:/usr/bin:/sbin:/bin</code> <code>/usr/local/sbin:/usr/local/bin:/usr/sbin:/usr/bin:/sbin:/bin</code>
</td> </td>
<tr style="background-color:#E8E8E8"> <tr>
<td valign=top> <code>TERM</code> </td> <td><code>TERM</code></td>
<td style="padding-left:10px"> <td><code>xterm</code> if the container is allocated a psuedo-TTY</td>
<code>xterm</code> if the container is allocated a psuedo-TTY
</td>
</tr> </tr>
</table> </table>