Skip to content

T6686: adds container health check documentation #1682

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
wants to merge 1 commit into
base: current
Choose a base branch
from
Open

T6686: adds container health check documentation #1682

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
25 changes: 25 additions & 0 deletions docs/configuration/container/index.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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 <name> health-check

Default health check is run for the container if defined by the image.

.. cfgcmd:: set container name <name> health-check command <command>

Override the default health check command from the image for a container.

.. cfgcmd:: set container name <name> health check interval <interval>

Override the default health-check interval. For example: `60`

.. cfgcmd:: set container name <name> health check timeout <timeout>

Override the default health-check timeout. For example: `10`

.. cfgcmd:: set container name <name> health check retries <retries>

Number of health check retries before container is considered unhealthy. For example: `1`

Container Networks
==================

Expand Down