diff --git a/api/agent.go b/api/agent.go index 36e090001..87a6c1001 100644 --- a/api/agent.go +++ b/api/agent.go @@ -74,11 +74,11 @@ type AgentServiceCheck struct { TCP string `json:",omitempty"` Status string `json:",omitempty"` - // Checks that are associated with a service may also contain this - // optional DeregisterCriticalServiceAfter field, which is a timeout in - // the same Go time format as Interval and TTL. If a check is in the - // critical state for more than this configured value, then its - // associated service (and all of its associated checks) will + // In Consul 0.7 and later, checks that are associated with a service + // may also contain this optional DeregisterCriticalServiceAfter field, + // which is a timeout in the same Go time format as Interval and TTL. If + // a check is in the critical state for more than this configured value, + // then its associated service (and all of its associated checks) will // automatically be deregistered. DeregisterCriticalServiceAfter string `json:",omitempty"` } diff --git a/website/source/docs/agent/checks.html.markdown b/website/source/docs/agent/checks.html.markdown index dd6bf1541..49a5ca3aa 100644 --- a/website/source/docs/agent/checks.html.markdown +++ b/website/source/docs/agent/checks.html.markdown @@ -169,15 +169,15 @@ parsed by Go's `time` package, and has the following > optional fraction and a unit suffix, such as "300ms", "-1.5h" or "2h45m". > Valid time units are "ns", "us" (or "µs"), "ms", "s", "m", "h". -Checks that are associated with a service may also contain an optional -`deregister_critical_service_after` field, which is a timeout in the same Go time -format as `interval` and `ttl`. If a check is in the critical state for more than this -configured value, then its associated service (and all of its associated checks) -will automatically be deregistered. The minimum timeout is 1 minute, and the -process that reaps critical services runs every 15 seconds, so a may take slightly -longer than the configured timeout to trigger the deregistration. This should -generally be configured with a timeout that's much, much longer than any expected -recoverable outage for the given service. +In Consul 0.7 and later, checks that are associated with a service may also contain +an optional `deregister_critical_service_after` field, which is a timeout in the +same Go time format as `interval` and `ttl`. If a check is in the critical state +for more than this configured value, then its associated service (and all of its +associated checks) will automatically be deregistered. The minimum timeout is 1 +minute, and the process that reaps critical services runs every 15 seconds, so it +may take slightly longer than the configured timeout to trigger the deregistration. +This should generally be configured with a timeout that's much, much longer than +any expected recoverable outage for the given service. To configure a check, either provide it as a `-config-file` option to the agent or place it inside the `-config-dir` of the agent. The file must diff --git a/website/source/docs/agent/http/agent.html.markdown b/website/source/docs/agent/http/agent.html.markdown index 158ac2a4d..3ac8273e9 100644 --- a/website/source/docs/agent/http/agent.html.markdown +++ b/website/source/docs/agent/http/agent.html.markdown @@ -262,12 +262,12 @@ If an `ID` is not provided, it is set to `Name`. You cannot have duplicate The `Notes` field is not used internally by Consul and is meant to be human-readable. -Checks that are associated with a service may also contain an optional -`DeregisterCriticalServiceAfter` field, which is a timeout in the same Go time -format as `Interval` and `TTL`. If a check is in the critical state for more than this -configured value, then its associated service (and all of its associated checks) +In Consul 0.7 and later, checks that are associated with a service may also contain +an optional `DeregisterCriticalServiceAfter` field, which is a timeout in the same Go +time format as `Interval` and `TTL`. If a check is in the critical state for more than +this configured value, then its associated service (and all of its associated checks) will automatically be deregistered. The minimum timeout is 1 minute, and the -process that reaps critical services runs every 15 seconds, so a may take slightly +process that reaps critical services runs every 15 seconds, so it may take slightly longer than the configured timeout to trigger the deregistration. This should generally be configured with a timeout that's much, much longer than any expected recoverable outage for the given service. @@ -426,12 +426,12 @@ information. If `Check` is provided, only one of `Script`, `HTTP`, `TCP` or `TTL` should be specified. `Script` and `HTTP` also require `Interval`. The created check will be named "service:\". -Checks that are associated with a service may also contain an optional -`DeregisterCriticalServiceAfter` field, which is a timeout in the same Go time +In Consul 0.7 and later, checks that are associated with a service may also contain +an optional `DeregisterCriticalServiceAfter` field, which is a timeout in the same Go time format as `Interval` and `TTL`. If a check is in the critical state for more than this configured value, then its associated service (and all of its associated checks) will automatically be deregistered. The minimum timeout is 1 minute, and the -process that reaps critical services runs every 15 seconds, so a may take slightly +process that reaps critical services runs every 15 seconds, so it may take slightly longer than the configured timeout to trigger the deregistration. This should generally be configured with a timeout that's much, much longer than any expected recoverable outage for the given service.