From 9fbb771f2df93e7d7fcaff16ec0f0bda0934bf71 Mon Sep 17 00:00:00 2001 From: Tim Gross Date: Thu, 3 Jun 2021 08:39:45 -0400 Subject: [PATCH] docs: clarify default `check.initial_status` behavior --- website/content/docs/job-specification/service.mdx | 7 ++++--- 1 file changed, 4 insertions(+), 3 deletions(-) diff --git a/website/content/docs/job-specification/service.mdx b/website/content/docs/job-specification/service.mdx index 5ed1be7ee..2f8b5c129 100644 --- a/website/content/docs/job-specification/service.mdx +++ b/website/content/docs/job-specification/service.mdx @@ -229,9 +229,10 @@ scripts. - `grpc_use_tls` `(bool: false)` - Use TLS to perform a gRPC health check. May be used with `tls_skip_verify` to use TLS but skip certificate verification. -- `initial_status` `(string: )` - Specifies the originating status of the - service. Valid options are the empty string, `passing`, `warning`, and - `critical`. +- `initial_status` `(string: )` - Specifies the starting status of the + service. Valid options are `passing`, `warning`, and `critical`. Omitting + this field (or submitting an empty string) will result in the Consul default + behavior, which is `critical`. - `success_before_passing` `(int:0)` - The number of consecutive successful checks required before Consul will transition the service status to [`passing`][consul_passfail].