summaryrefslogtreecommitdiff
path: root/docs/podman-create.1.md
diff options
context:
space:
mode:
authorHunor Csomortáni <csomh@redhat.com>2019-07-04 14:24:09 +0200
committerHunor Csomortáni <csomh@redhat.com>2019-07-16 06:15:28 +0200
commit3e53bfe36e385f6d85b10d1eadab0a249f580f97 (patch)
tree290cb9b711e1a4e72556f25adc277bc13f1555c7 /docs/podman-create.1.md
parent51c00eae8b22356e72c84601e8c4f88b739755c7 (diff)
downloadpodman-3e53bfe36e385f6d85b10d1eadab0a249f580f97.tar.gz
podman-3e53bfe36e385f6d85b10d1eadab0a249f580f97.tar.bz2
podman-3e53bfe36e385f6d85b10d1eadab0a249f580f97.zip
Make the healthcheck flags compatible with Docker CLI
Docker CLI calls the healthcheck flags "--health-*", instead of "--healthcheck-*". Introduce the former, in order to keep compatibility, and alias the later, in order to avoid breaking current usage. Change "--healthcheck-*" to "--health-*" in the docs and tests. Signed-off-by: Hunor Csomortáni <csomh@redhat.com>
Diffstat (limited to 'docs/podman-create.1.md')
-rw-r--r--docs/podman-create.1.md10
1 files changed, 5 insertions, 5 deletions
diff --git a/docs/podman-create.1.md b/docs/podman-create.1.md
index ea01a346c..89f146670 100644
--- a/docs/podman-create.1.md
+++ b/docs/podman-create.1.md
@@ -272,7 +272,7 @@ The following example maps uids 0-2000 in the container to the uids 30000-31999
Add additional groups to run as
-**--healthcheck-command**=*"command"* | *'["command", "arg1", ...]'*
+**--health-cmd**=*"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
@@ -281,20 +281,20 @@ 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*
+**--health-interval**=*interval*
Set an interval for the healthchecks (a value of `disable` results in no automatic timer setup) (default "30s")
-**--healthcheck-retries**=*retries*
+**--health-retries**=*retries*
The number of retries allowed before a healthcheck is considered to be unhealthy. The default value is `3`.
-**--healthcheck-start-period**=*period*
+**--health-start-period**=*period*
The initialization time needed for a container to bootstrap. The value can be expressed in time format like
`2m3s`. The default value is `0s`
-**--healthcheck-timeout**=*timeout*
+**--health-timeout**=*timeout*
The maximum time allowed to complete the healthcheck before an interval is considered failed. Like start-period, the
value can be expressed in a time format such as `1m22s`. The default value is `30s`.