Skip to content

Commit 073b13f

Browse files
committed
Add docs for cluster.remote.*.proxy setting (#40281)
In #33062 we introduced the `cluster.remote.*.proxy` setting for proxied connections to remote clusters, but left it deliberately undocumented since it needed followup work so that it could work with SNI. However, since #32517 is now closed we can add this documentation and remove the comment about its lack of documentation.
1 parent ddc385d commit 073b13f

File tree

2 files changed

+9
-3
lines changed

2 files changed

+9
-3
lines changed

docs/reference/modules/remote-clusters.asciidoc

+9-1
Original file line numberDiff line numberDiff line change
@@ -227,7 +227,7 @@ PUT _cluster/settings
227227
clusters are kept alive. If set to `-1`, application-level ping messages to
228228
this remote cluster are not sent. If unset, application-level ping messages
229229
are sent according to the global `transport.ping_schedule` setting, which
230-
defaults to ``-1` meaning that pings are not sent.
230+
defaults to `-1` meaning that pings are not sent.
231231

232232
`cluster.remote.${cluster_alias}.transport.compress`::
233233

@@ -237,6 +237,14 @@ PUT _cluster/settings
237237
Elasticsearch compresses the response. If unset, the global
238238
`transport.compress` is used as the fallback setting.
239239

240+
`cluster.remote.${cluster_alias}.proxy`::
241+
242+
Sets a proxy address for the specified remote cluster. By default this is not
243+
set, meaning that Elasticsearch will connect directly to the nodes in the
244+
remote cluster using their <<advanced-network-settings,publish addresses>>.
245+
If this setting is set to an IP address or hostname then Elasticsearch will
246+
connect to the nodes in the remote cluster using this address instead.
247+
240248
[float]
241249
[[retrieve-remote-clusters-info]]
242250
=== Retrieving remote clusters info

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

-2
Original file line numberDiff line numberDiff line change
@@ -144,8 +144,6 @@ public String getKey(final String key) {
144144

145145
/**
146146
* A proxy address for the remote cluster.
147-
* NOTE: this settings is undocumented until we have at last one transport that supports passing
148-
* on the hostname via a mechanism like SNI.
149147
*/
150148
public static final Setting.AffixSetting<String> REMOTE_CLUSTERS_PROXY = Setting.affixKeySetting(
151149
"cluster.remote.",

0 commit comments

Comments
 (0)