Skip to content

Commit a165127

Browse files
committed
index compatibility and archive statemens improved
1 parent cf7add6 commit a165127

File tree

2 files changed

+17
-11
lines changed

2 files changed

+17
-11
lines changed

deploy-manage/upgrade/plan-upgrade.md

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -38,6 +38,8 @@ Before upgrading, verify that your current environment supports the version you
3838
`REST API compatibility` is a per-request opt-in feature that can help REST clients mitigate non-compatible (breaking) changes to the REST API.
3939
::::
4040

41+
* **Index compatibility**: {{es}} provides full query and write support for indices created in the previous major version. If you have indices created in 7.x or earlier, you must reindex, delete, or [mark them as read-only](/deploy-manage/upgrade/deployment-or-cluster/reading-indices-from-older-elasticsearch-versions.md) before upgrading to 9.x. This topic is covered during the [upgrade preparations](prepare-to-upgrade.md#prepare-to-upgrade-from-8.x), with help from the Upgrade Assistant.
42+
4143
* **{{es}} upgrade path**: Check the [upgrade paths](../upgrade.md#upgrade-paths) to determine whether you must upgrade through an intermediate version (such as 8.19.x before moving to 9.x), or if you can upgrade directly to the target version.
4244

4345
* **OpenJDK compatibility and FIPS compliance**: By default, {{es}} is built using Java and includes a bundled version of [OpenJDK](https://openjdk.java.net/) within each distribution. While we strongly recommend using the bundled Java Virtual Machine (JVM) in all installations of {{es}}, if you choose to use your own JVM, ensure it’s compatible by reviewing the [Product and JVM support matrix](https://www.elastic.co/support/matrix#matrix_jvm).

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

Lines changed: 15 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -81,10 +81,7 @@ The following steps are common to all types of upgrades, regardless if you are u
8181

8282
## Additional preparation steps to upgrade from 8.x [prepare-upgrade-from-8.x]
8383

84-
Major upgrades require additional planning and preparation, as they often introduce a significant number of breaking changes and require additional steps to ensure a smooth transition. The main challenges when preparing for a major version upgrade include:
85-
86-
* Reindexing any indices created before 8.0.0, including those used by {{ml}} and transform jobs.
87-
* Identifying and applying changes needed to accommodate breaking changes.
84+
Major upgrades require additional planning and preparation, as they often introduce a significant number of breaking changes and require additional steps to ensure a smooth transition.
8885

8986
To assist with this process, use the [Upgrade Assistant](prepare-to-upgrade/upgrade-assistant.md), which helps detect deprecated settings, highlights upgrade blockers, and guides you through the required actions.
9087

@@ -108,6 +105,7 @@ Follow these steps to prepare for a successful major upgrade from 8.x to 9.x:
108105

109106
:::{note}
110107
For flexible upgrade scheduling, 8.19.x {{beats}} and {{ls}} are compatible with 9.x {{es}}.
108+
111109
By default, 8.x {{es}} clients are compatible with 9.x and use [REST API compatibility](elasticsearch://reference/elasticsearch/rest-apis/compatibility.md) to maintain compatibility with the 9.x {{es}} server.
112110
:::
113111

@@ -121,20 +119,26 @@ Follow these steps to prepare for a successful major upgrade from 8.x to 9.x:
121119

122120
Considerations when using the upgrade assistant:
123121

124-
1. Before you change configurations or reindex, ensure you have a current [snapshot](/deploy-manage/tools/snapshot-and-restore/create-snapshots.md).
122+
1. For a successful upgrade, **resolve all critical issues reported by the assistant**.
125123

126-
:::{tip}
127-
In 8.3.0 and later, snapshots are generally available as simple archives. You can use the [archive functionality](/deploy-manage/upgrade/deployment-or-cluster/reading-indices-from-older-elasticsearch-versions.md) to search snapshots from 5.0.0 and later without needing an old {{es}} cluster. This ensures that your {{es}} data remains accessible after upgrading, without requiring a reindex process.
128-
:::
124+
2. Before you apply configuration changes or reindex, ensure you have a current [snapshot](/deploy-manage/tools/snapshot-and-restore/create-snapshots.md).
125+
126+
3. Indices created in 7.x or earlier must be reindexed or deleted before upgrading to 9.x. Alternatively, you can use the [archive functionality](/deploy-manage/upgrade/deployment-or-cluster/reading-indices-from-older-elasticsearch-versions.md) to enable read-only access to them in 9.x. Keep in mind that {{es}} nodes will fail to start if incompatible indices are present.
127+
128+
::::{tip}
129+
In Elasticsearch 9.x, you can use the [archive functionality](/deploy-manage/upgrade/deployment-or-cluster/reading-indices-from-older-elasticsearch-versions.md) to access snapshots of 7.x or earlier indices, without needing to reindex or run an older cluster. This provides a convenient option to retain historical data in case you choose to delete those indices and keep them only in existing snapshots.
130+
::::
129131

130-
2. For a successful upgrade, resolve all critical issues reported by the assistant. If you make additional changes, create a snapshot to back up your data.
132+
3. Review the deprecation logs from the Upgrade Assistant to determine if your applications are using features that are not supported or behave differently in 9.x. See the [breaking changes](/release-notes/breaking-changes.md) for more information about changes in 9.x that could affect your application.
131133

132-
3. To identify if your applications use unsupported features or behave differently in 9.x, review the deprecation logs in the Upgrade Assistant.
134+
::::{note}
135+
Make sure you check the breaking changes for each 9.x release up to your target release.
136+
::::
133137

134138
4. Make the recommended changes to ensure your clients continue operating as expected after the upgrade.
135139

136140
:::{note}
137-
As a temporary solution, use the 8.x syntax to submit requests to 9.x with REST API compatibility mode. While this allows you to submit requests using the old syntax, it doesn’t guarantee the same behavior. REST API compatibility should serve as a bridge during the upgrade, not a long-term solution. For more details on how to effectively use REST API compatibility during an upgrade, refer to [REST API compatibility](elasticsearch://reference/elasticsearch/rest-apis/compatibility.md).
141+
As a temporary solution, use the 8.x syntax to submit requests to 9.x with REST API compatibility mode. While this allows you to submit requests using the old syntax, it doesn’t guarantee the same behavior. REST API compatibility should serve as a bridge during the upgrade, not a long-term solution. For more details on how to effectively use REST API compatibility during an upgrade, refer to [REST API compatibility](elasticsearch://reference/elasticsearch/rest-apis/compatibility.md).
138142
:::
139143

140144
3. **{{ccr-cap}} (CCR)**

0 commit comments

Comments
 (0)