Skip to content

Commit

Permalink
Merge pull request docker#4713 from thaJeztah/health_table
Browse files Browse the repository at this point in the history
docs: run-reference: use table for health options
  • Loading branch information
thaJeztah authored Dec 13, 2023
2 parents 8f90d98 + ca9ff8d commit 2b63b4f
Showing 1 changed file with 9 additions and 9 deletions.
18 changes: 9 additions & 9 deletions docs/reference/run.md
Original file line number Diff line number Diff line change
Expand Up @@ -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:

Expand Down

0 comments on commit 2b63b4f

Please sign in to comment.