From 320b07c025c04945f45360fa6564809023b3330f Mon Sep 17 00:00:00 2001 From: Brian Shumate Date: Mon, 3 Oct 2016 12:15:24 -0400 Subject: [PATCH 1/2] Clarify retry_join addresses for #1462 - Initial pass at adding note about address formats for retry_join; IPv4 is a list of IPs only, whereas IPv6 are bracketed IPs + port --- website/source/docs/agent/options.html.markdown | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/website/source/docs/agent/options.html.markdown b/website/source/docs/agent/options.html.markdown index 9d25da28d4..bc371abbb1 100644 --- a/website/source/docs/agent/options.html.markdown +++ b/website/source/docs/agent/options.html.markdown @@ -658,7 +658,7 @@ Consul will not enable TLS for the HTTP API unless the `https` port has been ass * `retry_join` Equivalent to the [`-retry-join` command-line flag](#_retry_join). Takes a list of addresses to attempt joining every [`retry_interval`](#_retry_interval) until at least one - [`-join`](#_join) works. + [`-join`](#_join) works. The list should contain IPv4 addresses without port number or bracketed IPv6 addresses with the Serf LAN port number also specified — for example: `[::1]:8301`. * `retry_interval` Equivalent to the [`-retry-interval` command-line flag](#_retry_interval). From 17dfb0b196cd4a3a414b4e7a6a0a7271c4081c5f Mon Sep 17 00:00:00 2001 From: Brian Shumate Date: Thu, 20 Oct 2016 14:14:55 -0400 Subject: [PATCH 2/2] Reworded and applied to -retry-join also --- website/source/docs/agent/options.html.markdown | 8 +++++--- 1 file changed, 5 insertions(+), 3 deletions(-) diff --git a/website/source/docs/agent/options.html.markdown b/website/source/docs/agent/options.html.markdown index bc371abbb1..1b13c5e9f7 100644 --- a/website/source/docs/agent/options.html.markdown +++ b/website/source/docs/agent/options.html.markdown @@ -180,8 +180,10 @@ will exit with an error at startup. * `-retry-join` - Similar to [`-join`](#_join) but allows retrying a join if the first - attempt fails. This is useful for cases where we know the address will become - available eventually. + attempt fails. The list should contain IPv4 addresses with optional Serf + LAN port number also specified or bracketed IPv6 addresses with optional + port number — for example: `[::1]:8301`. This is useful for cases where we + know the address will become available eventually. * `-retry-interval` - Time to wait between join attempts. Defaults to 30s. @@ -658,7 +660,7 @@ Consul will not enable TLS for the HTTP API unless the `https` port has been ass * `retry_join` Equivalent to the [`-retry-join` command-line flag](#_retry_join). Takes a list of addresses to attempt joining every [`retry_interval`](#_retry_interval) until at least one - [`-join`](#_join) works. The list should contain IPv4 addresses without port number or bracketed IPv6 addresses with the Serf LAN port number also specified — for example: `[::1]:8301`. + [`-join`](#_join) works. The list should contain IPv4 addresses with optional Serf LAN port number also specified or bracketed IPv6 addresses with optional port number — for example: `[::1]:8301`. * `retry_interval` Equivalent to the [`-retry-interval` command-line flag](#_retry_interval).