Skip to content
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

Upgrade doc updates #977

Merged
merged 4 commits into from
Mar 28, 2025
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
9 changes: 8 additions & 1 deletion deploy-manage/upgrade/deployment-or-cluster.md
Original file line number Diff line number Diff line change
Expand Up @@ -11,6 +11,13 @@ mapped_urls:
- https://www.elastic.co/guide/en/elastic-stack/current/upgrading-elastic-stack-on-prem.html
- https://www.elastic.co/guide/en/cloud-on-k8s/current/k8s-upgrading-stack.html
- https://www.elastic.co/guide/en/elasticsearch/reference/current/setup-upgrade.html
applies_to:
stack:
deployment:
eck:
ess:
ece:
self:
---

# Upgrade your deployment or cluster [upgrade-deployment-cluster]
Expand All @@ -26,6 +33,6 @@ If you’re using Elastic-managed infrastructure, use the following options:

If you’re using self-managed infrastructure - either on-prem or public cloud - use the following options:

* [Upgrade the {{stack}}](/deploy-manage/upgrade/deployment-or-cluster/self-managed.md)
* [Upgrade the {{stack}} on a self-managed cluster](/deploy-manage/upgrade/deployment-or-cluster/self-managed.md)
* [Upgrade on {{ece}} (ECE)](/deploy-manage/upgrade/deployment-or-cluster/upgrade-on-ece.md)
* [Upgrade on {{eck}} (ECK)](/deploy-manage/upgrade/deployment-or-cluster/upgrade-on-eck.md)
12 changes: 10 additions & 2 deletions deploy-manage/upgrade/deployment-or-cluster/elasticsearch.md
Original file line number Diff line number Diff line change
@@ -1,5 +1,6 @@
---
applies_to:
stack:
deployment:
self: all
---
Expand Down Expand Up @@ -95,7 +96,7 @@ To upgrade a cluster:
::::{tip}
When you extract the zip or tarball packages, the `elasticsearch-{{bare_version}}` directory contains the {{es}} `config`, `data`, and `logs` directories.

We recommend moving these directories out of the {{es}} directory so that there is no chance of deleting them when you upgrade {{es}}. To specify the new locations, use the `ES_PATH_CONF` environment variable and the `path.data` and `path.logs` settings. For more information, see [Important {{es}} configuration](../../../deploy-manage/deploy/self-managed/important-settings-configuration.md).
We recommend moving these directories out of the {{es}} directory so that there is no chance of deleting them when you upgrade {{es}}. To specify the new locations, use the `ES_PATH_CONF` environment variable and the `path.data` and `path.logs` settings. For more information, refer to [Important {{es}} configuration](../../../deploy-manage/deploy/self-managed/important-settings-configuration.md).

The Debian and RPM packages place these directories in the appropriate place for each operating system. In production, we recommend using the deb or rpm package.

Expand Down Expand Up @@ -199,4 +200,11 @@ Similarly, if you run a testing/development environment with a single master nod

## Archived settings [archived-settings]

If you upgrade an {{es}} cluster that uses deprecated cluster or index settings that are not used in the target version, they are archived. We recommend you remove any archived settings after upgrading. For more information, see [Archived settings](../../../deploy-manage/upgrade/deployment-or-cluster/archived-settings.md).
If you upgrade an {{es}} cluster that uses deprecated cluster or index settings that are not used in the target version, they are archived. We recommend you remove any archived settings after upgrading. For more information, refer to [Archived settings](../../../deploy-manage/upgrade/deployment-or-cluster/archived-settings.md).

## Next steps

Once you've successfully upgraded {{es}}, continue upgrading the remaining {{stack}} components:
* [{{kib}}](/deploy-manage/upgrade/deployment-or-cluster/kibana.md)
* [Elastic APM](../../../solutions/observability/apps/upgrade.md)
* [Ingest components](/deploy-manage/upgrade/ingest-components.md)
11 changes: 8 additions & 3 deletions deploy-manage/upgrade/deployment-or-cluster/kibana.md
Original file line number Diff line number Diff line change
@@ -1,5 +1,6 @@
---
applies_to:
stack:
deployment:
self: all
---
Expand Down Expand Up @@ -54,7 +55,7 @@ To upgrade {{kib}}:
2. To install the `deb` or `rpm` package:

