summaryrefslogtreecommitdiff
path: root/docs
diff options
context:
space:
mode:
authorOpenShift Merge Robot <openshift-merge-robot@users.noreply.github.com>2019-07-15 21:57:52 +0200
committerGitHub <noreply@github.com>2019-07-15 21:57:52 +0200
commitd2291ecdd514befd18a8b57ff2c7a8ef0cf04ba8 (patch)
tree602b422fd8ad2b35211cf5a3c4cc70b9c4912199 /docs
parenta28f8dbecd2a28c6e4e2ea2aa95b75dda4b0adb4 (diff)
parente4cba7d36a49353febfefcb25d2d820bc89e9d1b (diff)
downloadpodman-d2291ecdd514befd18a8b57ff2c7a8ef0cf04ba8.tar.gz
podman-d2291ecdd514befd18a8b57ff2c7a8ef0cf04ba8.tar.bz2
podman-d2291ecdd514befd18a8b57ff2c7a8ef0cf04ba8.zip
Merge pull request #3574 from stefanb2/topic-health-cmd-parsing
Improve parser for --healthcheck-command
Diffstat (limited to 'docs')
-rw-r--r--docs/podman-create.1.md5
-rw-r--r--docs/podman-run.1.md5
2 files changed, 8 insertions, 2 deletions
diff --git a/docs/podman-create.1.md b/docs/podman-create.1.md
index 87e18dbb9..ea01a346c 100644
--- a/docs/podman-create.1.md
+++ b/docs/podman-create.1.md
@@ -272,12 +272,15 @@ The following example maps uids 0-2000 in the container to the uids 30000-31999
Add additional groups to run as
-**--healthcheck-command**=*command*
+**--healthcheck-command**=*"command"* | *'["command", "arg1", ...]'*
Set or alter a healthcheck command for a container. The command is a command to be executed inside your
container that determines your container health. The command is required for other healthcheck options
to be applied. A value of `none` disables existing healthchecks.
+Multiple options can be passed in the form of a JSON array; otherwise, the command will be interpreted
+as an argument to `/bin/sh -c`.
+
**--healthcheck-interval**=*interval*
Set an interval for the healthchecks (a value of `disable` results in no automatic timer setup) (default "30s")
diff --git a/docs/podman-run.1.md b/docs/podman-run.1.md
index 95499edd6..e3dca9300 100644
--- a/docs/podman-run.1.md
+++ b/docs/podman-run.1.md
@@ -279,12 +279,15 @@ The example maps gids 0-2000 in the container to the gids 30000-31999 on the hos
Add additional groups to run as
-**--healthcheck-command**=*command*
+**--healthcheck-command**=*"command"* | *'["command", "arg1", ...]'*
Set or alter a healthcheck command for a container. The command is a command to be executed inside your
container that determines your container health. The command is required for other healthcheck options
to be applied. A value of `none` disables existing healthchecks.
+Multiple options can be passed in the form of a JSON array; otherwise, the command will be interpreted
+as an argument to `/bin/sh -c`.
+
**--healthcheck-interval**=*interval*
Set an interval for the healthchecks (a value of `disable` results in no automatic timer setup) (default "30s")