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.
This commit is contained in:
David Turner 2019-09-13 22:17:03 +01:00
parent c0a16047fa
commit 272b0ecbdd
2 changed files with 4 additions and 9 deletions

View File

@ -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 <<advanced-network-settings,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.
[float]
[[retrieve-remote-clusters-info]]
=== Retrieving remote clusters info

View File

@ -143,7 +143,10 @@ public abstract class RemoteClusterAware {
};
/**
* 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<String> REMOTE_CLUSTERS_PROXY = Setting.affixKeySetting(
"cluster.remote.",