Skip to content

Doc: Added a direct reference to remote cluster page #47185

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

Merged
merged 1 commit into from
Sep 26, 2019

Conversation

ppf2
Copy link
Member

@ppf2 ppf2 commented Sep 26, 2019

This has come up multiple times from the field in the past. Some users have trouble finding version compatibility information for CCR clusters, even though this information is well documented at https://www.elastic.co/guide/en/elasticsearch/reference/7.3/modules-remote-clusters.html.

We are actually implicitly linking the above already via the link to the Kibana documentation as part of this statement: "For more information about managing cross-cluster replication in Kibana, see Working with remote clusters." (the Kibana docs then link back to the remote clusters page).

CCS documentation (https://www.elastic.co/guide/en/elasticsearch/reference/7.3/modules-cross-cluster-search.html) has a nice explicit link to remote clusters at the beginning of the page. This is just an attempt to adopt the same note at the beginning of the CCR documentation for consistency. Hopefully, this will make it easier for end users to find the nice compatibility information upfront.

This has come up multiple times from the field in the past.  Some users have trouble finding version compatibility information for CCR clusters.  This information is well documented at https://www.elastic.co/guide/en/elasticsearch/reference/7.3/modules-remote-clusters.html.  

We are actually implicitly linking this already via the link to the Kibana documentation in this statement:  "For more information about managing cross-cluster replication in Kibana, see Working with remote clusters." (Kibana docs then link to the remote clusters page).

CCS documentation (https://www.elastic.co/guide/en/elasticsearch/reference/7.3/modules-cross-cluster-search.html) has a nice explicit link to remote clusters at the beginning of the page.  This is just an attempt to adopt the same note at the beginning of the CCR documentation for consistency.  Hopefully, this will make it easier for end users to find the nice compatibility information upfront.
@ppf2 ppf2 added :Distributed Indexing/CCR Issues around the Cross Cluster State Replication features :Docs labels Sep 26, 2019
@elasticmachine
Copy link
Collaborator

Pinging @elastic/es-docs

@elasticmachine
Copy link
Collaborator

Pinging @elastic/es-distributed

Copy link
Contributor

@jrodewig jrodewig left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

LGTM. Thanks @ppf2.

@jasontedor
Copy link
Member

@ppf2 This doesn't answer the compatibility question though, CCR has a stricter compatibility requirement than remote clusters do. The local cluster (the one that is pulling from the remote cluster) must be of a compatible version equal to or newer than the version of the remote cluster. The reason is the same as for allocation of replicas: the local cluster must be able to understand the Lucene segment files that are sent to it, as well as any index settings, mappings, etc.

@ppf2
Copy link
Member Author

ppf2 commented Sep 27, 2019

Ah thanks!

@jrodewig We do have something similar under the upgrading section of the doc. It can be helpful to also add this as part of the important note under Overview for users who are not upgrading, but simply setting up CCR when their clusters are already on different versions.

@jrodewig
Copy link
Contributor

Thanks @jasontedor and @ppf2. I created #47218 so we can track this request and change.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
:Distributed Indexing/CCR Issues around the Cross Cluster State Replication features >docs General docs changes v6.8.0 v7.0.0 v7.1.0 v7.2.0 v7.3.0 v7.4.0 v7.5.0 v8.0.0-alpha1
Projects
None yet
Development

Successfully merging this pull request may close these issues.

6 participants