Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Add docs for cluster.remote.*.proxy setting #40281

Merged
Show file tree
Hide file tree
Changes from 2 commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
10 changes: 9 additions & 1 deletion docs/reference/modules/remote-clusters.asciidoc
Original file line number Diff line number Diff line change
Expand Up @@ -227,7 +227,7 @@ PUT _cluster/settings
clusters are kept alive. If set to `-1`, application-level ping messages to
this remote cluster are not sent. If unset, application-level ping messages
are sent according to the global `transport.ping_schedule` setting, which
defaults to ``-1` meaning that pings are not sent.
defaults to `-1` meaning that pings are not sent.

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

Expand All @@ -237,6 +237,14 @@ 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
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -145,8 +145,6 @@ public String getKey(final String key) {

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