Skip to content

Commit

Permalink
Update wording (#1257)
Browse files Browse the repository at this point in the history
  • Loading branch information
@avtarraikmo
avtarraikmo authored Aug 15, 2024
1 parent cac294e commit f6a0d86
Show file tree
Hide file tree
Showing 2 changed files with 15 additions and 18 deletions.
12 changes: 6 additions & 6 deletions docs/modules/maintain-cluster/pages/rolling-upgrades.adoc
View file
Original file line number Diff line number Diff line change
Expand Up @@ -12,7 +12,7 @@ For further information on rolling restarts, see xref:migrate:community-to-enter

Before starting a rolling upgrade, consider the following best practices:

* Ensure that the <<hazelcast-members-compatibility-guarantees,Compatibility Guarantees>> cover your requirements
* Ensure that <<hazelcast-members-compatibility,Upgrade Compatibility>> covers your requirements
* If the minimum version of JDK has changed between releases, <<updated-jdk,upgrade the JDK version>> before starting a rolling upgrade
* If you used Hazelcast Operator to deploy your cluster, refer to the link:https://docs.hazelcast.com/operator/latest/scaling-upgrading#upgrading[Operator documentation, window=_blank]
* If using Hazelcast Management Center to trigger your rolling upgrade, upgrade Management Center before upgrading your members. For information on upgrading Management Center, refer to the link:https://docs.hazelcast.com/management-center/latest/getting-started/install[Management Center documentation, window=_blank], or if you deployed Management Center using the Hazelcast Operator, refer to the link:https://docs.hazelcast.com/operator/latest/deploy-management-center.adoc[Operator documentation, window=_blank]
Expand Down Expand Up @@ -46,10 +46,10 @@ the same cluster protocol and
determines the feature set exposed by the cluster.
|===

[[hazelcast-members-compatibility-guarantees]]
=== Compatibility Guarantees
[[hazelcast-members-compatibility]]
=== Upgrade Compatibility

To allow you to use rolling upgrades, Hazelcast commits to the following compatibility guarantees for GA (general availability) releases:
To allow you to use rolling upgrades, Hazelcast maintains the following GA (general availability) release compatibility:

- Hazelcast members operating on the same major and minor
cluster version are always compatible, regardless of patch version.
Expand All @@ -63,13 +63,13 @@ As a result, you can use rolling upgrades to upgrade clusters to the following m
+
This also includes the ability of rolling upgrade from Hazelcast IMDG 4.2 to Platform 5.0, since IMDG is part of the Platform and 5.0 is considered to be the next minor version after IMDG 4.2.

- The 5.5 Long-term Support (LTS) release direct from 5.2.x to 5.4.x. For further information on additional compatibilities for direct-to-LTS rolling upgrades, see xref:migrate:lts.adoc[].
- The 5.5 Long-term Support (LTS) release direct from 5.2 or later. For further information on additional compatibilities for direct-to-LTS rolling upgrades, see xref:migrate:lts.adoc[].

NOTE: Following the rolling upgrade, you must resubmit jobs as they don't run during the upgrade. For further information on the compatibility of job states in upgrades, see xref:deploy:versioning-compatibility.adoc#job-states[Versioning and Compatibility].

=== Upgrade to LTS Release

With the introduction of Hazelcast's first LTS release, you can upgrade directly from 5.2, or later, to 5.5. This means that, if using a supported earlier version, you do not need to upgrade to each version between your current version and the LTS release.
With the introduction of Hazelcast Platform LTS release, you can upgrade directly from 5.2.x, or later, to 5.5. This means that, if using a supported earlier version, you do not need to upgrade to each version between your current version and the LTS release.

For more information on LTS releases, and any specific considerations when upgrading, see xref:migrate:lts.adoc[].

Expand Down
21 changes: 9 additions & 12 deletions docs/modules/migrate/pages/lts.adoc
View file
Original file line number Diff line number Diff line change
Expand Up @@ -5,9 +5,9 @@

{description}

LTS releases have been introduced with Hazelcast Platform 5.5. You can upgrade directly from 5.2.x or later to 5.5 without the need to upgrade to each release between your current version and the LTS release. We recommend that you upgrade to 5.5 from the latest available patch for your current release.
LTS releases have been introduced with Hazelcast Platform 5.5. You can upgrade directly from 5.2 or later to 5.5 without the need to upgrade to each release between your current version and the LTS release. We recommend that you upgrade to 5.5 from the latest available patch for your current release.

NOTE: Features marked as Beta in the source version are upgraded, but are supported only in a cluster of the source version due to changes that can occur between releases. For further information on rolling upgrade compatibilities, see xref:maintain-cluster:rolling-upgrades.adoc#hazelcast-members-compatibility-guarantees[Compatibility Guarantees].
NOTE: Features marked as Beta in the source version are upgraded, but are supported only in a cluster of the source version due to changes that can occur between releases. For further information on rolling upgrade compatibilities, see xref:maintain-cluster:rolling-upgrades.adoc#hazelcast-members-compatibility[Upgrade Compatibility].

Between LTS releases, Hazelcast will provide short-term support (STS) releases. You can choose to upgrade directly from one LTS to the next LTS, or you can upgrade from one LTS to each STS release and then from the last STS release to the next LTS release. Before deciding the approach that best suits your needs, consider the following:

Expand All @@ -29,9 +29,6 @@ Between LTS releases, Hazelcast will provide short-term support (STS) releases.

For example, if there are three STS releases between LTS releases, you cannot upgrade to the latest LTS unless you have upgraded to all three STS releases.

|Full support for three years with the option of extended support for a further year.
|Maintenance support until the next STS or LTS release only.

|Choose if you value stability over new feature adoption, you want to upgrade less frequently, and you want full or extended support.
|Choose if you value new features over stability, you are willing to upgrade several times a year, and you are happy with maintenance support for the life of the STS.
|===
Expand All @@ -44,18 +41,18 @@ The Hazelcast 5.5 LTS release supports direct upgrade as follows:
|===
|Upgrade From|LTS Release Support

|5.2
|5.4
|All features

5.3
|5.3

5.2

a|* IMap data structure. This includes the API, configuration options, and persistence
* CP subsystem. This includes the API and peristence
* WAN replication. Ongoing replication is supported during the upgrade. This includes both source and target; however, the source and the target cannot be upgraded simultaneously

NOTE: Hazelcast has tested WAN Replication to validate the upgrade solution. The test covered two clusters of different versions; for scenarios where WAN Replication is used from a cluster with a version or 5.2, 5.3, or 5.4 to another cluster with a version between 4.0 and 5.4, only the replication to clusters of version 5.2 or later have been tested.

|5.4
|All features
|===

== Mixed-version Clusters
Expand All @@ -79,7 +76,7 @@ The following table provides an example of the behaviour:
|5.3 member joins 5.2 cluster

|Further member tries to join cluster
|LTS
|5.5 LTS
|5.2
|LTS member identifies that two different minor versions are already in the cluster and rejects joining the cluster
|===
Expand All @@ -99,7 +96,7 @@ Hazelcast recommends that you avoid the following scenario:
|5.2 cluster forms

|Member tries to join cluster
|LTS
|5.5 LTS
|5.2
|Member identifies that only one minor version is already in the cluster and joins the cluster

Expand Down

0 comments on commit f6a0d86

Please sign in to comment.