diff options
| author | baude <bbaude@redhat.com> | 2019-02-26 20:54:57 -0600 |
|---|---|---|
| committer | baude <bbaude@redhat.com> | 2019-03-05 14:03:55 -0600 |
| commit | 598bde52d02eb82634c6b1fa357253f03120a4a0 (patch) | |
| tree | 08c935792c9e1d57ee00f8db98b3f1a74987f4b6 /docs | |
| parent | 645426fe797f90fc75712388e0373158f13bab0a (diff) | |
| download | podman-598bde52d02eb82634c6b1fa357253f03120a4a0.tar.gz podman-598bde52d02eb82634c6b1fa357253f03120a4a0.tar.bz2 podman-598bde52d02eb82634c6b1fa357253f03120a4a0.zip | |
podman healthcheck run (phase 1)
Add the ability to manually run a container's healthcheck command.
This is only the first phase of implementing the healthcheck.
Subsequent pull requests will deal with the exposing the results and
history of healthchecks as well as the scheduling.
Signed-off-by: baude <bbaude@redhat.com>
Diffstat (limited to 'docs')
| -rw-r--r-- | docs/podman-healthcheck-run.1.md | 39 | ||||
| -rw-r--r-- | docs/podman-healthcheck.1.md | 22 |
2 files changed, 61 insertions, 0 deletions
diff --git a/docs/podman-healthcheck-run.1.md b/docs/podman-healthcheck-run.1.md new file mode 100644 index 000000000..8cecb8eaa --- /dev/null +++ b/docs/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 healtcheck run mywebapp +``` + +## SEE ALSO +podman-healthcheck(1) + +## HISTORY +Feb 2019, Originally compiled by Brent Baude <bbaude@redhat.com> diff --git a/docs/podman-healthcheck.1.md b/docs/podman-healthcheck.1.md new file mode 100644 index 000000000..68d403231 --- /dev/null +++ b/docs/podman-healthcheck.1.md @@ -0,0 +1,22 @@ +% podman-healthcheck(1) + +## NAME +podman\-healthcheck- Manage healthchecks for containers + +## SYNOPSIS +**podman healthcheck** *subcommand* + +## DESCRIPTION +podman healthcheck is a set of subcommands that manage container healthchecks + +## SUBCOMMANDS + +| Command | Man Page | Description | +| ------- | ------------------------------------------------- | ------------------------------------------------------------------------------ | +| run | [podman-healthcheck-run(1)](podman-healthcheck-run.1.md) | Run a container healthcheck | + +## SEE ALSO +podman(1) + +## HISTORY +Feb 2019, Originally compiled by Brent Baude <bbaude@redhat.com> |