From 68e0a6c89a595fef1fc6cb922561ec16c8c4d127 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Jan=20Rod=C3=A1k?= Date: Mon, 24 Mar 2025 18:10:04 +0100 Subject: [PATCH] Clarify behavior of --health-timeout in man page MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit Fixes: https://issues.redhat.com/browse/RHEL-84682 Signed-off-by: Jan Rodák --- docs/source/markdown/options/health-timeout.md | 4 ++++ 1 file changed, 4 insertions(+) diff --git a/docs/source/markdown/options/health-timeout.md b/docs/source/markdown/options/health-timeout.md index 0540a48db3..98d807ce5c 100644 --- a/docs/source/markdown/options/health-timeout.md +++ b/docs/source/markdown/options/health-timeout.md @@ -6,3 +6,7 @@ The maximum time allowed to complete the healthcheck before an interval is considered failed. Like start-period, the value can be expressed in a time format such as **1m22s**. The default value is **30s**. + +Note: A timeout marks the healthcheck as failed but does not terminate the running process. +This ensures that a slow but eventually successful healthcheck does not disrupt the container +but is still accounted for in the health status.