Skip to content

Commit c01f58a

Browse files
authored
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.
1 parent 588aecf commit c01f58a

File tree

2 files changed

+4
-9
lines changed

2 files changed

+4
-9
lines changed

docs/reference/modules/remote-clusters.asciidoc

Lines changed: 0 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -245,14 +245,6 @@ PUT _cluster/settings
245245
Elasticsearch compresses the response. If unset, the global
246246
`transport.compress` is used as the fallback setting.
247247

248-
`cluster.remote.${cluster_alias}.proxy`::
249-
250-
Sets a proxy address for the specified remote cluster. By default this is not
251-
set, meaning that Elasticsearch will connect directly to the nodes in the
252-
remote cluster using their <<advanced-network-settings,publish addresses>>.
253-
If this setting is set to an IP address or hostname then Elasticsearch will
254-
connect to the nodes in the remote cluster using this address instead.
255-
256248
[float]
257249
[[retrieve-remote-clusters-info]]
258250
=== Retrieving remote clusters info

server/src/main/java/org/elasticsearch/transport/RemoteClusterAware.java

Lines changed: 4 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -72,7 +72,10 @@ public abstract class RemoteClusterAware {
7272
public static final String LOCAL_CLUSTER_GROUP_KEY = "";
7373

7474
/**
75-
* A proxy address for the remote cluster.
75+
* A proxy address for the remote cluster. By default this is not set, meaning that Elasticsearch will connect directly to the nodes in
76+
* the remote cluster using their publish addresses. If this setting is set to an IP address or hostname then Elasticsearch will connect
77+
* to the nodes in the remote cluster using this address instead. Use of this setting is not recommended and it is deliberately
78+
* undocumented as it does not work well with all proxies.
7679
*/
7780
public static final Setting.AffixSetting<String> REMOTE_CLUSTERS_PROXY = Setting.affixKeySetting(
7881
"cluster.remote.",

0 commit comments

Comments
 (0)