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

Update website docs for node metadata

This commit is contained in:
Kyle Havlovitz 2017-01-11 17:52:31 -05:00
parent 7f91cd12f4
commit d44f3ea5d4
No known key found for this signature in database
GPG Key ID: 8A5E6B173056AD6C
2 changed files with 21 additions and 0 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

8
website/source/docs/agent/http/catalog.html.markdown
View File

@ -191,6 +191,10 @@ the node list in ascending order based on the estimated round trip
time from that node. Passing `?near=_agent` will use the agent's
node for the sort.
Adding the optional `?node-meta=` parameter with a desired node
metadata key/value pair of the form `key:value` will filter the
results to nodes with that pair present.
It returns a JSON body like this:
```javascript
@ -222,6 +226,10 @@ This endpoint is hit with a `GET` and returns the services registered
in a given DC. By default, the datacenter of the agent is queried;
however, the `dc` can be provided using the `?dc=` query parameter.
Adding the optional `?node-meta=` parameter with a desired node
metadata key/value pair of the form `key:value` will filter the
results to services with that pair present.
It returns a JSON body like this:
```javascript

13
website/source/docs/agent/options.html.markdown
View File

@ -251,6 +251,15 @@ will exit with an error at startup.
* <a name="_node"></a><a href="#_node">`-node`</a> - The name of this node in the cluster.
This must be unique within the cluster. By default this is the hostname of the machine.
* <a name="_node_meta"></a><a href="#_node_meta">`-node-meta`</a> - An arbitrary metadata key/value pair
to associate with the node, of the form `key:value`. This can be specified multiple times. Node metadata
pairs have the following restrictions:
- A maximum of 64 key/value pairs can be registered per node.
- Metadata keys must be between 1 and 128 characters (inclusive) in length
- Metadata keys must contain only alphanumeric, `-`, and `_` characters.
- Metadata keys must not begin with the `consul-` prefix; that is reserved for internal use by Consul.
- Metadata values must be between 0 and 512 (inclusive) characters in length.
* <a name="_pid_file"></a><a href="#_pid_file">`-pid-file`</a> - This flag provides the file
path for the agent to store its PID. This is useful for sending signals (for example, `SIGINT`
to close the agent or `SIGHUP` to update check definite
@ -658,6 +667,10 @@ Consul will not enable TLS for the HTTP API unless the `https` port has been ass
* <a name="node_name"></a><a href="#node_name">`node_name`</a> Equivalent to the
[`-node` command-line flag](#_node).
* <a name="node_meta"></a><a href="#node_meta">`node_meta`</a> This object allows associating arbitrary
metadata key/value pairs with the local node, which can then be used for filtering results from certain
catalog endpoints. See the [`-node-meta` command-line flag](#_node_meta) for more information.
* <a name="performance"></a><a href="#performance">`performance`</a> Available in Consul 0.7 and
later, this is a nested object that allows tuning the performance of different subsystems in
Consul. See the [Server Performance](/docs/guides/performance.html) guide for more details. The