Guest24897
/
DockerCLI
mirror of https://github.com/docker/cli.git
1
0
Fork 0
Code Issues Packages Projects Releases Wiki Activity

Merge pull request #4713 from thaJeztah/health_table 

docs: run-reference: use table for health options
This commit is contained in:
Sebastiaan van Stijn 2023-12-13 19:41:26 +01:00 committed by GitHub
parent 8f90d984bb ca9ff8dafc
commit 2b63b4f8d1
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
1 changed files with 9 additions and 9 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

18
docs/reference/run.md
View File

@ -1144,15 +1144,15 @@ windir=C:\Windows
The following flags for the `docker run` command let you control the parameters
for container healthchecks:
```text
--health-cmd Command to run to check health
--health-interval Time between running the check
--health-retries Consecutive failures needed to report unhealthy
--health-timeout Maximum time to allow one check to run
--health-start-period Start period for the container to initialize before starting health-retries countdown
--health-start-interval Time between running the check during the start period
--no-healthcheck Disable any container-specified HEALTHCHECK
```
| Option | Description |
|:---------------------------|:---------------------------------------------------------------------------------------|
| `--health-cmd` | Command to run to check health |
| `--health-interval` | Time between running the check |
| `--health-retries` | Consecutive failures needed to report unhealthy |
| `--health-timeout` | Maximum time to allow one check to run |
| `--health-start-period` | Start period for the container to initialize before starting health-retries countdown |
| `--health-start-interval` | Time between running the check during the start period |
| `--no-healthcheck` | Disable any container-specified `HEALTHCHECK` |
Example: