From 18bdba0b0a31e0deff19e5ff2466dd86895e1896 Mon Sep 17 00:00:00 2001 From: Sarah Hersh Date: Thu, 14 Mar 2019 10:53:37 -0400 Subject: [PATCH] replaces ccr and ccs with attributes --- .../management-cross-cluster-search.asciidoc | 41 +++++++++---------- .../managing-remote-clusters.asciidoc | 21 +++++----- docs/security/cross-cluster-kibana.asciidoc | 16 ++++---- 3 files changed, 39 insertions(+), 39 deletions(-) diff --git a/docs/management/index-patterns/management-cross-cluster-search.asciidoc b/docs/management/index-patterns/management-cross-cluster-search.asciidoc index e613806eb4450..e0e630acc930c 100644 --- a/docs/management/index-patterns/management-cross-cluster-search.asciidoc +++ b/docs/management/index-patterns/management-cross-cluster-search.asciidoc @@ -1,31 +1,30 @@ [[management-cross-cluster-search]] -=== Cross Cluster Search +=== {ccs-cap} -Elasticsearch supports the ability to run search and aggregation requests across multiple -clusters using a module called _cross cluster search_. +{es} supports the ability to run search and aggregation requests across multiple +clusters using a module called _{ccs}_. -In order to take advantage of cross cluster search, you must configure your Elasticsearch -clusters accordingly. Review the corresponding Elasticsearch -{ref}/modules-cross-cluster-search.html[documentation] before attempting to use cross cluster -search in Kibana. +In order to take advantage of {ccs}, you must configure your {es} +clusters accordingly. Review the corresponding {es} +{ref}/modules-cross-cluster-search.html[documentation] before attempting to use {ccs} in {kib}. -Once your Elasticsearch clusters are configured for cross cluster search, you can create -specific index patterns in Kibana to search across the clusters of your choosing. Using the -same syntax that you'd use in a raw cross cluster search request in Elasticsearch, create your -index pattern in Kibana with the convention `:`. +Once your {es} clusters are configured for {ccs}, you can create +specific index patterns in {kib} to search across the clusters of your choosing. Using the +same syntax that you'd use in a raw {ccs} request in {es}, create your +index pattern in {kib} with the convention `:`. -For example, if you want to query logstash indices across two of the Elasticsearch clusters -that you set up for cross cluster search, which were named `cluster_one` and `cluster_two`, -you would use `cluster_one:logstash-*,cluster_two:logstash-*` as your index pattern in Kibana. +For example, if you want to query {ls} indices across two of the {es} clusters +that you set up for {ccs}, which were named `cluster_one` and `cluster_two`, +you would use `cluster_one:logstash-*,cluster_two:logstash-*` as your index pattern in {kib}. -Just like in raw search requests in Elasticsearch, you can use wildcards in your cluster names -to match any number of clusters, so if you wanted to search logstash indices across any +Just like in raw search requests in {es}, you can use wildcards in your cluster names +to match any number of clusters, so if you wanted to search {ls} indices across any clusters named `cluster_foo`, `cluster_bar`, and so on, you would use `cluster_*:logstash-*` -as your index pattern in Kibana. +as your index pattern in {kib}. -If you want to query across all Elasticsearch clusters that have been configured for cross -cluster search, then use a standalone wildcard for your cluster name in your Kibana index +If you want to query across all {es} clusters that have been configured for cross +cluster search, then use a standalone wildcard for your cluster name in your {kib} index pattern: `*:logstash-*`. -Once an index pattern is configured using the cross cluster search syntax, all searches and -aggregations using that index pattern in Kibana take advantage of cross cluster search. +Once an index pattern is configured using the {ccs} syntax, all searches and +aggregations using that index pattern in {kib} take advantage of {ccs}. diff --git a/docs/management/managing-remote-clusters.asciidoc b/docs/management/managing-remote-clusters.asciidoc index 4a8d672c26c6b..05e669796a852 100644 --- a/docs/management/managing-remote-clusters.asciidoc +++ b/docs/management/managing-remote-clusters.asciidoc @@ -1,12 +1,12 @@ -[[managing-remote-clusters]] -== Managing Remote Clusters +[[working-remote-clusters]] +== Working with remote clusters {kib} *Management* provides two user interfaces for working with data from remote clusters. *Remote Clusters* helps you manage remote clusters for use with -{ref}/modules-cross-cluster-search.html[cross cluster search] and -{xpack-ref}/xpack-ccr.html[cross cluster replication]. You can add and remove remote +{ref}/modules-cross-cluster-search.html[{ccs}] and +{stack-ov}/xpack-ccr.html[{ccr}]. You can add and remove remote clusters and check their connectivity. Go to *Management > Elasticsearch > Remote Clusters* to get started. @@ -14,13 +14,14 @@ Go to *Management > Elasticsearch > Remote Clusters* to get started. [role="screenshot"] image::images/add_remote_cluster.png[][UI for adding a remote cluster] +[float] +[[managing-cross-cluster-replication]] +=== [xpack]#Managing {ccr}# +*{ccr-cap}* includes tools to help you create and manage the {ccr} process. +You can follow an index pattern on the remote cluster for auto-discovery and then +replicate new indices in the local cluster that match the auto-follow pattern. -*Cross Cluster Replication* includes tools to help you create and manage the remote -replication process. You can follow an index pattern on the remote cluster for -auto-discovery and then replicate new indices in the local cluster that match the -auto-follow pattern. - -Go to *Management > Elasticsearch > Cross Cluster Replication* to get started. +Go to *Management > Elasticsearch > {ccr-cap}* to get started. [role="screenshot"] image::images/auto_follow_pattern.png[][UI for adding an auto-follow pattern] diff --git a/docs/security/cross-cluster-kibana.asciidoc b/docs/security/cross-cluster-kibana.asciidoc index bd8bb053d65a0..95e5d188f0084 100644 --- a/docs/security/cross-cluster-kibana.asciidoc +++ b/docs/security/cross-cluster-kibana.asciidoc @@ -1,16 +1,16 @@ [[cross-cluster-kibana]] -==== Cross Cluster Search and Kibana +==== {ccs-cap} and {kib} -When Kibana is used to search across multiple clusters, a two-step authorization +When {kib} is used to search across multiple clusters, a two-step authorization process determines whether or not the user can access indices on a remote cluster: * First, the local cluster determines if the user is authorized to access remote -clusters. (The local cluster is the cluster Kibana is connected to.) +clusters. (The local cluster is the cluster {kib} is connected to.) * If they are, the remote cluster then determines if the user has access to the specified indices. -To grant Kibana users access to remote clusters, assign them a local role +To grant {kib} users access to remote clusters, assign them a local role with read privileges to indices on the remote clusters. You specify remote cluster indices as `:`. @@ -18,10 +18,10 @@ To enable users to actually read the remote indices, you must create a matching role on the remote clusters that grants the `read_cross_cluster` privilege and access to the appropriate indices. -For example, if Kibana is connected to the cluster where you're actively -indexing Logstash data (your _local cluster_) and you're periodically +For example, if {kib} is connected to the cluster where you're actively +indexing {ls} data (your _local cluster_) and you're periodically offloading older time-based indices to an archive cluster -(your _remote cluster_) and you want to enable Kibana users to search both +(your _remote cluster_) and you want to enable {kib} users to search both clusters: . On the local cluster, create a `logstash_reader` role that grants @@ -31,7 +31,7 @@ NOTE: If you configure the local cluster as another remote in {es}, the `logstash_reader` role on your local cluster also needs to grant the `read_cross_cluster` privilege. -. Assign your Kibana users the `kibana_user` role and your `logstash_reader` +. Assign your {kib} users the `kibana_user` role and your `logstash_reader` role. . On the remote cluster, create a `logstash_reader` role that grants the