Skip to content

Commit be162ca

Browse files
Apply suggestions from code review
Co-authored-by: shainaraskas <[email protected]>
1 parent c24fdee commit be162ca

File tree

1 file changed

+23
-21
lines changed

1 file changed

+23
-21
lines changed

deploy-manage/upgrade/deployment-or-cluster/upgrade-717.md

Lines changed: 23 additions & 21 deletions
Original file line numberDiff line numberDiff line change
@@ -20,11 +20,13 @@ Upgrading from 7.17 to {{version.stack}} requires two major upgrades. Each major
2020
Before running this upgrade, all ingest components and client libraries must be upgraded to 7.17.x.
2121

2222
2. **8.19.x → {{version.stack}}**
23+
2324
This completes the upgrade to the latest 9.x release.
25+
2426
Before running this upgrade, all ingest components and client libraries must be upgraded to 8.19.x.
2527

2628
:::{note}
27-
Upgrading only to version 8.19.x is also a supported path, as it remains a maintained and fully supported release. However, we recommend completing the upgrade to the latest {{version.stack}} version to take advantage of performance ongoing improvements and new features.
29+
Upgrading only as far as {{stack}} 8.19.x is also a supported path, as 8.19.x remains a maintained and fully supported release. However, we recommend completing the upgrade to the latest version, {{version.stack}}, to take advantage of ongoing performance improvements and new features.
2830
:::
2931

3032
The following sections describe these phases in detail and point to the relevant documentation for each deployment type.
@@ -82,19 +84,19 @@ For the 7.17.x → 9.x upgrade path, the main planning outcome is a set of requi
8284

