diff options
| author | Urvashi Mohnani <umohnani@redhat.com> | 2023-12-04 05:26:56 -0500 |
|---|---|---|
| committer | openshift-cherrypick-robot <> | 2024-02-29 18:56:18 +0000 |
| commit | e7208a18e4694587a42584fc2e9740e93aab894a (patch) | |
| tree | 409f730a6673c2166deb9a8e203ceac7cf8e8b49 | |
| parent | 911f55003840cded024e6c1e3662714262d984c0 (diff) | |
Update health-start-periods docs
Update the health-start-period docs to clarify what exactly
the health-start-period flag does based on whether the health
check command succeeds or fails.
Signed-off-by: Urvashi Mohnani <umohnani@redhat.com>
| -rw-r--r-- | docs/source/markdown/options/health-start-period.md | 6 |
1 files changed, 6 insertions, 0 deletions
diff --git a/docs/source/markdown/options/health-start-period.md b/docs/source/markdown/options/health-start-period.md index 7559f9461..5b1fde4bd 100644 --- a/docs/source/markdown/options/health-start-period.md +++ b/docs/source/markdown/options/health-start-period.md @@ -6,3 +6,9 @@ The initialization time needed for a container to bootstrap. The value can be expressed in time format like **2m3s**. The default value is **0s**. + +Note: The health check command is executed as soon as a container is started, if the health check is successful +the container's health state will be updated to `healthy`. However, if the health check fails, the health state will +stay as `starting` until either the health check is successful or until the `--health-start-period` time is over. If the +health check command fails after the `--health-start-period` time is over, the health state will be updated to `unhealthy`. +The health check command is executed periodically based on the value of `--health-interval`. |