summaryrefslogtreecommitdiff
path: root/docs
diff options
context:
space:
mode:
authorMatthew Heon <matthew.heon@pm.me>2019-04-01 19:38:03 -0400
committerMatthew Heon <matthew.heon@pm.me>2019-05-03 10:36:16 -0400
commit357e4c37e92e7426a66f1a1142a9650bb0d81ca0 (patch)
tree458322efca0c1d741b9f21b0a6d3f6bb800bd3be /docs
parentf4db6d5cf61741f9b0de163b158ecdc2bcfa6669 (diff)
downloadpodman-357e4c37e92e7426a66f1a1142a9650bb0d81ca0.tar.gz
podman-357e4c37e92e7426a66f1a1142a9650bb0d81ca0.tar.bz2
podman-357e4c37e92e7426a66f1a1142a9650bb0d81ca0.zip
Add manpage information for restart policy
Signed-off-by: Matthew Heon <matthew.heon@pm.me>
Diffstat (limited to 'docs')
-rw-r--r--docs/podman-create.1.md14
-rw-r--r--docs/podman-run.1.md14
2 files changed, 20 insertions, 8 deletions
diff --git a/docs/podman-create.1.md b/docs/podman-create.1.md
index 6d7d983b6..abdfe9f8b 100644
--- a/docs/podman-create.1.md
+++ b/docs/podman-create.1.md
@@ -567,11 +567,17 @@ If container is running in --read-only mode, then mount a read-write tmpfs on /r
**--restart=""**
-Not implemented.
+Restart policy to follow when containers exit.
+Restart policy will not take effect if a container is stopped via the `podman kill` or `podman stop` commands.
+Valid values are:
-Restart should be handled via a systemd unit files. Please add your podman
-commands to a unit file and allow systemd or your init system to handle the
-restarting of the container processes. See example below.
+- `no` : Do not restart containers on exit
+- `on-failure[:max_retries]` : Restart containers when they exit with a non-0 exit code, retrying indefinitely or until the optional max_retries count is hit
+- `always` : Restart containers when they exit, regardless of status, retrying indefinitely
+
+Please note that restart will not restart containers after a system reboot.
+If you require this functionality, please add your Podman commands to a systemd unit file, or create an init script for your init system of choice.
+There is an example of restarting a container with systemd below.
**--rm**=*true*|*false*
diff --git a/docs/podman-run.1.md b/docs/podman-run.1.md
index 9efb7f51c..078e388ea 100644
--- a/docs/podman-run.1.md
+++ b/docs/podman-run.1.md
@@ -589,11 +589,17 @@ If container is running in --read-only mode, then mount a read-write tmpfs on /r
**--restart=""**
-Not implemented.
+Restart policy to follow when containers exit.
+Restart policy will not take effect if a container is stopped via the `podman kill` or `podman stop` commands.
+Valid values are:
-Restart should be handled via a systemd unit files. Please add your podman
-commands to a unit file and allow systemd or your init system to handle the
-restarting of the container processes. See *podman generate systemd*.
+- `no` : Do not restart containers on exit
+- `on-failure[:max_retries]` : Restart containers when they exit with a non-0 exit code, retrying indefinitely or until the optional max_retries count is hit
+- `always` : Restart containers when they exit, regardless of status, retrying indefinitely
+
+Please note that restart will not restart containers after a system reboot.
+If you require this functionality, please add your Podman commands to a systemd unit file, or create an init script for your init system of choice.
+To manage container restart via systemd, see *podman generate systemd*.
**--rm**=*true*|*false*