Skip to content

Commit

Permalink
Add docs for cluster.remote.*.proxy setting (elastic#40281)
Browse files Browse the repository at this point in the history
In elastic#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 elastic#32517 is
now closed we can add this documentation and remove the comment about its lack
of documentation.
  • Loading branch information
DaveCTurner authored Mar 28, 2019
1 parent 5ceef9e commit d696e57
Show file tree
Hide file tree
Showing 2 changed files with 9 additions and 3 deletions.
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

0 comments on commit d696e57

Please sign in to comment.