-
Notifications
You must be signed in to change notification settings - Fork 25k
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
Add minimal docs around upgrading clusters with ccr enabled #38037
Merged
Merged
Changes from 6 commits
Commits
Show all changes
7 commits
Select commit
Hold shift + click to select a range
677c8d7
Add minimal docs around upgrading clusters with ccr enabled
martijnvg 68a7a9d
Merge remote-tracking branch 'es/master' into ccr_upgrading_docs
martijnvg 0ed22d4
applied feedback without creating new page
martijnvg 442d4f9
moved upgrading docs to separate page
martijnvg a91bbda
iter
martijnvg e7c6f01
iter
martijnvg 7b29312
added new line
martijnvg File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,48 @@ | ||
[role="xpack"] | ||
[testenv="platinum"] | ||
[[ccr-upgrading]] | ||
== Upgrading clusters | ||
|
||
Clusters that are actively using {ccr} require a careful approach to upgrades. | ||
Otherwise index following may fail during a rolling upgrade, because of the | ||
following reasons: | ||
|
||
* If a new index setting or mapping type is replicated from an upgraded cluster | ||
to a non-upgraded cluster then the non-upgraded cluster will reject that and | ||
will fail index following. | ||
* Lucene is not forwards compatible and when index following is falling back to | ||
file based recovery then a node in a non-upgraded cluster will reject index | ||
files from a newer Lucene version compared to what it is using. | ||
|
||
Rolling upgrading clusters with {ccr} is different in case of uni-directional | ||
index following and bi-directional index following. | ||
|
||
[float] | ||
=== Uni-directional index following | ||
|
||
In a uni-directional setup between two clusters, one cluster contains only | ||
leader indices, and the other cluster contains only follower indices following | ||
indices in the first cluster. | ||
|
||
In this setup, the cluster with follower indices should be upgraded | ||
first and the cluster with leader indices should be upgraded last. | ||
If clusters are upgraded in this order then index following can continue | ||
during the upgrade without downtime. | ||
|
||
Note that a chain index following setup can also be upgraded in this way. | ||
For example if there is a cluster A that contains all leader indices, | ||
cluster B that follows indices in cluster A and cluster C that follows | ||
indices in cluster B. In this case the cluster C should be upgraded first, | ||
then cluster B and finally cluster A. | ||
|
||
[float] | ||
=== Bi-directional index following | ||
|
||
In a bi-directional setup between two clusters, each cluster contains both | ||
leader and follower indices. | ||
|
||
When upgrading clusters in this setup, all index following needs to be paused | ||
using the {ref}/ccr-post-pause-follow.html[pause follower API] prior to | ||
upgrading both clusters. After both clusters have been upgraded then index | ||
following can be resumed using the | ||
{ref}/ccr-post-resume-follow.html[resume follower API]]. | ||
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Can you end with a newline here?