Skip to content

Commit 5abf7fe

Browse files
committed
T6686: adds container health check documentation
1 parent 7bf883d commit 5abf7fe

File tree

1 file changed

+25
-0
lines changed

1 file changed

+25
-0
lines changed

docs/configuration/container/index.rst

Lines changed: 25 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -202,6 +202,31 @@ Configuration
202202

203203
Disable a container.
204204

205+
Container Health checks
206+
=======================
207+
208+
By default, no health checks are run, even when defined by the image.
209+
210+
.. cfgcmd:: set container name <name> health-check
211+
212+
Default health check is run for the container if defined by the image.
213+
214+
.. cfgcmd:: set container name <name> health-check command <command>
215+
216+
Override the default health check command from the image for a container.
217+
218+
.. cfgcmd:: set container name <name> health check interval <interval>
219+
220+
Override the default health-check interval. For example: `60`
221+
222+
.. cfgcmd:: set container name <name> health check timeout <timeout>
223+
224+
Override the default health-check timeout. For example: `10`
225+
226+
.. cfgcmd:: set container name <name> health check retries <retries>
227+
228+
Number of health check retries before container is considered unhealthy. For example: `1`
229+
205230
Container Networks
206231
==================
207232

0 commit comments

Comments
 (0)