github
/
consul
mirror of https://github.com/hashicorp/consul
1
0
Fork 0
Code Issues Projects Releases Wiki Activity

Tweaks the agent docs for `EnableTagOverride`.

pull/2208/head
James Phillips 2016-07-23 14:48:54 -07:00
parent f66bf3114a
commit 4fb97a2ef9
1 changed files with 13 additions and 13 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

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

@ -385,7 +385,7 @@ body must look like:
], ],
"Address": "127.0.0.1", "Address": "127.0.0.1",
"Port": 8000, "Port": 8000,
"enableTagOverride": false, "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",
@ -413,23 +413,23 @@ 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 `EnableTagOverride` can optionally be specified to disable the anti-entropy
feature for this service. If `enableTagOverride` is set to TRUE then external feature for this service's tags. 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 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 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` 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 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 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 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 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 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 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 to the locally registered service. If you have multiple nodes all registering
the same service their `enableTagOverride` configuration and all other service the same service their `EnableTagOverride` configuration and all other service
configuration items are independent of one another. Updating the tags for 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) 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 registered on another node. If `EnableTagOverride` is not specified the default
value is false. See [anti-entropy syncs](/docs/internals/anti-entropy.html) value is `false`. See [anti-entropy syncs](/docs/internals/anti-entropy.html)
for more info. 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