Skip to content

Commit 125eeb7

Browse files
cpuguy83cpuguy83
committed
Add docs for health-start-interval
Signed-off-by: Brian Goff <cpuguy83@gmail.com>
1 parent 986879c commit 125eeb7

7 files changed

Lines changed: 7 additions & 0 deletions

File tree

‎docs/reference/commandline/container_create.md‎

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -51,6 +51,7 @@ Create a new container
5151
| `--health-cmd` | `string` | | Command to run to check health |
5252
| `--health-interval` | `duration` | `0s` | Time between running the check (ms\|s\|m\|h) (default 0s) |
5353
| `--health-retries` | `int` | `0` | Consecutive failures needed to report unhealthy |
54+
| `--health-start-interval` | `duration` | `0s` | Time between running the check during the start period (ms\|s\|m\|h) (default 0s) |
5455
| `--health-start-period` | `duration` | `0s` | Start period for the container to initialize before starting health-retries countdown (ms\|s\|m\|h) (default 0s) |
5556
| `--health-timeout` | `duration` | `0s` | Maximum time to allow one check to run (ms\|s\|m\|h) (default 0s) |
5657
| `--help` | | | Print usage |

‎docs/reference/commandline/container_run.md‎

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -53,6 +53,7 @@ Create and run a new container from an image
5353
| `--health-cmd` | `string` | | Command to run to check health |
5454
| `--health-interval` | `duration` | `0s` | Time between running the check (ms\|s\|m\|h) (default 0s) |
5555
| `--health-retries` | `int` | `0` | Consecutive failures needed to report unhealthy |
56+
| `--health-start-interval` | `duration` | `0s` | Time between running the check during the start period (ms\|s\|m\|h) (default 0s) |
5657
| `--health-start-period` | `duration` | `0s` | Start period for the container to initialize before starting health-retries countdown (ms\|s\|m\|h) (default 0s) |
5758
| `--health-timeout` | `duration` | `0s` | Maximum time to allow one check to run (ms\|s\|m\|h) (default 0s) |
5859
| `--help` | | | Print usage |

‎docs/reference/commandline/create.md‎

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -51,6 +51,7 @@ Create a new container
5151
| `--health-cmd` | `string` | | Command to run to check health |
5252
| `--health-interval` | `duration` | `0s` | Time between running the check (ms\|s\|m\|h) (default 0s) |
5353
| `--health-retries` | `int` | `0` | Consecutive failures needed to report unhealthy |
54+
| `--health-start-interval` | `duration` | `0s` | Time between running the check during the start period (ms\|s\|m\|h) (default 0s) |
5455
| `--health-start-period` | `duration` | `0s` | Start period for the container to initialize before starting health-retries countdown (ms\|s\|m\|h) (default 0s) |
5556
| `--health-timeout` | `duration` | `0s` | Maximum time to allow one check to run (ms\|s\|m\|h) (default 0s) |
5657
| `--help` | | | Print usage |

‎docs/reference/commandline/run.md‎

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -53,6 +53,7 @@ Create and run a new container from an image
5353
| `--health-cmd` | `string` | | Command to run to check health |
5454
| `--health-interval` | `duration` | `0s` | Time between running the check (ms\|s\|m\|h) (default 0s) |
5555
| `--health-retries` | `int` | `0` | Consecutive failures needed to report unhealthy |
56+
| `--health-start-interval` | `duration` | `0s` | Time between running the check during the start period (ms\|s\|m\|h) (default 0s) |
5657
| `--health-start-period` | `duration` | `0s` | Start period for the container to initialize before starting health-retries countdown (ms\|s\|m\|h) (default 0s) |
5758
| `--health-timeout` | `duration` | `0s` | Maximum time to allow one check to run (ms\|s\|m\|h) (default 0s) |
5859
| `--help` | | | Print usage |

‎docs/reference/commandline/service_create.md‎

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -26,6 +26,7 @@ Create a new service
2626
| `--health-cmd` | `string` | | Command to run to check health |
2727
| `--health-interval` | `duration` | | Time between running the check (ms\|s\|m\|h) |
2828
| `--health-retries` | `int` | `0` | Consecutive failures needed to report unhealthy |
29+
| `--health-start-interval` | `duration` | | Time between running the check during the start period (ms\|s\|m\|h) |
2930
| `--health-start-period` | `duration` | | Start period for the container to initialize before counting retries towards unstable (ms\|s\|m\|h) |
3031
| `--health-timeout` | `duration` | | Maximum time to allow one check to run (ms\|s\|m\|h) |
3132
| `--host` | `list` | | Set one or more custom host-to-IP mappings (host:ip) |

‎docs/reference/commandline/service_update.md‎

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -36,6 +36,7 @@ Update a service
3636
| `--health-cmd` | `string` | | Command to run to check health |
3737
| `--health-interval` | `duration` | | Time between running the check (ms\|s\|m\|h) |
3838
| `--health-retries` | `int` | `0` | Consecutive failures needed to report unhealthy |
39+
| `--health-start-interval` | `duration` | | Time between running the check during the start period (ms\|s\|m\|h) |
3940
| `--health-start-period` | `duration` | | Start period for the container to initialize before counting retries towards unstable (ms\|s\|m\|h) |
4041
| `--health-timeout` | `duration` | | Maximum time to allow one check to run (ms\|s\|m\|h) |
4142
| `--host-add` | `list` | | Add a custom host-to-IP mapping (`host:ip`) |

‎docs/reference/run.md‎

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1640,6 +1640,7 @@ Similarly the operator can set the **HOSTNAME** (Linux) or **COMPUTERNAME** (Win
16401640
--health-retries Consecutive failures needed to report unhealthy
16411641
--health-timeout Maximum time to allow one check to run
16421642
--health-start-period Start period for the container to initialize before starting health-retries countdown
1643+
--health-start-interval Time between running the check during the start period
16431644
--no-healthcheck Disable any container-specified HEALTHCHECK
16441645
```
16451646

0 commit comments

Comments
 (0)