From f66bf3114aadc4a548497f11bda0ea4ea521bf97 Mon Sep 17 00:00:00 2001 From: shalev67 Date: Fri, 22 Jul 2016 20:21:07 +0300 Subject: [PATCH] Added api agent docs enableTagOverride var --- .../docs/agent/http/agent.html.markdown | 22 ++++++++++++++++++- 1 file changed, 21 insertions(+), 1 deletion(-) diff --git a/website/source/docs/agent/http/agent.html.markdown b/website/source/docs/agent/http/agent.html.markdown index 796c7e6e8d..2ec861757f 100644 --- a/website/source/docs/agent/http/agent.html.markdown +++ b/website/source/docs/agent/http/agent.html.markdown @@ -385,6 +385,7 @@ body must look like: ], "Address": "127.0.0.1", "Port": 8000, + "enableTagOverride": false, "Check": { "Script": "/usr/local/bin/check_redis.py", "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 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 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:\". 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 string includes a `?token=`, the registration will use the provided token to authorize the request. The token is also persisted in the agent's