status-im
/
consul
mirror of https://github.com/status-im/consul.git
2
0
Fork 0
Code Issues Projects Releases Wiki Activity

Finalize cleanup of docs/agent/http/agent.

This commit is contained in:
Ryan Breen 2015-02-07 17:43:43 -05:00
parent b90fa33929
commit 75f9327fe4
1 changed files with 10 additions and 9 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

19
website/source/docs/agent/http/agent.html.markdown
View File

@ -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. 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 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. cleaned up. Forcing a node into the `left` state allows its old entries to be removed.
The endpoint always returns 200. 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 If a `Script` is provided, the check type is a script, and Consul will
evaluate the script every `Interval` to update the status. 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 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. 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 If the response is `429 Too Many Requests`, the check is `warning`. Otherwise, the check
is critical. is `critical`.
If a `TTL` type is used, then the TTL update endpoint must be used periodically to update If a `TTL` type is used, then the TTL update endpoint must be used periodically to update
the state of the check. 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`. 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 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. `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. 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). `Script` and `HTTP` also require `Interval`. The created check will be named "service:\<ServiceId\>".
There is more information about checks [here](/docs/agent/checks.html).
The created check will be named "service:\<ServiceId\>".
The return code is 200 on success. The return code is 200 on success.