From 5ede4c82ace2301d10e9cbd7202fc8c612667f71 Mon Sep 17 00:00:00 2001 From: David Karlsson <35727626+dvdksn@users.noreply.github.com> Date: Mon, 27 Nov 2023 14:08:17 +0100 Subject: [PATCH] docs: minor improvements to the healthcheck section Signed-off-by: David Karlsson <35727626+dvdksn@users.noreply.github.com> --- docs/reference/run.md | 19 +++++++++++-------- 1 file changed, 11 insertions(+), 8 deletions(-) diff --git a/docs/reference/run.md b/docs/reference/run.md index d7e3b23898..a15240c2d9 100644 --- a/docs/reference/run.md +++ b/docs/reference/run.md @@ -1066,14 +1066,17 @@ windir=C:\Windows ### Healthchecks -``` - --health-cmd Command to run to check health - --health-interval Time between running the check - --health-retries Consecutive failures needed to report unhealthy - --health-timeout Maximum time to allow one check to run - --health-start-period Start period for the container to initialize before starting health-retries countdown - --health-start-interval Time between running the check during the start period - --no-healthcheck Disable any container-specified HEALTHCHECK +The following flags for the `docker run` command let you control the parameters +for container healthchecks: + +```text +--health-cmd Command to run to check health +--health-interval Time between running the check +--health-retries Consecutive failures needed to report unhealthy +--health-timeout Maximum time to allow one check to run +--health-start-period Start period for the container to initialize before starting health-retries countdown +--health-start-interval Time between running the check during the start period +--no-healthcheck Disable any container-specified HEALTHCHECK ``` Example: