summaryrefslogtreecommitdiff
path: root/docs
diff options
context:
space:
mode:
authorOpenShift Merge Robot <openshift-merge-robot@users.noreply.github.com>2019-07-16 21:23:52 +0200
committerGitHub <noreply@github.com>2019-07-16 21:23:52 +0200
commit400851ac31a57f43916c4a1b653a33737f1e7e3b (patch)
tree718f6e8f2b6a8c517e201cb784d09a3c156ccb81 /docs
parenta449e9a2cf4b73163df75674059de04488cd2706 (diff)
parent47c1fe6a5cacb50e7e0db31044a9924dabca7de9 (diff)
downloadpodman-400851ac31a57f43916c4a1b653a33737f1e7e3b.tar.gz
podman-400851ac31a57f43916c4a1b653a33737f1e7e3b.tar.bz2
podman-400851ac31a57f43916c4a1b653a33737f1e7e3b.zip
Merge pull request #3508 from csomh/healthcheck-flag-compat
Make the healthcheck flags compatible with Docker CLI
Diffstat (limited to 'docs')
-rw-r--r--docs/podman-create.1.md10
-rw-r--r--docs/podman-run.1.md10
2 files changed, 10 insertions, 10 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`.
diff --git a/docs/podman-run.1.md b/docs/podman-run.1.md
index e3dca9300..ebf774b24 100644
--- a/docs/podman-run.1.md
+++ b/docs/podman-run.1.md
@@ -279,7 +279,7 @@ 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"* | *'["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
@@ -288,20 +288,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`.