-
Notifications
You must be signed in to change notification settings - Fork 163
upgrade docs signifficant refinement #2296
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
Merged
Merged
Changes from all commits
Commits
Show all changes
37 commits
Select commit
Hold shift + click to select a range
0437288
upgrade docs signifficant refinement
eedugon 5687021
conflict solved
eedugon 00bad20
docset updated
eedugon aef71ef
plan upgrade updated
eedugon 19b49c0
link fixed, and minor update
eedugon cf7add6
compatibility checks updated
eedugon a165127
index compatibility and archive statemens improved
eedugon 3cdd2b9
fixing links
eedugon 37eb35a
positioning prepare upgrade doc
eedugon 76261c9
upgrade order small update
eedugon d2f5954
next steps added in upgrade cluster
eedugon 57bea11
APM server updated to Elastic APM
eedugon 76a8723
8.18 statement updated
eedugon 67b4fa1
upgrade paths updated
eedugon b204fdc
prepare upgrade minor change
eedugon 4860f91
version.stack used
eedugon 323df1d
Merge remote-tracking branch 'origin/main' into upgrade_9.1_admin
eedugon 9cdf06e
frontmatters reviewed
eedugon c93e12a
archive wording change
eedugon 168f2d0
Apply suggestions from code review
eedugon 90f4ea5
Merge branch 'main' into upgrade_9.1_admin
eedugon 254305f
Update deploy-manage/upgrade/prepare-to-upgrade.md
eedugon 68acf6a
applying dcturner suggestions
eedugon a91332e
Apply suggestions from code review
eedugon 1575ed9
applying Shaina's suggestions and small change in ECH upgrades
eedugon 36603e6
Update deploy-manage/upgrade/prepare-to-upgrade.md
eedugon 53231fa
applying suggestions
eedugon 69172e9
flexible scheduling change
eedugon 2f2f381
preparation intro update
eedugon 4303303
stepper included in preparations
eedugon d1393ff
Merge branch 'main' into upgrade_9.1_admin
eedugon b1d62f5
availability during upgrades and some final refinement
eedugon 9118992
Merge branch 'main' into upgrade_9.1_admin
eedugon db1e78c
minor update on upgrade order
eedugon 2aa6077
minor update on plan example
eedugon 24c944d
Merge branch 'main' into upgrade_9.1_admin
eedugon 2244bf0
Merge branch 'main' into upgrade_9.1_admin
eedugon 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 hidden or 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,5 @@ | ||
::::{note} | ||
With [{{serverless-full}}](/deploy-manage/deploy/elastic-cloud/serverless.md), upgrades of the Elastic-managed infrastructure and project components are fully handled by Elastic. Users automatically receive the latest features and improvements, with no need to plan or perform project-level upgrades. | ||
|
||
Keep in mind that the [ingest components](/deploy-manage/upgrade/ingest-components.md) or clients you manage externally, such as {{agent}}, {{beats}}, {{ls}}, or custom applications, still need to be updated manually. | ||
:::: |
This file contains hidden or 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 hidden or 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 hidden or 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 |
---|---|---|
@@ -1,14 +1,99 @@ | ||
--- | ||
applies_to: | ||
stack: | ||
deployment: | ||
eck: | ||
ess: | ||
ece: | ||
self: | ||
products: | ||
- id: kibana | ||
- id: cloud-enterprise | ||
- id: cloud-hosted | ||
- id: cloud-kubernetes | ||
- id: elasticsearch | ||
--- | ||
|
||
# Upgrade | ||
|
||
Upgrading to the latest version provides access to the newest Elastic features, enhancements, performance improvements, and bug fixes. These updates reduce costs, speed up threat response, and improve investigative and analytical data tools. | ||
Upgrading to the latest version provides access to the newest Elastic features, security patches, performance improvements, and bug fixes. These updates reduce costs, speed up threat response, and improve investigative and analytical data tools. | ||
|
||
:::{important} | ||
In {{stack}} 9.0.0 and beyond, Enterprise Search is unavailable. For more information, refer to [Migrating to 9.x from Enterprise Search 8.x versions](https://www.elastic.co/guide/en/enterprise-search/8.18/upgrading-to-9-x.html). | ||
As Elastic releases new versions, older versions of Elastic products reach their end of life on a set schedule. To keep your deployment supported, stay up to date. For more information, refer to [Product End of Life Dates](https://www.elastic.co/support/eol). | ||
|
||
:::{include} /deploy-manage/_snippets/serverless-upgrade.md | ||
::: | ||
|
||
When Elastic releases new versions, older versions reach their end of life on a set schedule. To keep your deployment supported, stay up to date. For more information, refer to [Product End of Life Dates](https://www.elastic.co/support/eol). | ||
The upgrade procedure depends on how your deployment is managed. If you're using {{ech}} or {{ece}}, upgrades can often be performed with a single click in the {{ecloud}} UI. For self-managed deployments, upgrades must be carried out manually using a rolling upgrade process, upgrading the nodes one by one to minimize downtime and ensure cluster stability. | ||
|
||
This section provides guidance to help you plan and safely perform upgrades of your {{stack}} components, with a primary focus on {{es}} and {{kib}} as the core of the stack. It also covers upgrades for orchestration platforms like {{ece}} and {{eck}}, as well as related components such as APM, {{beats}}, {{agent}}, and {{ls}}. | ||
|
||
:::{note} | ||
Upgrading from a release candidate build, such as 9.0.0-rc1, is unsupported. Use pre-releases only for testing in a temporary environment. | ||
:::{important} | ||
In {{stack}} 9.0.0 and beyond, Enterprise Search is unavailable. For more information, refer to [Migrating to 9.x from Enterprise Search 8.x versions](https://www.elastic.co/guide/en/enterprise-search/8.19/upgrading-to-9-x.html). | ||
::: | ||
|
||
## Upgrade overview | ||
|
||
Upgrading your Elastic cluster or deployment involves several stages, including planning, preparation, and execution. This section guides you through the full upgrade process: | ||
|
||
- [Plan your upgrade](./upgrade/plan-upgrade.md): Review compatibility, define your upgrade path and order, and understand important pre-upgrade considerations. | ||
|
||
- [Prepare to upgrade](./upgrade/prepare-to-upgrade.md): Follow detailed preparation steps for major, minor, and patch upgrades. Identify breaking changes, run the Upgrade Assistant (for major upgrades), and verify readiness. | ||
|
||
- [Upgrade your deployment or cluster](./upgrade/deployment-or-cluster.md): Step-by-step instructions for performing the upgrade, organized by deployment type: | ||
|
||
- [Upgrade deployments on {{ech}}](/deploy-manage/upgrade/deployment-or-cluster/upgrade-on-ech.md) | ||
- [Upgrade deployments on {{ece}}](/deploy-manage/upgrade/deployment-or-cluster/upgrade-on-ece.md) | ||
- [Upgrade deployments on {{eck}}](/deploy-manage/upgrade/deployment-or-cluster/upgrade-on-eck.md) | ||
- [Upgrade self-managed clusters](/deploy-manage/upgrade/deployment-or-cluster/self-managed.md) | ||
|
||
- [Upgrade ingest components](./upgrade/ingest-components.md): Covers supporting components such as {{beats}}, {{agent}}, {{ls}}, and APM Server. | ||
|
||
Additionally, if you're using a self-managed orchestration platform such as {{ece}} or {{eck}}, refer to [Upgrade your ECE or ECK orchestrator](/deploy-manage/upgrade/orchestrator.md) to keep the orchestrator up to date. | ||
|
||
## Availability during upgrades | ||
|
||
{{es}} supports rolling upgrades, where nodes are upgraded one at a time to minimize downtime and ensure cluster stability. If your deployment or cluster follows high availability best practices, such as using replicated indices and distributing nodes across multiple availability zones, it should remain available throughout the entire upgrade process. | ||
|
||
{{kib}} upgrades, however, require downtime. All running instances must be shut down before starting the upgrade. | ||
|
||
::::{important} | ||
Ensure your deployment is properly sized and configured for high availability to reduce the risk of service interruption during upgrades. | ||
|
||
If you want to learn more about scaling, high availability, and performance, refer to: | ||
* [Run {{es}} in production](/deploy-manage/production-guidance/elasticsearch-in-production-environments.md) | ||
* [Run {{kib}} in production](/deploy-manage/production-guidance/kibana-in-production-environments.md) | ||
* [{{ech}} > Plan for production](/deploy-manage/deploy/elastic-cloud/elastic-cloud-hosted-planning.md) | ||
:::: | ||
|
||
You’ll find more information about availability considerations for specific deployment types in the related upgrade guides within this section. | ||
|
||
## Upgrade paths [upgrade-paths] | ||
|
||
You can upgrade to a higher version if the target version was released *after* your current version. Upgrades to versions released *before* your current version are not supported, even if the version number is higher. Refer to [out-of-order releases](/deploy-manage/upgrade/deployment-or-cluster.md#out-of-order-releases) for more information. | ||
|
||
For example: | ||
- ✅ Upgrade allowed: From 9.0.4 to 9.1.0 (9.1.0 released *after* 9.0.4) | ||
- ❌ Not allowed: From 9.0.5 to 9.1.0 (9.1.0 released *before* 9.0.5) → wait for 9.1.1 to be released | ||
<!-- | ||
Uncomment this example when 9.1.1 is released. | ||
- ✅ Upgrade allowed: From 9.0.5 to 9.1.1 (9.1.1 released *after* 9.0.5) | ||
--> | ||
|
||
### Upgrade paths from 8.x [upgrade-paths-8.x] | ||
|
||
To perform a major upgrade from 8.x, the required starting version depends on the target release: | ||
|
||
- To upgrade to the **9.0.x series**, you must be on **8.18.x**. | ||
- To upgrade to **9.1.0 or later**, you must be on **8.19.x**, which is the latest minor release of the 8.x series. | ||
|
||
::::{note} | ||
While 8.19 is the final minor release in the 8.x series, 8.18 was released at the same time as 9.0, enabling a supported upgrade path between the 8.18.x and 9.0.x series. This compatibility also applies to other features and clients. | ||
:::: | ||
|
||
If you're upgrading to the current {{version.stack}} release from an earlier 8.x version, first upgrade to the latest available 8.19 release. | ||
|
||
#### Ingest tools and clients considerations | ||
|
||
For flexible upgrade scheduling, 8.19 {{agent}}, {{beats}}, and {{ls}} are compatible with all 9.x versions of {{es}}. | ||
|
||
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 cluster. |
This file contains hidden or 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
7 changes: 7 additions & 0 deletions
7
deploy-manage/upgrade/deployment-or-cluster/archived-settings.md
This file contains hidden or 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 hidden or 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 hidden or 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 hidden or 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
Oops, something went wrong.
Oops, something went wrong.
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.
Uh oh!
There was an error while loading. Please reload this page.