You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: deploy-manage/upgrade/plan-upgrade.md
+18-23Lines changed: 18 additions & 23 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -20,36 +20,29 @@ The objective of this section is to facilitate the creation of an upgrade plan t
20
20
21
21
## Compatibility checks
22
22
23
-
Check if you can upgrade directly to the version you are aiming to upgrade to. If not, you need to find a valid upgrade path, and plan accordingly.
23
+
Before upgrading, verify that your current environment supports the version you plan to upgrade to. If not, identify any required intermediate upgrades or component changes and include them in your upgrade plan.
24
24
25
-
* System requirements: Ensure the version you’re upgrading to for {{es}}, {{kib}}, and any ingest components supports your current operating system. Refer to the [Product and Operating System support matrix](https://www.elastic.co/support/matrix#matrix_os).
25
+
***System requirements**: Ensure your current operating system is supported by the target versions of {{es}}, {{kib}}, and any ingest components. Refer to the [Product and Operating System support matrix](https://www.elastic.co/support/matrix#matrix_os).
26
26
27
-
*Compatibility with ingest components: Ensure your ingest componentsare compatible with the version you’re upgrading to for {{es}}. Refer to [conduct a component inventory](#conduct-a-component-inventory) for more details.
27
+
***Ingest component compatibility**: Confirm that your ingest components, such as {{beats}}, {{ls}}, or {{agent}}, are compatible with the target {{es}} version. If they’re not, upgrade them first. Refer to [conduct a component inventory](#conduct-a-component-inventory) for guidance.
28
28
29
-
* Orchestrator compatibility: If your orchestrator is not compatible with the {{stack}} version you’re upgrading to, you need to [upgrade the orchestrator](/deploy-manage/upgrade/orchestrator.md) before upgrading your cluster. Compatibility details are available in:
***Orchestrator compatibility**: If you’re using an orchestrator like {{ece}} or {{eck}}, verify that it supports the target {{stack}} version. If not, [upgrade the orchestrator](/deploy-manage/upgrade/orchestrator.md) before upgrading your cluster. Refer to:
*Developed clients compatibility: Check any client library you are using and ensure it is compatible with the version you’re upgrading to for {{es}}. Refer to [{{es}} clients](/reference/elasticsearch-clients/index.md)and [upgrade paths](../upgrade.md#upgrade-paths) for more information.
33
+
***Rest API compatibility**: If you use custom-developed applications or clients, ensure the [{{es}} client libraries](/reference/elasticsearch-clients/index.md)are compatible with the target version. If your applications use deprecated or removed APIs, you may need to update the client code first.
34
34
35
-
* {{es}} version compatibility: Check [upgrade paths](../upgrade.md#upgrade-paths) description to ensure you can upgrade directly to the version you are aiming to upgrade to.
35
+
::::{note}
36
+
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}} cluster.
36
37
37
-
Examples of situations where you need to adapt your upgrade path:
38
+
`REST API compatibility` is a per-request opt-in feature that can help REST clients mitigate non-compatible (breaking) changes to the REST API.
39
+
::::
38
40
39
-
* Some of your ingest components are not compatible with the version you are aiming to upgrade to, and they need to be upgraded first to a compatible version.
40
-
* Your orchestrator (ECE or ECK) or operating system is not compatible with the version you are aiming to upgrade to, and it needs to be upgraded first to a compatible version.
41
-
* Your running {{es}} version cannot be upgraded directly to the version you are aiming to upgrade to, and it needs to be upgraded first to an intermediate version.
42
-
* Due to some breaking changes, your developed clients are using {{es}} APIs that are not compatible with the version you are aiming to upgrade to, and they need to be adapted first.
41
+
***{{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.
43
42
44
-
### OpenJDK compatibility and FIPS compliance
43
+
***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).
45
44
46
-
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).
47
-
48
-
If you’re running {{es}} in FIPS 140-2 mode, we recommend using [Bouncy Castle](https://www.bouncycastle.org/java.html) as a Java security provider when running {{es}}.
49
-
50
-
### Rest API compatibility
51
-
52
-
[REST API compatibility](elasticsearch://reference/elasticsearch/rest-apis/compatibility.md) is a per-request opt-in feature that can help REST clients mitigate non-compatible (breaking) changes to the REST API.
45
+
If you’re running {{es}} in FIPS 140-2 mode, we recommend using [Bouncy Castle](https://www.bouncycastle.org/java.html) as a Java security provider when running {{es}}.
53
46
54
47
## Conduct a component inventory
55
48
@@ -114,12 +107,14 @@ If all components are compatible with the target version of {{es}}, we recommend
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 cannot 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.
110
+
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.
111
+
112
+
The monitoring cluster should be running the same version, or a newer one, than the clusters being monitored. It cannot monitor clusters running a newer version of the {{stack}}. If necessary, the monitoring cluster can monitor clusters running the latest release of the previous major version.
118
113
::::
119
114
120
115
## Example of an upgrade plan
121
116
122
-
Let's assume you are running all {{stack}} components in version 8.14 and your main goal is to upgrade {{es}} and {{kib}} to the latest {{stack-version}}, without requiring to upgrade the ingest components (Beats, Elastic Agent, and Logstash) except when required by the upgrade path.
117
+
Let's assume you are running all {{stack}} components in version 8.14 and your main goal is to upgrade {{es}} and {{kib}} to the latest {{stack-version}}, without requiring to upgrade the ingest components (Beats, Elastic Agent, and Logstash) except when required by the [upgrade paths](../upgrade.md#upgrade-paths).
Copy file name to clipboardExpand all lines: deploy-manage/upgrade/prepare-to-upgrade.md
+3-1Lines changed: 3 additions & 1 deletion
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -63,7 +63,9 @@ The following steps are common to all types of upgrades, regardless if you are u
63
63
64
64
5.**Upgrade your monitoring cluster first**
65
65
66
-
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 cannot 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.
66
+
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.
67
+
68
+
The monitoring cluster should be running the same version, or a newer one, than the clusters being monitored. It cannot monitor clusters running a newer version of the {{stack}}. If necessary, the monitoring cluster can monitor clusters running the latest release of the previous major version.
0 commit comments