aboutsummaryrefslogtreecommitdiff
path: root/docs/source
diff options
context:
space:
mode:
authorOpenShift Merge Robot <openshift-merge-robot@users.noreply.github.com>2022-09-09 15:17:19 +0200
committerGitHub <noreply@github.com>2022-09-09 15:17:19 +0200
commit7e7db23dbf163837ba3216fea09b31d2c8409fb3 (patch)
treeae14de85a086738fa1bcdb24b06506bea72b4f7b /docs/source
parentb239966d11cd7b5f7d8c84190c579afc093bc3bf (diff)
parentaad29e759c78b415a3b0393d7aba2bddbbc0cd3e (diff)
downloadpodman-7e7db23dbf163837ba3216fea09b31d2c8409fb3.tar.gz
podman-7e7db23dbf163837ba3216fea09b31d2c8409fb3.tar.bz2
podman-7e7db23dbf163837ba3216fea09b31d2c8409fb3.zip
Merge pull request #15687 from vrothberg/RUN-1639
health check: add on-failure actions
Diffstat (limited to 'docs/source')
-rw-r--r--docs/source/markdown/options/health-on-failure.md8
-rw-r--r--docs/source/markdown/podman-create.1.md.in2
-rw-r--r--docs/source/markdown/podman-run.1.md.in2
3 files changed, 12 insertions, 0 deletions
diff --git a/docs/source/markdown/options/health-on-failure.md b/docs/source/markdown/options/health-on-failure.md
new file mode 100644
index 000000000..c25a1c574
--- /dev/null
+++ b/docs/source/markdown/options/health-on-failure.md
@@ -0,0 +1,8 @@
+#### **--health-on-failure**=*action*
+
+Action to take once the container transitions to an unhealthy state. The default is **none**.
+
+- **none**: Take no action.
+- **kill**: Kill the container.
+- **restart**: Restart the container. Do not combine the `restart` action with the `--restart` flag. When running inside of a systemd unit, consider using the `kill` or `stop` action instead to make use of systemd's restart policy.
+- **stop**: Stop the container.
diff --git a/docs/source/markdown/podman-create.1.md.in b/docs/source/markdown/podman-create.1.md.in
index a20aeafcd..f74429848 100644
--- a/docs/source/markdown/podman-create.1.md.in
+++ b/docs/source/markdown/podman-create.1.md.in
@@ -185,6 +185,8 @@ Read in a line delimited file of environment variables. See **Environment** note
@@option health-interval
+@@option health-on-failure
+
@@option health-retries
@@option health-start-period
diff --git a/docs/source/markdown/podman-run.1.md.in b/docs/source/markdown/podman-run.1.md.in
index 2bb3098e2..86066ad9c 100644
--- a/docs/source/markdown/podman-run.1.md.in
+++ b/docs/source/markdown/podman-run.1.md.in
@@ -221,6 +221,8 @@ Read in a line delimited file of environment variables. See **Environment** note
@@option health-interval
+@@option health-on-failure
+
@@option health-retries
@@option health-start-period