Skip to content

Commit bcc153f

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

File tree

1 file changed

+21
-0
lines changed

1 file changed

+21
-0
lines changed

docs/configuration/container/index.rst

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

203203
Disable a container.
204204

205+
.. cfgcmd:: set container name <name> health-check command <command>
206+
207+
Override the default health check command from the image for a container.
208+
209+
.. cfgcmd:: set container name <name> health check interval <interval>
210+
211+
Override the default health-check interval. For example: `60s`
212+
213+
.. cfgcmd:: set container name <name> health check timeout <timeout>
214+
215+
Override the default health-check timeout. For example: `10s`
216+
217+
.. cfgcmd:: set container name <name> health check retries <retries>
218+
219+
Number of health check retries before container is considered unhealthy. For example: `1`
220+
221+
.. cfgcmd:: set container name <name> health check disable
222+
223+
Disable any health checks even when defined in the image.
224+
225+
205226
Container Networks
206227
==================
207228

0 commit comments

Comments
 (0)