a. Use `rpm` or `dpkg`. This installs all files in their proper locations and will not overwrite the config files.
b. Upgrade any plugins by removing the existing plugin and reinstalling the appropriate version using the `kibana-plugin` script. For more information, see [{{kib}} plugins](kibana://reference/kibana-plugins.md).
b. Upgrade any plugins by removing the existing plugin and reinstalling the appropriate version using the `kibana-plugin` script. For more information, refer to [{{kib}} plugins](kibana://reference/kibana-plugins.md).

3. To install from a `zip` or `tar.gz` archive:

Expand All @@ -66,10 +67,14 @@ To upgrade {{kib}}:
If you use {{monitor-features}}, you must re-use the data directory when you upgrade {{kib}}. Otherwise, the {{kib}} instance is assigned a new persistent UUID and becomes a new instance in the monitoring data.
::::

d. Install the appropriate versions of all your plugins for your new installation using the `kibana-plugin` script. For more information, see [{{kib}} plugins](kibana://reference/kibana-plugins.md).
d. Install the appropriate versions of all your plugins for your new installation using the `kibana-plugin` script. For more information, refer to [{{kib}} plugins](kibana://reference/kibana-plugins.md).

4. Start {{kib}}.

::::{note}
{{kib}} 8.0.0 and later uses a new logging system, so the log formats have changed. For additional information, see [Logging configuration changes](kibana://extend/logging-config-changes.md).
{{kib}} 8.0.0 and later uses a new logging system, so the log formats have changed. For additional information, refer to [Logging configuration changes](kibana://extend/logging-config-changes.md).
::::

## Next steps

Once you've successfully upgraded {{kib}}, [upgrade Elastic APM](../../../solutions/observability/apps/upgrade.md), then [upgrade your ingest components](/deploy-manage/upgrade/ingest-components.md).
12 changes: 10 additions & 2 deletions deploy-manage/upgrade/deployment-or-cluster/self-managed.md
Original file line number Diff line number Diff line change
@@ -1,4 +1,12 @@
# Upgrade Elastic on a self-managed cluster
---
navigation_title: "Upgrade Elastic on a self-managed cluster"
applies_to:
stack:
deployment:
self:
---

# Upgrade the {{stack}} on a self-managed cluster

If you've installed the {{stack}} on your own self-managed infrastructure, once you're [prepared to upgrade](/deploy-manage/upgrade/prepare-to-upgrade.md), you'll need to upgrade each of your Elastic components individually.

Expand All @@ -9,6 +17,6 @@ It's important that you upgrade your components in this order:
* [Ingest components](/deploy-manage/upgrade/ingest-components.md)

:::{important}
If you're using {{ls}} and the `logstash-filter-elastic_integration plugin` to extend Elastic integrations, upgrade {{ls}} (or the `logstash-filter-elastic_integration` plugin specifically) *before* you upgrade {{kib}}.
If you're using {{ls}} and the `logstash-filter-elastic_integration` [plugin](logstash-docs-md://lsr/plugins-filters-elastic_integration.md) to extend Elastic integrations, upgrade {{ls}} (or the `logstash-filter-elastic_integration` plugin specifically) *before* you upgrade {{kib}}.

The {{es}} → {{ls}} → {{kib}} installation order for this specific plugin ensures the best experience with {{agent}}-managed pipelines, and embeds functionality from a version of {{es}} Ingest Node that is compatible with the plugin version (`major.minor`).
8 changes: 6 additions & 2 deletions deploy-manage/upgrade/deployment-or-cluster/upgrade-on-ece.md
Original file line number Diff line number Diff line change
@@ -1,12 +1,16 @@
---
navigation_title: "Upgrade on {{ece}}"
applies_to:
stack:
deployment:
ece:
---

# Upgrade your deployment on {{ece}} (ECE)

Similar to {{ech}}, a single click in the {{ecloud}} console can upgrade a deployment running on ECE to a newer version, add more processing capacity, change plugins, and enable or disable high availability, all at the same time. During the upgrade process, {{es}}, {{kib}}, and all of your deployment components are upgraded simultaneously.
A single click in the {{ecloud}} console can upgrade a deployment running on ECE to a newer version, add more processing capacity, change plugins, and enable or disable high availability, all at the same time. During the upgrade process, {{es}}, {{kib}}, Elastic APM, and all of your deployment components are upgraded simultaneously.

Once you're prepared to upgrade, do the following:
Once you're [prepared to upgrade](/deploy-manage/upgrade/prepare-to-upgrade.md), do the following:

% Note: Add a link once confirmed where prepare to upgrade will reside in TOC.

Expand Down
10 changes: 7 additions & 3 deletions deploy-manage/upgrade/deployment-or-cluster/upgrade-on-ech.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,13 +4,17 @@ mapped_pages:
- https://www.elastic.co/guide/en/cloud-heroku/current/ech-upgrading-v6.html
- https://www.elastic.co/guide/en/cloud-heroku/current/ech-upgrading-v5.html
navigation_title: "Upgrade on {{ech}}"
applies_to:
stack:
deployment:
ess:
---

# Upgrade on {{ech}} (ECH)

Once you are [prepared to upgrade](../../../deploy-manage/upgrade/deployment-or-cluster.md), a single click in the {{ecloud}} console can upgrade a deployment to a newer version, add more processing capacity, change plugins, and enable or disable high availability, all at the same time. During the upgrade process, {{es}}, {{kib}}, and all of your deployment components are upgraded simultaneously.
Once you are [prepared to upgrade](/deploy-manage/upgrade/prepare-to-upgrade.md), a single click in the {{ecloud}} console can upgrade a deployment to a newer version, add more processing capacity, change plugins, and enable or disable high availability, all at the same time. During the upgrade process, {{es}}, {{kib}}, Elastic APM, and all of your deployment components are upgraded simultaneously.

Minor version upgrades, upgrades from 8.18 to 9.0, and cluster configuration changes can be performed with no downtime. {{ecloud}} only supports upgrades to released versions. Release candidate builds and master snapshots are not supported.
You can perform minor version upgrades, upgrades from 8.18 to 9.0.0, and cluster configuration changes with no downtime. {{ecloud}} only supports upgrades to released versions. Release candidate builds and master snapshots are not supported.

::::{important}
Although it’s simple to upgrade an {{ecloud}} deployment, the new version might include breaking changes that affect your application. Ensure you review breaking changes and deprecation logs, make any necessary changes, and test against the new version before upgrading your production deployment.
Expand Down Expand Up @@ -49,6 +53,6 @@ Security realm settings
1. On the **Update security realm settings** window, edit the settings.
2. Click **Update settings**. If the security realm settings are located in `user_settings_override`, contact support to help you upgrade.

### Next steps
## Next steps

Once you've successfully upgraded on {{ech}}, [upgrade your ingest components](/deploy-manage/upgrade/ingest-components.md), such as {{ls}}, {{agents}}, or {{beats}}.
8 changes: 5 additions & 3 deletions deploy-manage/upgrade/deployment-or-cluster/upgrade-on-eck.md
Original file line number Diff line number Diff line change
@@ -1,14 +1,16 @@
---
navigation_title: "Upgrade on {{eck}}"
applies_to:
stack:
deployment:
eck:
---

# Upgrade your deployment on {{eck}} (ECK)

The ECK orchestrator can safely perform upgrades to newer versions of the {{stack}}.

Once you are prepared to upgrade, ensure the ECK version is [compatible](https://www.elastic.co/guide/en/cloud-on-k8s/current/k8s-supported.html) with the {{stack}} version you’re upgrading to. If it's incompatible, [upgrade your orchestrator](/deploy-manage/upgrade/orchestrator/upgrade-cloud-on-k8s.md).

% Note: Add a link once confirmed where prepare to upgrade will reside in TOC.
Once you're [prepared to upgrade](/deploy-manage/upgrade/prepare-to-upgrade.md), ensure the ECK version is [compatible](https://www.elastic.co/guide/en/cloud-on-k8s/current/k8s-supported.html) with the {{stack}} version you’re upgrading to. For example, if you're upgrading to 9.0.0, the minimum required ECK version is 3.0.0. If it's incompatible, [upgrade your orchestrator](/deploy-manage/upgrade/orchestrator/upgrade-cloud-on-k8s.md).

## Perform the upgrade

Expand Down
15 changes: 11 additions & 4 deletions deploy-manage/upgrade/orchestrator.md
Original file line number Diff line number Diff line change
@@ -1,14 +1,21 @@
---
applies_to:
deployment:
ece:
eck:
---

# Upgrade your orchestrator

:::{note}
The topics in this section apply to customers running the {{stack}} on {{ece}} (ECE) or {{eck}} (ECK).
:::

Elastic provides customers with two major self-managed orchestrators to manage the {{stack}}. Before upgrading the products in the stack, ensure your orchestrator is running a compatible version. If you’re running a version of your orchestrator that’s incompatible with the {{stack}} version you’re upgrading to, upgrade the orchestrator first.
Elastic provides customers with two major self-managed orchestrators to manage the {{stack}}. Before upgrading the products in the {{stack}}, ensure your orchestrator is running a compatible version. If your orchestrator is running an incompatible with the {{stack}} version you’re upgrading to, you must upgrade the orchestrator first.

If your orchestrator is up to date, you can skip this step and proceed with [Upgrading on ECE](/deploy-manage/upgrade/deployment-or-cluster/upgrade-on-ece.md) or [Upgrading on ECK](/deploy-manage/upgrade/deployment-or-cluster/upgrade-on-eck.md).

Refer to one of these topics, depending on which orchestrator you have:
To learn how to upgrade your orchestrator, refer to one of these topics:

* [Upgrade ECE](/deploy-manage/upgrade/orchestrator/upgrade-cloud-enterprise.md)
* [Upgrade ECK](/deploy-manage/upgrade/orchestrator/upgrade-cloud-on-k8s.md)

If your orchestrator is up to date, you can skip this step and proceed with [Upgrading on ECE](/deploy-manage/upgrade/deployment-or-cluster/upgrade-on-ece.md) or [Upgrading on ECK](/deploy-manage/upgrade/deployment-or-cluster/upgrade-on-eck.md).
Original file line number Diff line number Diff line change
@@ -1,3 +1,9 @@
---
applies_to:
deployment:
ece:
---

# Re-running the ECE upgrade [re-running-ece-upgrade]

By default, re-running the `elastic-cloud-enterprise.sh upgrade` command resumes the previous ECE upgrade process. However, if your previous ECE upgrade attempt got stuck (for example, due to infrastructure problems, a host going offline, or similar) and re-attempting the upgrade still results in the upgrade process being blocked, run `elastic-cloud-enterprise.sh upgrade --force-upgrade` to ensure that any existing upgrade state gets cleared before starting the new ECE upgrade process.
Expand Down
15 changes: 11 additions & 4 deletions deploy-manage/upgrade/orchestrator/upgrade-cloud-enterprise.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,15 +2,22 @@
mapped_urls:
- https://www.elastic.co/guide/en/cloud-enterprise/current/ece-upgrade.html
- https://www.elastic.co/guide/en/cloud-enterprise/current/ece_re_running_the_ece_upgrade.html
applies_to:
deployment:
ece:
---

% The upgrade procedure is expected to change with ECE 3.8.0 release. This document is currently a temporary draft, pending to be refined.

# Upgrade Elastic Cloud Enterprise [ece-upgrade]

Periodically, you might need to upgrade an Elastic Cloud Enterprise installation as new versions with additional features become available. The upgrade process updates all hosts that are part of an Elastic Cloud Enterprise installation to the latest version of ECE, with little or no downtime for managed deployments. To upgrade deployments to Elastic Stack 9.x, the minimum required version of ECE is 3.0.0.
This page provides instructions on how to upgrade the ECE operator.

Before initiating the ECE upgrade process, consult the [Support matrix](https://www.elastic.co/support/matrix#elastic-cloud-enterprise) to make sure that the Operating System (OS) and Docker or Podman versions you run are compatible with the ECE version you’re about to upgrade to. We recommend that Docker, Podman, and the operating system be at the target version before starting the ECE upgrade procedure.
To learn how to upgrade {{stack}} applications like {{es}} or {{kib}}, refer to [Upgrade the Elastic Stack version](../deployment-or-cluster.md).

Periodically, you might need to upgrade an Elastic Cloud Enterprise installation as new versions with additional features become available. The upgrade process updates all hosts that are part of an Elastic Cloud Enterprise installation to the latest version of ECE, with little or no downtime for managed deployments. To upgrade your deployment to {{stack}} 9.x, the minimum required ECE version is 3.0.0.

Before initiating the ECE upgrade process, review the [Support matrix](https://www.elastic.co/support/matrix#elastic-cloud-enterprise) to ensure the operating system (OS), Docker, or Podman versions you're running are compatible with the ECE version you’re upgrading to. We recommend that Docker, Podman, and the operating system are at the target version before starting the ECE upgrade.

:::{note}
During the upgrade window, there might be a short period of time during which you run a combination of versions which is not explicitly supported. For example, if you are on ECE 3.5 with Docker version 20.10 on Ubuntu 20.04, and plan to upgrade to ECE 3.7 on the same OS, you will need to upgrade Docker to version 24.0 first. In this case, and only during your upgrade window, we support the mixed OS/Docker versions. In general, this won’t be a problem. However, should anything become a blocker for the upgrade, [reach out to support for help](/troubleshoot/index.md#contact-us).
Expand All @@ -27,14 +34,14 @@ The following table shows the recommended upgrade paths from older Elastic Cloud
| 2.5-2.12 | 1. Upgrade to 2.13.4<br>2. Upgrade to 3.8.0<br>3. Upgrade to 4.0.0<br> |
| 2.0-2.4 | 1. Upgrade to 2.5.1<br>2. Upgrade to 2.13.4<br>3. Upgrade to 3.8.0<br>4. Upgrade to 4.0.0<br> |

In case you have to upgrade to any of the intermediate versions, follow the upgrade instructions of the relevant release before upgrading to 4.0.0:
If you have to upgrade to any of the intermediate versions, follow the upgrade instructions of the relevant release before upgrading to 4.0.0:
- [ECE 2.5 Upgrade](https://www.elastic.co/guide/en/cloud-enterprise/2.5/ece-upgrade.html)
- [ECE 2.13 Upgrade](https://www.elastic.co/guide/en/cloud-enterprise/2.13/ece-upgrade.html)
- [ECE 3.8 Upgrade](https://www.elastic.co/guide/en/cloud-enterprise/3.7/ece-upgrade.html)

## The upgrade process [ece-upgrade-overview]

Upgrading Elastic Cloud Enterprise works by replacing the [containers](/reference/glossary/index.md#glossary-container) that ECE itself requires to run on each host. Upgrading ECE does not touch any of the containers that run Elasticsearch clusters and Kibana instances. Each container that needs to be upgraded is renamed and stopped, followed by the creation of a new container with an upgraded instance of the ECE software and its dependencies. When the upgrade process has completed successfully, it cleans up after itself and removes the old containers.
Upgrading Elastic Cloud Enterprise works by replacing the [containers](/reference/glossary/index.md#glossary-container) that ECE itself requires to run on each host. Upgrading ECE does not touch any of the containers that run {{es}} clusters and {{kib}} instances. Each container that needs to be upgraded is renamed and stopped, followed by the creation of a new container with an upgraded instance of the ECE software and its dependencies. When the upgrade process has completed successfully, it cleans up after itself and removes the old containers.

The upgrade process creates a `frc-upgraders-monitor` container on the host where you initiate the process that performs the following actions:

Expand Down
5 changes: 4 additions & 1 deletion deploy-manage/upgrade/orchestrator/upgrade-cloud-on-k8s.md
Original file line number Diff line number Diff line change
@@ -1,13 +1,16 @@
---
mapped_pages:
- https://www.elastic.co/guide/en/cloud-on-k8s/current/k8s-upgrading-eck.html
applies_to:
deployment:
eck: ga 3.0.0
---

# Upgrade Elastic Cloud on Kubernetes [k8s-upgrading-eck]

This page provides instructions on how to upgrade the ECK operator.

For upgrades of Elastic Stack applications like Elasticsearch or Kibana, check [Upgrade the Elastic Stack version](../deployment-or-cluster.md).
To learn how to upgrade {{stack}} applications like {{es}} or {{kib}}, refer to [Upgrade the Elastic Stack version](../deployment-or-cluster.md).


## Before you upgrade to ECK 3.0.0 [k8s-ga-upgrade]
Expand Down
Loading
Loading