summaryrefslogtreecommitdiff
path: root/docs/podman-create.1.md
diff options
context:
space:
mode:
authorStefan Becker <chemobejk@gmail.com>2019-07-13 18:22:41 +0300
committerStefan Becker <chemobejk@gmail.com>2019-07-14 10:33:01 +0300
commite4cba7d36a49353febfefcb25d2d820bc89e9d1b (patch)
treeda0d158215568fba288cd1db6a059c57c82c5fc9 /docs/podman-create.1.md
parentc59d08bc77855c0d0d946fa44850a0bf03b102c9 (diff)
downloadpodman-e4cba7d36a49353febfefcb25d2d820bc89e9d1b.tar.gz
podman-e4cba7d36a49353febfefcb25d2d820bc89e9d1b.tar.bz2
podman-e4cba7d36a49353febfefcb25d2d820bc89e9d1b.zip
create: improve parser for --healthcheck-command
Fix Docker CLI compatibility issue: the "--healthcheck-command" option value should not be split but instead be passed as single string to "CMD-SHELL", i.e. "/bin/sh -c <opt>". On the other hand implement the same extension as is already available for "--entrypoint", i.e. allow the option value to be a JSON array of strings. This will make life easier for tools like podman-compose. Updated "--healthcheck-command" option values in tests accordingly. Continuation of #3455 & #3507 Signed-off-by: Stefan Becker <chemobejk@gmail.com>
Diffstat (limited to 'docs/podman-create.1.md')
-rw-r--r--docs/podman-create.1.md5
1 files changed, 4 insertions, 1 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")