|
| 1 | +--- |
| 2 | +mapped_pages: |
| 3 | + - https://www.elastic.co/guide/en/elasticsearch/reference/current/remote-clusters-settings.html |
| 4 | +applies_to: |
| 5 | + stack: ga |
| 6 | + serverless: unavailable |
| 7 | +products: |
| 8 | + - id: elasticsearch |
| 9 | +--- |
| 10 | + |
| 11 | +# Remote cluster settings [remote-clusters-settings] |
| 12 | + |
| 13 | +This document describes the client settings available when configuring a remote cluster connection. These settings control how your local cluster connects to and communicates with the remote cluster as a client. For a general overview of remote clusters and how to set them up, refer to [Remote clusters](docs-content://deploy-manage/remote-clusters.md). |
| 14 | + |
| 15 | +For settings related to configuring the remote cluster server interface (used with the [API key-based security model](docs-content://deploy-manage/remote-clusters/remote-clusters-api-key.md)), refer to [Remote cluster network settings](/reference/elasticsearch/configuration-reference/networking-settings.md#remote-cluster-network-settings). |
| 16 | + |
| 17 | +## General remote cluster settings |
| 18 | + |
| 19 | +The following settings apply to both [sniff mode](docs-content://deploy-manage/remote-clusters/remote-clusters-self-managed.md#sniff-mode) and [proxy mode](docs-content://deploy-manage/remote-clusters/remote-clusters-self-managed.md#proxy-mode). Settings that are specific to sniff mode and proxy mode are described separately. |
| 20 | + |
| 21 | +`cluster.remote.<cluster_alias>.mode` |
| 22 | +: The mode used for a remote cluster connection. The only supported modes are `sniff` and `proxy`. The default is `sniff`. See [Connection modes](docs-content://deploy-manage/remote-clusters/remote-clusters-self-managed.md#sniff-proxy-modes) for further information about these modes, and [Sniff mode remote cluster settings](#remote-cluster-sniff-settings) and [Proxy mode remote cluster settings](#remote-cluster-proxy-settings) for further information about their settings. |
| 23 | + |
| 24 | +`cluster.remote.initial_connect_timeout` |
| 25 | +: The time to wait for remote connections to be established when the node starts. The default is `30s`. |
| 26 | + |
| 27 | +`remote_cluster_client` [role](/reference/elasticsearch/configuration-reference/node-settings.md#node-roles) |
| 28 | +: By default, any node in the cluster can act as a cross-cluster client and connect to remote clusters. To prevent a node from connecting to remote clusters, specify the [node.roles](/reference/elasticsearch/configuration-reference/node-settings.md#node-roles) setting in [`elasticsearch.yml`](docs-content://deploy-manage/stack-settings.md) and exclude `remote_cluster_client` from the listed roles. Search requests targeting remote clusters must be sent to a node that is allowed to act as a cross-cluster client. Other features such as {{ml}} [data feeds](/reference/elasticsearch/configuration-reference/machine-learning-settings.md#general-ml-settings), [transforms](/reference/elasticsearch/configuration-reference/transforms-settings.md#general-transform-settings), and [{{ccr}}](docs-content://deploy-manage/tools/cross-cluster-replication/set-up-cross-cluster-replication.md) require the `remote_cluster_client` role. |
| 29 | + |
| 30 | +`cluster.remote.<cluster_alias>.skip_unavailable` |
| 31 | +: Per cluster boolean setting that allows to skip specific clusters when no nodes belonging to them are available and they are the target of a remote cluster request. |
| 32 | + |
| 33 | +::::{important} |
| 34 | +In {{es}} 8.15, the default value for `skip_unavailable` was changed from `false` to `true`. Before {{es}} 8.15, if you want a cluster to be treated as optional for a {{ccs}}, then you need to set that configuration. From {{es}} 8.15 forward, you need to set the configuration in order to make a cluster required for the {{ccs}}. Once you upgrade the local ("querying") cluster search coordinator node (the node you send CCS requests to) to 8.15 or later, any remote clusters that do not have an explicit setting for `skip_unavailable` will immediately change over to using the new default of true. This is true regardless of whether you have upgraded the remote clusters to 8.15, as the `skip_unavailable` search behavior is entirely determined by the setting on the local cluster where you configure the remotes. |
| 35 | +:::: |
| 36 | + |
| 37 | + |
| 38 | +`cluster.remote.<cluster_alias>.transport.ping_schedule` |
| 39 | +: Sets the time interval between regular application-level ping messages that are sent to try and keep remote cluster connections 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. It is preferable to correctly configure TCP keep-alives instead of configuring a `ping_schedule`, because TCP keep-alives are handled by the operating system and not by {{es}}. By default {{es}} enables TCP keep-alives on remote cluster connections. Remote cluster connections are transport connections so the `transport.tcp.*` [advanced settings](/reference/elasticsearch/configuration-reference/networking-settings.md#transport-settings) regarding TCP keep-alives apply to them. |
| 40 | + |
| 41 | +`cluster.remote.<cluster_alias>.transport.compress` |
| 42 | +: Per-cluster setting that enables you to configure compression for requests to a specific remote cluster. The handling cluster will automatically compress responses to compressed requests. The setting options are `true`, `indexing_data`, and `false`. If unset, defaults to the behavior specified by the node-wide `transport.compress` setting. See the [documentation for the `transport.compress` setting](/reference/elasticsearch/configuration-reference/networking-settings.md#transport-settings-compress) for further information. |
| 43 | + |
| 44 | +`cluster.remote.<cluster_alias>.transport.compression_scheme` |
| 45 | +: Per-cluster setting that enables you to configure the compression scheme for requests to a specific cluster if those requests are selected to be compressed by to the `cluster.remote.<cluster_alias>.transport.compress` setting. The handling cluster will automatically use the same compression scheme for responses as for the corresponding requests. The setting options are `deflate` and `lz4`. If unset, defaults to the behavior specified by the node-wide `transport.compression_scheme` setting. See the [documentation for the `transport.compression_scheme` setting](/reference/elasticsearch/configuration-reference/networking-settings.md#transport-settings-compression-scheme) for further information. |
| 46 | + |
| 47 | +$$$remote-cluster-credentials-setting$$$ |
| 48 | + |
| 49 | +`cluster.remote.<cluster_alias>.credentials` |
| 50 | +: ([Secure](docs-content://deploy-manage/security/secure-settings.md), [Reloadable](docs-content://deploy-manage/security/secure-settings.md#reloadable-secure-settings)) Per-cluster setting for configuring [remote clusters with the API Key based model](docs-content://deploy-manage/remote-clusters/remote-clusters-api-key.md). This setting takes the encoded value of a [cross-cluster API key](https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-security-create-cross-cluster-api-key) and must be set in the [{{es}} keystore](docs-content://deploy-manage/security/secure-settings.md) on each node in the cluster. The presence (or not) of this setting determines which model a remote cluster uses. If present, the remote cluster uses the API key based model. Otherwise, it uses the certificate based model. If the setting is added, removed, or updated in the {{es}} keystore and reloaded via the [Nodes reload secure settings](https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-nodes-reload-secure-settings) API, the cluster will automatically rebuild its connection to the remote. |
| 51 | + |
| 52 | +## Sniff mode remote cluster settings [remote-cluster-sniff-settings] |
| 53 | + |
| 54 | +To use [sniff mode](docs-content://deploy-manage/remote-clusters/remote-clusters-self-managed.md#sniff-mode) to connect to a remote cluster, set `cluster.remote.<cluster_alias>.mode: sniff` and then configure the following settings. You may also leave `cluster.remote.<cluster_alias>.mode` unset since `sniff` is the default mode. |
| 55 | + |
| 56 | +`cluster.remote.<cluster_alias>.seeds` |
| 57 | +: The list of seed nodes used to sniff the remote cluster state. |
| 58 | + |
| 59 | +`cluster.remote.<cluster_alias>.node_connections` |
| 60 | +: The number of gateway nodes to connect to for this remote cluster. The default is `3`. |
| 61 | + |
| 62 | +$$$cluster-remote-node-attr$$$ |
| 63 | + |
| 64 | +`cluster.remote.node.attr` |
| 65 | +: A node attribute to filter out nodes that are eligible as a gateway node in the remote cluster. For instance a node can have a node attribute `node.attr.gateway: true` such that only nodes with this attribute will be connected to if `cluster.remote.node.attr` is set to `gateway`. |
| 66 | + |
| 67 | + |
| 68 | +## Proxy mode remote cluster settings [remote-cluster-proxy-settings] |
| 69 | + |
| 70 | +To use [proxy mode](docs-content://deploy-manage/remote-clusters/remote-clusters-self-managed.md#proxy-mode) to connect to a remote cluster, set `cluster.remote.<cluster_alias>.mode: proxy` and then configure the following settings. |
| 71 | + |
| 72 | +`cluster.remote.<cluster_alias>.proxy_address` |
| 73 | +: The address used for all remote connections. A single address value, either an IP address or a fully qualified domain name (FQDN). |
| 74 | + |
| 75 | +`cluster.remote.<cluster_alias>.proxy_socket_connections` |
| 76 | +: The number of socket connections to open per remote cluster. The default is `18`. |
| 77 | + |
| 78 | +`cluster.remote.<cluster_alias>.server_name` |
| 79 | +: An optional hostname string which is sent in the `server_name` field of the TLS Server Name Indication extension if [TLS is enabled](docs-content://deploy-manage/security/secure-cluster-communications.md#encrypt-internode-communication). The TLS transport will fail to open remote connections if this field is not a valid hostname as defined by the TLS SNI specification. |
0 commit comments