From 5abf7fef6b454d0ada039980b349a293331c0584 Mon Sep 17 00:00:00 2001 From: Nicolas Vollmar Date: Wed, 10 Sep 2025 12:49:26 +0200 Subject: [PATCH] T6686: adds container health check documentation --- docs/configuration/container/index.rst | 25 +++++++++++++++++++++++++ 1 file changed, 25 insertions(+) diff --git a/docs/configuration/container/index.rst b/docs/configuration/container/index.rst index ed70a49c26..ca235521be 100644 --- a/docs/configuration/container/index.rst +++ b/docs/configuration/container/index.rst @@ -202,6 +202,31 @@ Configuration Disable a container. +Container Health checks +======================= + +By default, no health checks are run, even when defined by the image. + +.. cfgcmd:: set container name health-check + + Default health check is run for the container if defined by the image. + +.. cfgcmd:: set container name health-check command + + Override the default health check command from the image for a container. + +.. cfgcmd:: set container name health check interval + + Override the default health-check interval. For example: `60` + +.. cfgcmd:: set container name health check timeout + + Override the default health-check timeout. For example: `10` + +.. cfgcmd:: set container name health check retries + + Number of health check retries before container is considered unhealthy. For example: `1` + Container Networks ==================