github-mirrors/elasticsearch
1
0
Fork 0
mirror of https://github.com/elastic/elasticsearch.git synced 2025-04-25 07:37:19 -04:00
Code Issues Projects Releases Packages Wiki Activity

Clarify remote_cluster_client role (#70186)

Browse source 
This commit addresses two aspects of the description in the docs of
configuring a local node to be a remote cluster client. First, the
documentation was referring to the legacy setting for configuring a
remote cluster client. Secondly, we clarify that additional features,
not only cross-cluster search, have requirements around the usage of the
remote_cluster_client role.

Co-authored-by: Przemysław Witek <przemyslaw.witek@elastic.co>
Co-authored-by: James Rodewig <40268737+jrodewig@users.noreply.github.com>
This commit is contained in:
Jason Tedor 2021-03-11 20:28:26 -05:00 • committed by GitHub
parent 3a814a2053
commit cfad8376f4
No known key found for this signature in database
GPG key ID: 4AEE18F83AFDEB23
2 changed files with 14 additions and 5 deletions
Download patch file Download diff file Expand all files Collapse all files

6
docs/reference/ccr/getting-started.asciidoc
View file

@ -83,6 +83,12 @@ indices on the local cluster. <<stack-management-ccr-local,Configure local clust
* An index on the remote cluster that contains the data you want to replicate. * An index on the remote cluster that contains the data you want to replicate.
This tutorial uses the sample eCommerce orders data set. This tutorial uses the sample eCommerce orders data set.
{kibana-ref}/get-started.html#gs-get-data-into-kibana[Load sample data]. {kibana-ref}/get-started.html#gs-get-data-into-kibana[Load sample data].
* In the local cluster, all nodes with the `master` <<node-roles,node role>> must
also have the <<remote-node,`remote_cluster_client`>> role. The local cluster
must also have at least one node with both a data role and the
<<remote-node,`remote_cluster_client`>> role. Individual tasks for coordinating
replication scale based on the number of data nodes with the
`remote_cluster_client` role in the local cluster.
[[ccr-getting-started-remote-cluster]] [[ccr-getting-started-remote-cluster]]
==== Connect to a remote cluster ==== Connect to a remote cluster

13
docs/reference/modules/remote-clusters.asciidoc
View file

@ -258,13 +258,16 @@ separately.
The time to wait for remote connections to be established when the node The time to wait for remote connections to be established when the node
starts. The default is `30s`. starts. The default is `30s`.
`node.remote_cluster_client`:: `remote_cluster_client` <<node-roles,role>>::
By default, any node in the cluster can act as a cross-cluster client and By default, any node in the cluster can act as a cross-cluster client and
connect to remote clusters. The `node.remote_cluster_client` setting can be connect to remote clusters. To prevent a node from connecting to remote
set to `false` (defaults to `true`) to prevent certain nodes from connecting clusters, specify the <<node-roles,node.roles>> setting in `elasticsearch.yml`
to remote clusters. Remote cluster requests must be sent to a node that is and exclude `remote_cluster_client` from the listed roles. Search requests
allowed to act as a cross-cluster client. targeting remote clusters must be sent to a node that is allowed to act as a
cross-cluster client. Other features such as {ml} <<general-ml-settings,data
feeds>>, <<general-transform-settings,transforms>>, and
<<ccr-getting-started,{ccr}>> require the `remote_cluster_client` role.
`cluster.remote.<cluster_alias>.skip_unavailable`:: `cluster.remote.<cluster_alias>.skip_unavailable`::