8385
Finally, we strongly recommend [testing the full upgrade process in a non-production environment](/deploy-manage/upgrade/plan-upgrade.md#test-in-a-non-production-environment) before applying it to production.
8486

85-
## Upgrade Step 1: 7.17.x → 8.19.x
87+
## Upgrade step 1: 7.17.x → 8.19.x
8688

8789
This step covers upgrading your deployment from 7.17.x to 8.19.x, following the [planning phase](#planning) and assuming that all ingest components and client libraries are compatible with 8.19.x.
8890

89-
It's highly recommended to start this upgrade from the latest 7.17.x patch release to ensure that you’re using the most recent version of the **Upgrade Assistant**. You should also upgrade to the latest available 8.19.x patch release so that the same benefits apply when you later upgrade to 9.x.
91+
It's highly recommended to start this upgrade from the latest 7.17.x patch release to ensure that you’re using the most recent version of the Elastic Upgrade Assistant. You should also upgrade to the latest available 8.19.x patch release so that the same benefits apply when you later upgrade to 9.x.
9092

9193
### 8.19 upgrade preparations
9294

9395
The [upgrade preparation steps from 7.x](https://www.elastic.co/guide/en/elastic-stack/8.19/upgrading-elastic-stack.html#prepare-to-upgrade) are designed to prevent upgrade failures by detecting and addressing internal incompatibilities, including deprecated settings that are no longer supported in the next release.
9496

95-
During a major upgrade, the [**Upgrade Assistant**](https://www.elastic.co/guide/en/kibana/7.17/upgrade-assistant.html) in {{kib}} 7.17 plays a critical role. It scans your cluster for deprecated settings, incompatible indices, and other issues that could prevent nodes from starting after the upgrade. The tool guides you through reindexing old indices, fixing configuration problems, and reviewing deprecation logs to ensure your deployment is fully compatible with the next major version. Ignoring its recommendations can lead to upgrade failures or cluster downtime.
97+
During a major upgrade, the [Upgrade Assistant](https://www.elastic.co/guide/en/kibana/7.17/upgrade-assistant.html) in {{kib}} 7.17 plays a critical role. It scans your cluster for deprecated settings, incompatible indices, and other issues that could prevent nodes from starting after the upgrade. The tool guides you through reindexing old indices, fixing configuration problems, and reviewing deprecation logs to ensure your deployment is fully compatible with the next major version. Ignoring its recommendations can lead to upgrade failures or cluster downtime.
9698

97-
While the **Upgrade Assistant** helps you identify breaking changes that affect your deployment or cluster, it's still recommended to review the complete list of breaking changes and known issues in every release from your current version through your target version as part of the preparation phase. These are available in the following documents:
99+
While the Upgrade Assistant helps you identify breaking changes that affect your deployment or cluster, it's still recommended to review the complete list of breaking changes and known issues in every release from your current version through your target version as part of the preparation phase. These are available in the following documents:
98100
* [{{es}} 8.x migration guide](https://www.elastic.co/guide/en/elasticsearch/reference/8.19/breaking-changes.html)
99101
* [Kibana breaking changes summary](https://www.elastic.co/guide/en/kibana/8.19/breaking-changes-summary.html)
100102

@@ -166,7 +168,7 @@ Upgrade preparations for an {{eck}}-managed cluster are similar to a self-manage
166168

167169
As part of your preparation, make sure to complete all tasks reported by the **Upgrade Assistant**, review any installed plugins for compatibility, and check whether custom client applications are affected by API-related breaking changes so you can address them before the upgrade.
168170

169-
If you're running an {{eck}} version earlier than 3.x, consider [upgrading ECK](/deploy-manage/upgrade/orchestrator/upgrade-cloud-on-k8s.md) at this stage. Although not required for the 7.17 → 8.19 upgrade, ECK 3.x or later is needed before performing the final upgrade to 9.x.
171+
If you're running an {{eck}} version earlier than 3.x, consider [upgrading ECK](/deploy-manage/upgrade/orchestrator/upgrade-cloud-on-k8s.md) at this stage. Although this is not required for the 7.17 → 8.19 upgrade, ECK 3.x or later is needed before performing the final upgrade to 9.x.
170172
::::
171173

172174
::::{applies-item} self:
@@ -228,7 +230,7 @@ To upgrade your cluster to 8.19, follow the steps in [Upgrade on ECK](/deploy-ma
228230
For more information on how ECK manages upgrades and how to tune its behavior, refer to [Nodes orchestration](/deploy-manage/deploy/cloud-on-k8s/nodes-orchestration.md).
229231
:::
230232

231-
After upgrading {{es}} and {{kib}}, upgrade any [other Elastic applications](/deploy-manage/deploy/cloud-on-k8s/orchestrate-other-elastic-applications.md) connected to the cluster, such as {{fleet-server}} or Elastic APM.
233+
After upgrading {{es}} and {{kib}}, upgrade any [other Elastic applications](/deploy-manage/deploy/cloud-on-k8s/orchestrate-other-elastic-applications.md) connected to the cluster, such as {{fleet-server}} or Elastic APM using the same variable.
232234
::::
233235

234236
::::{applies-item} self:
@@ -283,11 +285,11 @@ At this point, you have a fully operational {{stack}} 8.19.x environment. You ca
283285
However, we recommend upgrading to {{version.stack}} to benefit from the latest features and performance improvements.
284286
:::
285287

286-
## Upgrade Step 2: 8.19.x → {{version.stack}}
288+
## Upgrade step 2: 8.19.x → {{version.stack}}
287289

288290
This step covers upgrading your deployment from 8.19.x to {{version.stack}}, assuming that all ingest components have been upgraded to 8.19.x, and client libraries are compatible with 9.x.
289291

290-
It's highly recommended to start this upgrade from the latest 8.19.x patch release to ensure that you’re using the most recent version of the **Upgrade Assistant**.
292+
It's highly recommended to start this upgrade from the latest 8.19.x patch release to ensure that you’re using the most recent version of the Upgrade Assistant.
291293

292294
:::::{important} note for Enterprise Search users
293295
In {{stack}} 9.0.0 and later, Enterprise Search is no longer available.
@@ -299,9 +301,9 @@ In {{stack}} 9.0.0 and later, Enterprise Search is no longer available.
299301

300302
The [upgrade preparation steps](/deploy-manage/upgrade/prepare-to-upgrade.md) are designed to prevent upgrade failures by detecting and addressing internal incompatibilities, including deprecated settings that are no longer supported in the next release.
301303

302-
During a major upgrade, the [**Upgrade Assistant**](/deploy-manage/upgrade/prepare-to-upgrade/upgrade-assistant.md) in {{kib}} 8.19 plays a critical role. It scans your cluster for deprecated settings, incompatible indices, and other issues that could prevent nodes from starting after the upgrade. The tool guides you through reindexing old 7.x indices or marking them as read-only, fixing configuration problems, and reviewing deprecation logs to ensure your deployment is fully compatible with the next major version. Ignoring its recommendations can lead to upgrade failures or cluster downtime.
304+
During a major upgrade, the [Upgrade Assistant](/deploy-manage/upgrade/prepare-to-upgrade/upgrade-assistant.md) in {{kib}} 8.19 plays a critical role. It scans your cluster for deprecated settings, incompatible indices, and other issues that could prevent nodes from starting after the upgrade. The tool guides you through reindexing old 7.x indices or marking them as read-only, fixing configuration problems, and reviewing deprecation logs to ensure your deployment is fully compatible with the next major version. Ignoring its recommendations can lead to upgrade failures or cluster downtime.
303305

304-
While the **Upgrade Assistant** helps you identify breaking changes that affect your deployment or cluster, it's still recommended to review the complete list of breaking changes and known issues in every release from your current version through your target version as part of the preparation phase. These are available in the following documents:
306+
While the Upgrade Assistant helps you identify breaking changes that affect your deployment or cluster, it's still recommended to review the complete list of breaking changes and known issues in every release from your current version through your target version as part of the preparation phase. These are available in the following documents:
305307
* [{{es}} 9.x breaking changes](elasticsearch://release-notes/breaking-changes.md)
306308
* [Kibana breaking changes summary](kibana://release-notes/breaking-changes.md)
307309

@@ -316,9 +318,9 @@ The {{ecloud}} platform facilitates major upgrades by doing the following:
316318
* Detecting deprecated settings and index compatibility issues.
317319
* Blocking the upgrade until all issues are resolved through the Upgrade Assistant, ensuring a reliable outcome.
318320

319-
To prepare your deployment for the upgrade, review the [prepare to upgrade guide](/deploy-manage/upgrade/prepare-to-upgrade.md). You should make sure to:
321+
To prepare your deployment for the upgrade, review the [Prepare to upgrade](/deploy-manage/upgrade/prepare-to-upgrade.md) guide. You should make sure to:
320322

321-
1. [Run the **Upgrade Assistant**](/deploy-manage/upgrade/prepare-to-upgrade.md#run-the-upgrade-assistant) in {{kib}} and resolve all critical issues before continuing.
323+
1. [Run the Upgrade Assistant](/deploy-manage/upgrade/prepare-to-upgrade.md#run-the-upgrade-assistant) in {{kib}} and resolve all critical issues before continuing.
322324

323325
As described in the linked guide, the assistant helps you:
324326
* Reindex or mark as read-only legacy indices and data streams (created before 8.0).
@@ -327,7 +329,7 @@ To prepare your deployment for the upgrade, review the [prepare to upgrade guide
327329
* Remove Enterprise Search if it's part of the deployment.
328330

329331
:::{note}
330-
If the **Upgrade Assistant** reports old {{ml}}, {{ccr}}, or transform indices that require action or reindexing, make sure to review the relevant sections in the preparations guide:
332+
If the Upgrade Assistant reports old {{ml}}, {{ccr}}, or transform indices that require action or reindexing, make sure to review the relevant sections in the preparations guide:
331333
* [Manage CCR follower data streams](/deploy-manage/upgrade/prepare-to-upgrade.md#manage-ccr-follower-data-streams)
332334
* [Manage old Machine Learning indices](/deploy-manage/upgrade/prepare-to-upgrade.md#manage-old-machine-learning-indices)
333335
* [Manage old Transform indices](/deploy-manage/upgrade/prepare-to-upgrade.md#manage-old-transform-indices)
@@ -382,24 +384,24 @@ You should make sure to:
382384
::::
383385

384386

385-
::::{applies-item} { eck: }
387+
::::{applies-item} eck:
386388

387389
:::{important}
388390
If you're running an {{eck}} version earlier than 3.x, ensure that you [upgrade ECK first](/deploy-manage/upgrade/orchestrator/upgrade-cloud-on-k8s.md). ECK 2.x is not compatible with {{stack}} version 9.
389391
:::
390392

391393
Upgrade preparations for an ECK-managed cluster are similar to a self-managed deployment.
392394

393-
Before starting the upgrade follow the steps in [prepare to upgrade](/deploy-manage/upgrade/prepare-to-upgrade.md).
395+
Before starting the upgrade, follow the steps in [Prepare to upgrade](/deploy-manage/upgrade/prepare-to-upgrade.md).
394396

395-
As part of your preparation, make sure to complete all tasks reported by the **Upgrade Assistant**, review any installed plugins for compatibility, and check whether custom client applications are affected by API-related breaking changes so you can address them before the upgrade.
397+
As part of your preparation, make sure to complete all tasks reported by the Upgrade Assistant, review any installed plugins for compatibility, and check whether custom client applications are affected by API-related breaking changes so you can address them before the upgrade.
396398
::::
397399

398400
::::{applies-item} self:
399401

400-
Before starting the upgrade, follow the [prepare to upgrade](/deploy-manage/upgrade/prepare-to-upgrade.md) steps.
402+
Before starting the upgrade, follow the steps in [Prepare to upgrade](/deploy-manage/upgrade/prepare-to-upgrade.md).
401403

402-
As part of your preparation, make sure to complete all tasks reported by the **Upgrade Assistant**, review any installed plugins for compatibility, and check whether custom client applications are affected by API-related breaking changes so you can address them before the upgrade.
404+
As part of your preparation, make sure to complete all tasks reported by the Upgrade Assistant, review any installed plugins for compatibility, and check whether custom client applications are affected by API-related breaking changes so you can address them before the upgrade.
403405
::::
404406

405407
:::::
@@ -472,7 +474,7 @@ After upgrading your deployment or cluster to {{version.stack}}, review your ing
472474

473475
All custom-developed applications that rely on [{{es}} client libraries](/reference/elasticsearch-clients/index.md) must be upgraded to the latest {{version.stack}} client version to guarantee full API compatibility and support for new features.
474476

475-
For ingest components, version 8.19.x remains fully compatible with the entire 9.x series. You can keep running them on 8.19.x if you prefer a gradual rollout. However, we recommend upgrading to {{version.stack}} to take advantage of ongoing improvements and feature enhancements.
477+
For ingest components, version 8.19.x remains fully compatible with the entire 9.x series. You can keep running them on 8.19.x if you prefer a gradual rollout. However, we recommend upgrading to {{version.stack}} to take advantage of ongoing improvements and new features.
476478

477479
For more details, refer to the documentation of the following products and client libraries:
478480

@@ -491,7 +493,7 @@ For more details, refer to the documentation of the following products and clien
491493
* [.NET](elasticsearch-net://reference/index.md)
492494
* [PHP](elasticsearch-php://reference/index.md)
493495
* [Python](elasticsearch-py://reference/index.md)
494-
* [Eland](eland://reference/index.md)
496+
* [Eland](eland://reference/index.md)
495497
* [Ruby](elasticsearch-ruby://reference/index.md)
496498
* [Rust](elasticsearch-rs://reference/index.md)
497499
::::

0 commit comments

Comments
 (0)