docs: clarify healthy/progress_deadline relationship

Validation code already enforces this, but I think documenting it makes
it more immediately clear how the 2 settings interact.
This commit is contained in:
Michael Schurter 2020-01-31 10:30:14 -08:00 committed by Tim Gross
parent 49a177ce28
commit d2a4e0557d
1 changed files with 4 additions and 2 deletions

View File

@ -75,8 +75,10 @@ a future release.
- `healthy_deadline` `(string: "5m")` - Specifies the deadline in which the
allocation must be marked as healthy after which the allocation is
automatically transitioned to unhealthy. This is specified using a label
suffix like "2m" or "1h".
automatically transitioned to unhealthy. This is specified using a label suffix
like "2m" or "1h". If [`progress_deadline`](#progress_deadline) is non-zero, it
must be greater than `healthy_deadline`. Otherwise the `progress_deadline` may
fail a deployment before an allocation reaches its `healthy_deadline`.
- `progress_deadline` `(string: "10m")` - Specifies the deadline in which an
allocation must be marked as healthy. The deadline begins when the first