From ee2e161dfe1bf9a7275232df2bb7820e8fffb262 Mon Sep 17 00:00:00 2001 From: James Phillips Date: Mon, 15 Aug 2016 15:47:15 -0700 Subject: [PATCH] Updates docs for WAN address translation and tweaks some nearby unrelated docs. --- .../source/docs/agent/options.html.markdown | 35 +++++++++++++------ .../docs/upgrade-specific.html.markdown | 7 ++++ 2 files changed, 31 insertions(+), 11 deletions(-) diff --git a/website/source/docs/agent/options.html.markdown b/website/source/docs/agent/options.html.markdown index ff5e017e4..7428d5d80 100644 --- a/website/source/docs/agent/options.html.markdown +++ b/website/source/docs/agent/options.html.markdown @@ -750,10 +750,20 @@ Consul will not enable TLS for the HTTP API unless the `https` port has been ass * `translate_wan_addrs` If set to true, Consul will prefer a node's configured WAN address - when servicing DNS requests for a node in a remote datacenter. This allows the node to be - reached within its own datacenter using its local address, and reached from other datacenters - using its WAN address, which is useful in hybrid setups with mixed networks. This is disabled - by default. + when servicing DNS and HTTP requests for a node in a remote datacenter. This allows the node to + be reached within its own datacenter using its local address, and reached from other datacenters + using its WAN address, which is useful in hybrid setups with mixed networks. This is disabled by + default. +
+
+ In addition to addresses in DNS responses, Consul will also translate node addresses in responses + to the following HTTP endpoints when querying a remote datacenter: +
+ * [`/v1/catalog/nodes`](/docs/agent/http/catalog.html#catalog_nodes) + * [`/v1/catalog/node/`](/docs/agent/http/catalog.html#catalog_node) + * [`/v1/catalog/service/`](/docs/agent/http/catalog.html#catalog_service) + * [`/v1/health/service/`](/docs/agent/http/health.html#health_service) + * [`/v1/query//execute`](/docs/agent/http/query.html#execute) * `ui` - Equivalent to the [`-ui`](#_ui) command-line flag. @@ -764,20 +774,23 @@ Consul will not enable TLS for the HTTP API unless the `https` port has been ass * `unix_sockets` - This allows tuning the ownership and permissions of the Unix domain socket files created by Consul. Domain sockets are only used if - the HTTP or RPC addresses are configured with the `unix://` prefix. The - following options are valid within this construct and apply globally to all - sockets created by Consul: + the HTTP or RPC addresses are configured with the `unix://` prefix.
- * `user` - The name or ID of the user who will own the socket file. - * `group` - The group ID ownership of the socket file. Note that this option - currently only supports numeric IDs. - * `mode` - The permission bits to set on the file.
It is important to note that this option may have different effects on different operating systems. Linux generally observes socket file permissions while many BSD variants ignore permissions on the socket file itself. It is important to test this feature on your specific distribution. This feature is currently not functional on Windows hosts. +
+
+ The following options are valid within this construct and apply globally to all + sockets created by Consul: +
+ * `user` - The name or ID of the user who will own the socket file. + * `group` - The group ID ownership of the socket file. Note that this option + currently only supports numeric IDs. + * `mode` - The permission bits to set on the file. * `verify_incoming` - If set to true, Consul requires that all incoming diff --git a/website/source/docs/upgrade-specific.html.markdown b/website/source/docs/upgrade-specific.html.markdown index d575906be..7a1b09414 100644 --- a/website/source/docs/upgrade-specific.html.markdown +++ b/website/source/docs/upgrade-specific.html.markdown @@ -38,6 +38,13 @@ making them unable to properly serve requests for prepared queries using the feature. It is recommended that all agents be running version 0.7.0 prior to using this feature. +#### WAN Address Translation in HTTP Endpoints + +Consul version 0.7 added support for translating WAN addresses in certain +[HTTP endpoints](/docs/agent/options.html#translate_wan_addrs). The servers +and the agents need to be running version 0.7.0 or later in order to use this +feature. + ## Consul 0.6.4 Consul 0.6.4 made some substantial changes to how ACLs work with prepared