From f0bb4b4e310b220f37f1f84607139b93ff2833f9 Mon Sep 17 00:00:00 2001 From: Ryan Breen Date: Sat, 7 Feb 2015 17:43:43 -0500 Subject: [PATCH] Finalize cleanup of docs/agent/http/agent. --- .../docs/agent/http/agent.html.markdown | 19 ++++++++++--------- 1 file changed, 10 insertions(+), 9 deletions(-) diff --git a/website/source/docs/agent/http/agent.html.markdown b/website/source/docs/agent/http/agent.html.markdown index 18de96697..1da6400c4 100644 --- a/website/source/docs/agent/http/agent.html.markdown +++ b/website/source/docs/agent/http/agent.html.markdown @@ -213,7 +213,7 @@ The return code is 200 on success. This endpoint is hit with a GET and is used to instruct the agent to force a node into the `left` state. If a node fails unexpectedly, then it will be in a `failed` state. Once in the `failed` state, Consul will -attempt to reconnect and the services and checks belonging to that node will not be +attempt to reconnect, and the services and checks belonging to that node will not be cleaned up. Forcing a node into the `left` state allows its old entries to be removed. The endpoint always returns 200. @@ -251,10 +251,10 @@ The `Notes` field is not used internally by Consul and is meant to be human-read If a `Script` is provided, the check type is a script, and Consul will evaluate the script every `Interval` to update the status. -An `HTTP` check will perform an HTTP GET request to the value of `HTTP` (expected to -be a URL) every `Interval`. If the response is any `2xx` code, the check is passing. -If the response is `429 Too Many Requests`, the check is warning. Otherwise, the check -is critical. +An `HTTP` check will perform an HTTP GET request against the value of `HTTP` (expected to +be a URL) every `Interval`. If the response is any `2xx` code, the check is `passing`. +If the response is `429 Too Many Requests`, the check is `warning`. Otherwise, the check +is `critical`. If a `TTL` type is used, then the TTL update endpoint must be used periodically to update the state of the check. @@ -332,14 +332,15 @@ body must look like: The `Name` field is mandatory, If an `ID` is not provided, it is set to `Name`. You cannot have duplicate `ID` entries per agent, so it may be necessary to provide an ID -in the case of a collision. `Tags`, `Address`, `Port` and `Check` are optional. +in the case of a collision. + +`Tags`, `Address`, `Port` and `Check` are optional. `Address` will default to that of the agent if not provided. If `Check` is provided, only one of `Script`, `HTTP`, or `TTL` should be specified. -`Script` and `HTTP` also require `Interval`. There is more information about checks [here](/docs/agent/checks.html). - -The created check will be named "service:\". +`Script` and `HTTP` also require `Interval`. The created check will be named "service:\". +There is more information about checks [here](/docs/agent/checks.html). The return code is 200 on success.