docs: Update links to ttl health check endpoints. (#4208)

* docs: Update links to ttl health check endpoints.

* remove absolute URLs
pull/4458/head
Christie Koehler 6 years ago committed by Jack Pearkes
parent 8cdba9611d
commit 2710ae4159

@ -63,20 +63,23 @@ There are several different kinds of checks:
TCP check timeout value by specifying the `timeout` field in the check TCP check timeout value by specifying the `timeout` field in the check
definition. definition.
* <a name="TTL"></a>Time to Live (TTL) - These checks retain their last known state for a given TTL. * <a name="TTL"></a>Time to Live (TTL) - These checks retain their last known
The state of the check must be updated periodically over the HTTP interface. If an state for a given TTL. The state of the check must be updated periodically
external system fails to update the status within a given TTL, the check is over the HTTP interface. If an external system fails to update the status
set to the failed state. This mechanism, conceptually similar to a dead man's switch, within a given TTL, the check is set to the failed state. This mechanism,
relies on the application to directly report its health. For example, a healthy app conceptually similar to a dead man's switch, relies on the application to
can periodically `PUT` a status update to the HTTP endpoint; if the app fails, the TTL will directly report its health. For example, a healthy app can periodically `PUT` a
expire and the health check enters a critical state. The endpoints used to status update to the HTTP endpoint; if the app fails, the TTL will expire and
update health information for a given check are the the health check enters a critical state. The endpoints used to update health
[pass endpoint](https://www.consul.io/api/agent.html#agent_check_pass) information for a given check are:
and the [fail endpoint](https://www.consul.io/api/agent.html#agent_check_fail). [pass](/api/agent/check.html#ttl-check-pass),
TTL checks also persist [warn](/api/agent/check.html#ttl-check-warn),
their last known status to disk. This allows the Consul agent to restore the [fail](/api/agent/check.html#ttl-check-fail), and
last known status of the check across restarts. Persisted check status is [update](/api/agent/check.html#ttl-check-update). TTL
valid through the end of the TTL from the time of the last check. checks also persist their last known status to disk. This allows the Consul
agent to restore the last known status of the check across restarts. Persisted
check status is valid through the end of the TTL from the time of the last
check.
* Docker + Interval - These checks depend on invoking an external application which * Docker + Interval - These checks depend on invoking an external application which
is packaged within a Docker Container. The application is triggered within the running is packaged within a Docker Container. The application is triggered within the running

Loading…
Cancel
Save