From f534fcc6442e7bea77a0040f845e9568c058edcb Mon Sep 17 00:00:00 2001 From: David Turner Date: Fri, 13 Sep 2019 22:17:03 +0100 Subject: [PATCH] Remove docs for proxy mode (#46677) We added docs for proxy mode in #40281 but on reflection we should not be documenting this setting since it does not play well with all proxies and we can't recommend its use. This commit removes those docs and expands its Javadoc instead. --- docs/reference/modules/remote-clusters.asciidoc | 8 -------- .../org/elasticsearch/transport/RemoteClusterAware.java | 5 ++++- 2 files changed, 4 insertions(+), 9 deletions(-) diff --git a/docs/reference/modules/remote-clusters.asciidoc b/docs/reference/modules/remote-clusters.asciidoc index 52fe0ba42064e..c3048ee2b86cf 100644 --- a/docs/reference/modules/remote-clusters.asciidoc +++ b/docs/reference/modules/remote-clusters.asciidoc @@ -245,14 +245,6 @@ PUT _cluster/settings Elasticsearch compresses the response. If unset, the global `transport.compress` is used as the fallback setting. -`cluster.remote.${cluster_alias}.proxy`:: - - Sets a proxy address for the specified remote cluster. By default this is not - set, meaning that Elasticsearch will connect directly to the nodes in the - remote cluster using their <>. - If this setting is set to an IP address or hostname then Elasticsearch will - connect to the nodes in the remote cluster using this address instead. - [float] [[retrieve-remote-clusters-info]] === Retrieving remote clusters info diff --git a/server/src/main/java/org/elasticsearch/transport/RemoteClusterAware.java b/server/src/main/java/org/elasticsearch/transport/RemoteClusterAware.java index f54c1d2cc23d1..e65f39e8c7c18 100644 --- a/server/src/main/java/org/elasticsearch/transport/RemoteClusterAware.java +++ b/server/src/main/java/org/elasticsearch/transport/RemoteClusterAware.java @@ -143,7 +143,10 @@ public String getKey(final String key) { }; /** - * A proxy address for the remote cluster. + * A proxy address for the remote cluster. By default this is not set, meaning that Elasticsearch will connect directly to the nodes in + * the remote cluster using their publish addresses. If this setting is set to an IP address or hostname then Elasticsearch will connect + * to the nodes in the remote cluster using this address instead. Use of this setting is not recommended and it is deliberately + * undocumented as it does not work well with all proxies. */ public static final Setting.AffixSetting REMOTE_CLUSTERS_PROXY = Setting.affixKeySetting( "cluster.remote.",