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

Added api agent docs enableTagOverride var

This commit is contained in:
shalev67 2016-07-22 20:21:07 +03:00
parent fce7d75609
commit f66bf3114a
1 changed files with 21 additions and 1 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

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

@ -385,6 +385,7 @@ body must look like:
], ],
"Address": "127.0.0.1", "Address": "127.0.0.1",
"Port": 8000, "Port": 8000,
"enableTagOverride": false,
"Check": { "Check": {
"Script": "/usr/local/bin/check_redis.py", "Script": "/usr/local/bin/check_redis.py",
"HTTP": "http://localhost:5000/health", "HTTP": "http://localhost:5000/health",
@ -398,7 +399,7 @@ 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. in the case of a collision.
`Tags`, `Address`, `Port` and `Check` are optional. `Tags`, `Address`, `Port`, `Check` and `EnableTagOverride` are optional.
If `Address` is not provided or left empty, then the agent's address will be used If `Address` is not provided or left empty, then the agent's address will be used
as the address for the service during DNS queries. When querying for services using as the address for the service during DNS queries. When querying for services using
@ -412,6 +413,25 @@ If `Check` is provided, only one of `Script`, `HTTP`, `TCP` or `TTL` should be s
`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\>".
There is more information about checks [here](/docs/agent/checks.html). There is more information about checks [here](/docs/agent/checks.html).
The `enableTagOverride` can optionally be specified to disable the anti-entropy
feature for this service. If `enableTagOverride` is set to TRUE then external
agents can update this service in the [catalog](/docs/agent/http/catalog.html) and modify the tags. Subsequent
local sync operations by this agent will ignore the updated tags. For instance: If an external agent
modified both the tags and the port for this service and `enableTagOverride`
was set to TRUE then after the next sync cycle the service's port would revert
to the original value but the tags would maintain the updated value. As a
counter example: If an external agent modified both the tags and port for this
service and `enableTagOverride` was set to FALSE then after the next sync
cycle the service's port AND the tags would revert to the original value and
all modifications would be lost. It's important to note that this applies only
to the locally registered service. If you have multiple nodes all registering
the same service their `enableTagOverride` configuration and all other service
configuration items are independent of one another. Updating the tags for
the service registered on one node is independent of the same service (by name)
registered on another node. If `enableTagOverride` is not specified the default
value is false. See [anti-entropy syncs](/docs/internals/anti-entropy.html)
for more info.
This endpoint supports [ACL tokens](/docs/internals/acl.html). If the query This endpoint supports [ACL tokens](/docs/internals/acl.html). If the query
string includes a `?token=<token-id>`, the registration will use the provided string includes a `?token=<token-id>`, the registration will use the provided
token to authorize the request. The token is also persisted in the agent's token to authorize the request. The token is also persisted in the agent's