summaryrefslogtreecommitdiff
path: root/docs/source/markdown/podman-healthcheck-run.1.md
diff options
context:
space:
mode:
authorOpenShift Merge Robot <openshift-merge-robot@users.noreply.github.com>2019-10-31 19:39:44 +0100
committerGitHub <noreply@github.com>2019-10-31 19:39:44 +0100
commitffe36ea9964242235571ad1d21a0c4d825ef5971 (patch)
treeb38d2d9c492ab2b2ad951135fde7e90c37344711 /docs/source/markdown/podman-healthcheck-run.1.md
parent3e2d9f8662663f2f703bf674408d5255e493e18e (diff)
parent486fcd4e1e6f00424f1016d8e331582523bd2c68 (diff)
downloadpodman-ffe36ea9964242235571ad1d21a0c4d825ef5971.tar.gz
podman-ffe36ea9964242235571ad1d21a0c4d825ef5971.tar.bz2
podman-ffe36ea9964242235571ad1d21a0c4d825ef5971.zip
Merge pull request #4354 from baude/newdocsstruct
Restructure documentation dir
Diffstat (limited to 'docs/source/markdown/podman-healthcheck-run.1.md')
-rw-r--r--docs/source/markdown/podman-healthcheck-run.1.md39
1 files changed, 39 insertions, 0 deletions
diff --git a/docs/source/markdown/podman-healthcheck-run.1.md b/docs/source/markdown/podman-healthcheck-run.1.md
new file mode 100644
index 000000000..21f2d9b20
--- /dev/null
+++ b/docs/source/markdown/podman-healthcheck-run.1.md
@@ -0,0 +1,39 @@
+% podman-healthcheck-run(1)
+
+## NAME
+podman\-healthcheck\-run - Run a container healthcheck
+
+## SYNOPSIS
+**podman healthcheck run** [*options*] *container*
+
+## DESCRIPTION
+
+Runs the healthcheck command defined in a running container manually. The resulting error codes are defined
+as follows:
+
+* 0 = healthcheck command succeeded
+* 1 = healthcheck command failed
+* 125 = an error has occurred
+
+Possible errors that can occur during the healthcheck are:
+* unable to find the container
+* container has no defined healthcheck
+* container is not running
+
+## OPTIONS
+**--help**
+
+Print usage statement
+
+
+## EXAMPLES
+
+```
+$ podman healthcheck run mywebapp
+```
+
+## SEE ALSO
+podman-healthcheck(1)
+
+## HISTORY
+Feb 2019, Originally compiled by Brent Baude <bbaude@redhat.com>