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 <[email protected]>
openshift-cherrypick-robot · Feb 29, 2024 · 906c0df · 906c0df
1 parent 8d2b55d
commit 906c0df
Showing 1 changed file with 6 additions and 0 deletions.
diff --git 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`.