Fixes a typo and adds an admonition about only being in Consul 0.7+.

This commit is contained in:
James Phillips 2016-08-16 09:27:20 -07:00
parent 4a3d7db24f
commit 231f5a957f
No known key found for this signature in database
GPG Key ID: 77183E682AC5FC11
3 changed files with 22 additions and 22 deletions

View File

@ -74,11 +74,11 @@ type AgentServiceCheck struct {
TCP string `json:",omitempty"` TCP string `json:",omitempty"`
Status string `json:",omitempty"` Status string `json:",omitempty"`
// Checks that are associated with a service may also contain this // In Consul 0.7 and later, checks that are associated with a service
// optional DeregisterCriticalServiceAfter field, which is a timeout in // may also contain this optional DeregisterCriticalServiceAfter field,
// the same Go time format as Interval and TTL. If a check is in the // which is a timeout in the same Go time format as Interval and TTL. If
// critical state for more than this configured value, then its // a check is in the critical state for more than this configured value,
// associated service (and all of its associated checks) will // then its associated service (and all of its associated checks) will
// automatically be deregistered. // automatically be deregistered.
DeregisterCriticalServiceAfter string `json:",omitempty"` DeregisterCriticalServiceAfter string `json:",omitempty"`
} }

View File

@ -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". > 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". > Valid time units are "ns", "us" (or "µs"), "ms", "s", "m", "h".
Checks that are associated with a service may also contain an optional In Consul 0.7 and later, checks that are associated with a service may also contain
`deregister_critical_service_after` field, which is a timeout in the same Go time an optional `deregister_critical_service_after` field, which is a timeout in the
format as `interval` and `ttl`. If a check is in the critical state for more than this same Go time format as `interval` and `ttl`. If a check is in the critical state
configured value, then its associated service (and all of its associated checks) for more than this configured value, then its associated service (and all of its
will automatically be deregistered. The minimum timeout is 1 minute, and the associated checks) will automatically be deregistered. The minimum timeout is 1
process that reaps critical services runs every 15 seconds, so a may take slightly minute, and the process that reaps critical services runs every 15 seconds, so it
longer than the configured timeout to trigger the deregistration. This should may take slightly longer than the configured timeout to trigger the deregistration.
generally be configured with a timeout that's much, much longer than any expected This should generally be configured with a timeout that's much, much longer than
recoverable outage for the given service. any expected recoverable outage for the given service.
To configure a check, either provide it as a `-config-file` option to the 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 agent or place it inside the `-config-dir` of the agent. The file must

View File

@ -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. 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 In Consul 0.7 and later, checks that are associated with a service may also contain
`DeregisterCriticalServiceAfter` field, which is a timeout in the same Go time an optional `DeregisterCriticalServiceAfter` field, which is a timeout in the same Go
format as `Interval` and `TTL`. If a check is in the critical state for more than this time format as `Interval` and `TTL`. If a check is in the critical state for more than
configured value, then its associated service (and all of its associated checks) 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 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 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 generally be configured with a timeout that's much, much longer than any expected
recoverable outage for the given service. 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. 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:\<ServiceId\>". `Script` and `HTTP` also require `Interval`. The created check will be named "service:\<ServiceId\>".
Checks that are associated with a service may also contain an optional In Consul 0.7 and later, checks that are associated with a service may also contain
`DeregisterCriticalServiceAfter` field, which is a timeout in the same Go time 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 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) configured value, then its associated service (and all of its associated checks)
will automatically be deregistered. The minimum timeout is 1 minute, and the 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 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 generally be configured with a timeout that's much, much longer than any expected
recoverable outage for the given service. recoverable outage for the given service.