From 0f67feb93b107a1b340dedd2712b82ee1802e86d Mon Sep 17 00:00:00 2001 From: Michael Schurter Date: Fri, 31 Jan 2020 10:30:14 -0800 Subject: [PATCH] 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. --- website/pages/docs/job-specification/update.mdx | 6 ++++-- 1 file changed, 4 insertions(+), 2 deletions(-) diff --git a/website/pages/docs/job-specification/update.mdx b/website/pages/docs/job-specification/update.mdx index 2cbbcc46c..953b93f16 100644 --- a/website/pages/docs/job-specification/update.mdx +++ b/website/pages/docs/job-specification/update.mdx @@ -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