-
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
Changes from 5 commits
677c8d7
68a7a9d
0ed22d4
442d4f9
a91bbda
e7c6f01
7b29312
File filter
Filter by extension
Conversations
Jump to
Diff view
Diff view
There are no files selected for viewing
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,48 @@ | ||
[role="xpack"] | ||
[testenv="platinum"] | ||
[[ccr-upgrading]] | ||
== Upgrading clusters | ||
|
||
In case of upgrading clusters, clusters that are actively using CCR, require a | ||
slightly different upgrade approach. 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 | ||
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. Same here, There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. pushed: e7c6f01 |
||
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]]. | ||
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. Can you end with a newline here? |
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.
Sorry, I should have noticed this before. Let's use
{ccr}
. Let's reword this first sentence to:Clusters that are actively using {ccr} require a careful approach to upgrades.
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.
pushed: e7c6f01