Skip to content

Commit a1da6ac

Browse files
committed
Update prepare-to-upgrade.md
1 parent f97d288 commit a1da6ac

File tree

1 file changed

+35
-4
lines changed

1 file changed

+35
-4
lines changed

deploy-manage/upgrade/prepare-to-upgrade.md

Lines changed: 35 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -19,7 +19,7 @@ By default, 8.x {{es}} clients are compatible with 9.0.0 and use [REST API compa
1919

2020
Review the best practices to upgrade your deployments.
2121

22-
1. Run the [Upgrade Assistant](prepare-to-upgrade/upgrade-assistant.md), which identifies deprecated settings, helps resolve issues, and reindexes data streams and indices created in 8.0.0 and earlier.
22+
1. Run the [Upgrade Assistant](prepare-to-upgrade/upgrade-assistant.md), which identifies deprecated settings, helps resolve issues, reindexes data streams and indices created in 8.0.0 and earlier, or marks them as read-only.
2323

2424
:::{note}
2525
Depending on your setup, reindexing can change your indices, and you may need to update alerts, transforms, or other code targeting the old index.
@@ -54,9 +54,11 @@ Review the best practices to upgrade your deployments.
5454
8. If you use a separate [monitoring cluster](/deploy-manage/monitor/stack-monitoring/elasticsearch-monitoring-self-managed.md), upgrade the monitoring cluster before the production cluster. The monitoring cluster and the clusters being monitored should be running the same version of the {{stack}}. Monitoring clusters are unable to monitor production clusters running newer versions of the {{stack}}. If necessary, the monitoring cluster can monitor production clusters running the latest release of the previous major version.
5555

5656
:::{note}
57-
If you use {{ccs}}, 9.0.0 and later can search only remote clusters running the previous minor version, the same version, or a newer minor version in the same major version. For more information, refer to [Cross-cluster search](../../solutions/search/cross-cluster-search.md).
57+
If you use {{ccs}}, 9.0.0 and later can search only remote clusters running the previous minor version, the same version, or a newer minor version in the same major version. For more information, refer to [{{ccs-cap}}](../../solutions/search/cross-cluster-search.md).
5858

59-
If you use {{ccr}}, a cluster that contains follower indices must run the same or newer (compatible) version as the remote cluster. For more information and to view the version compatibility matrix, refer to [Cross cluster replication](/deploy-manage/tools/cross-cluster-replication.md). To view your remote clusters in {{kib}}, go to **Stack Management > Remote Clusters**.
59+
If you use {{ccr}}, a cluster that contains follower indices must run the same or newer (compatible) version as the remote cluster. For more information and to view the version compatibility matrix, refer to [{{ccr-cap}}](/deploy-manage/tools/cross-cluster-replication.md). To view your remote clusters in {{kib}}, go to **Stack Management > Remote Clusters**.
60+
61+
In addition, if you have {{ccr-init}} data streams, refer to [Upgrade uni-directional {{ccr}} clusters with followed data streams](#upgrade-ccr-data-streams) for specific instructions on reindexing.
6062
::::
6163

6264
9. To reduce overhead on the cluster during the upgrade, close {{ml}} jobs. Although {{ml}} jobs can run during a rolling upgrade, doing so increases the cluster workload.
@@ -73,7 +75,36 @@ Optionally create a 9.0.0 deployment and reindex from remote:
7375
1. Provision an additional deployment running 9.0.0.
7476
2. To reindex your data into the new {{es}} cluster, use the [reindex documents API](https://www.elastic.co/docs/api/doc/elasticsearch/v8/operation/operation-reindex) and temporarily send new index requests to both clusters.
7577
3. Verify the new cluster performs as expected, fix any problems, and then permanently swap in the new cluster.
76-
4. Delete the old deployment. On {ecloud}, you are billed only for the time the new deployment runs in parallel with your old deployment. Usage is billed on an hourly basis.
78+
4. Delete the old deployment. On {{ecloud}}, you are billed only for the time the new deployment runs in parallel with your old deployment. Usage is billed on an hourly basis.
79+
80+
## Upgrade uni-directional {{ccr}} clusters with followed data streams [upgrade-ccr-data-streams]
81+
82+
When moving to a new major version of {{es}}, you must perform specific actions to ensure that indices — including those that back a data stream — are compatible with the latest Lucene version. With a {{ccr-init}}-enabled cluster, consider whether you want to keep your older data writable or read only to ensure you make changes to the cluster in the correct order.
83+
84+
:::{note}
85+
{{ccr-init}}-replicated data streams only allow writing to the most recent backing index as ILM automatically injects an unfollow event after every rollover. Therefore, you can't reindex data streams while {{ccr-init}} is replicating the target backing indices.
86+
:::
87+
88+
### Migrate read-only historical data
89+
90+
If you want to keep your older data as read only:
91+
92+
1. Issue a rollover for all replicated data streams on the follower cluster to ensure the write index will be compatible with the version you're upgrading to.
93+
2. Run the Upgrade Assistant on the {{ccr-init}} follower cluster and resolve any data stream deprecation notices, selecting the option to not reindex and allow the backing indices to become read-only after upgrading.
94+
3. Upgrade the {{ccr-init}} follower cluster to the appropriate version. Ensure you take a snapshot before starting the upgrade.
95+
4. Run the Upgrade Assistant on the {{ccr-init}} leader cluster and repeat the same steps as the follower cluster, opting to not reindex.
96+
5. Upgrade the leader cluster and ensure {{ccr-init}} replication is healthy.
97+
98+
### Migrate read-write historical data
99+
100+
If you need to write directly to non-write backing indices of data streams in a {{ccr-init}}-replicated cluster pair:
101+
102+
1. Before upgrading, remove the data stream and all follower indices from the {{ccr-init}} follower.
103+
2. Run the Upgrade Assistant and select the “Reindex” option.
104+
3. Once the reindexing is complete and the leader cluster is upgraded, re-add the newly reindexed backing indexes as follower indices on the {{ccr-init}} follower.
105+
106+
107+
77108

78109

79110
## Migrate anomaly detection results [anomaly-migration]

0 commit comments

Comments
 (0)