From 39c95ae9999a6361852b7fb1a318f8b40a99277c Mon Sep 17 00:00:00 2001 From: Amanda Lindsay Date: Tue, 11 Nov 2025 11:41:40 +0000 Subject: [PATCH 1/7] DOC-300: replace compatibility table --- .../pages/versioning-compatibility.adoc | 218 ++++++++---------- 1 file changed, 96 insertions(+), 122 deletions(-) diff --git a/docs/modules/deploy/pages/versioning-compatibility.adoc b/docs/modules/deploy/pages/versioning-compatibility.adoc index a68fb0a33..44e1e589a 100644 --- a/docs/modules/deploy/pages/versioning-compatibility.adoc +++ b/docs/modules/deploy/pages/versioning-compatibility.adoc @@ -1,11 +1,11 @@ -= Supported Versions and Compatibilities -:description: This section provides the supported versions and interoperability of Hazelcast Platform and its modules. += Supported versions and compatibilities +:description: This section provides information about the supported versions and interoperability of Hazelcast Platform and its modules. :page-aliases: deploy:supported-jvms.adoc :page-icons: font {description} -== Semantic Versioning +== Semantic versioning Hazelcast Platform uses https://semver.org/[semantic versioning] where versions appear in the following format: @@ -19,7 +19,7 @@ Semantic versioning separates new releases into three types: * Minor: This version includes backward-compatible functionality. * Patch: This version includes backward-compatible bug fixes. -=== API Compatibility Exceptions +=== API compatibility exceptions According to semantic versioning, a Platform job written using the Pipeline API in a previous minor version should compile and have the same behavior in later minor versions. @@ -29,7 +29,7 @@ However, note the following exceptions: * Types and methods annotated with `@EvolvingApi` and `@Beta` provide only patch-level compatibility guarantee. These are typically new features where the API is subject to further changes. * Types and methods annotated with `@PrivateApi`, and classes in the `impl` and `internal` packages do not provide any compatibility guarantees between versions. These APIs are not meant for public use. -== Supported Architectures +== Supported architectures Hazelcast Platform has been tested on the following system architectures. @@ -45,7 +45,7 @@ Hazelcast Platform has been tested on the following system architectures. |=== -== Supported Operating Systems +== Supported operating systems Hazelcast Platform has been tested against the following operating systems. It may run on others which are not listed here. @@ -82,7 +82,7 @@ Hazelcast Platform has been tested against the following operating systems. It m |=== // end::supported-os[] -== Supported Virtualization Environments +== Supported virtualization environments Hazelcast Platform has been tested against the following virtualization environments. It may run on others which are not listed here. @@ -104,7 +104,7 @@ Hazelcast Platform has been tested against the following virtualization environm |=== -== Supported Public Cloud Environments +== Supported public cloud environments .Supported Cloud Environments |=== @@ -162,19 +162,100 @@ Hazelcast Platform runs on Java, and supports the following LTS JDKs. It may run |=== // end::supported-jvms[] -== Compatibility Guarantees +== Compatibility -=== Cluster Members +The following table shows compatibility between Hazelcast Platform, its management and monitoring components, and clients. + +For each Platform version, you can see which versions of Management Center, Hazelcast Operator, CLC, and all official clients (Java, .NET, C++, Python, Node.js, Go) are recommended or supported. + +NOTE: The most recent version is shown in bold to indicate the recommended and most up-to-date option for that Platform version. If you are unsure which version to choose, always select the latest version for best compatibility and support. + +[cols="1,2,3,4,5,6,7,8,9,10",options="header"] +.Compatibility at a glance +|=== +|Platform version | Management Center | Operator | CLC | Java client | .NET | C++ | Python | Node.js | Go + +|5.5.x +|5.5.0 - *5.8.0* +|5.13 - *5.15* +|5.2.0 - *5.5.0* +|Same as Platform version +|4.0.0 - *5.5.1* +|5.3.1 - *5.4.0* +|4.0.0 - *5.5.0* +|4.0.0 - *5.3.0* +|1.0.0 - *1.4.2* + +|5.4.x +|5.4.0 - *5.8.0* +|5.11 - *5.15* +|" +|" +|" +|4.0.0 - *5.4.0* +|" +|" +|" + +|5.3.x +|5.3.0 - *5.8.0* +|5.8 - *5.15* +|" +|" +|" +|" +|" +|" +|" + +|5.2.x +|5.2.0 - *5.8.0* +|5.6 - *5.15* +|" +|" +|" +|" +|" +|" +|" + +|5.1.x +|5.1.0 - *5.8.0* +|N/A +|" +|" +|" +|" +|" +|" +|" + +|5.0.x +|5.0.0 - *5.8.0* +|N/A +|" +|" +|" +|" +|" +|" +|" + +|=== + +=== Compatibility guarantees + +==== Cluster members Hazelcast Platform members operating on the same major and minor Platform version are always compatible, regardless of the patch version. Each minor version is always compatible with the previous minor version. -=== Management Center +==== Management Center All 5.x.y versions of Management Center are compatible with Hazelcast Platform 5.x.y versions. We recommend you use a version of Management Center at least as high as the Hazelcast Platform version in your cluster. For example, Management Center 5.1.1 may not support all the features of Hazelcast Platform 5.2, or vice versa. You should generally upgrade to the latest version of Management Center when available and refer to xref:{page-latest-supported-mc}@management-center:release-notes:releases.adoc[Management Center release notes] for details on each version. -=== Job States +==== Job states Hazelcast Platform job states are only backward-compatible across the same minor versions. A newer patch version is able to understand the job states only from the previous patch versions of the same minor version. @@ -182,121 +263,14 @@ If you have a running job, using the rolling upgrades feature, you are able to u Hazelcast clients that submit jobs (currently only Java clients) are compatible with members running on the same minor version. This means that a client using an older or newer patch version is able to connect and submit a job to a cluster that's running a different patch version. -=== Command Line Tools +==== Command line tools Hazelcast xref:management:cluster-utilities.adoc#hazelcast-command-line-tool[CLI] and xref:management:cluster-utilities.adoc#using-the-hz-cluster-admin-script[cluster admin] tools are backwards-compatible across the same minor versions. -=== Configuration Files +==== Configuration files XML and YAML configuration files provided with the Hazelcast Platform package are backward-compatible across the same minor versions. After upgrading a cluster to a new minor version, the configuration files for the previous version can be used without any modification. -=== Names of Metrics +==== Names of metrics Hazelcast Platform sends metrics to Management Center and other means such as JMX. The names of these metrics may change across minor versions but not between patch versions. - -=== Client Version Compatibilities - -Hazelcast Platform has clients implemented in the following languages: - -* Java -* {cpp} -* .NET -* Python -* Go -* Node.js -* Hazelcast Command Line Client (CLC) - -The following table lists the compatibilities between client and Platform/IMDG versions. - -[cols="1,2a",options="header"] -.Client Version Compatibilities -|=== -|Client | Platform and/or IMDG - -|Java 5.x.y -| -* Platform 5.x.y -* IMDG 4.x.y - -|Java 4.x.y -| -* Platform 5.x.y -* IMDG 4.x.y - -|Java 3.6.x through 3.12.x -| -* IMDG 3.6.x through 3.12.x - -|{cpp} 5.x.y -| -* Platform 5.x.y -* IMDG 4.x.y - -|{cpp} 4.x.y -| -* Platform 5.x.y -* IMDG 4.x.y - -|{cpp} 3.6.x through 3.12.x -| -* IMDG 3.6.x through 3.12.x - -|.NET 5.x.y -| -* Platform 5.x.y -* IMDG 4.x.y - -|.NET 4.x.y -| -* Platform 5.x.y -* IMDG 4.x.y - -|.NET 3.6.x through 3.12.x -| -* IMDG 3.6.x through 3.12.x - -|Python 5.x.y -| -* Platform 5.x.y -* IMDG 4.x.y - -|Python 4.x.y -| -* Platform 5.x.y -* IMDG 4.x.y - -|Python 3.6.x through 3.12.x -| -* IMDG 3.6.x through 3.12.x - -|Node.js 5.x.y -| -* Platform 5.x.y -* IMDG 4.x.y - -|Node.js 4.x.y -| -* Platform 5.x.y -* IMDG 4.x.y - -|Node.js 3.6.x through 3.12.x -| -* IMDG 3.6.x through 3.12.x - -|Go 1.x.y -| -* Platform 5.x.y -* IMDG 4.x.y - -|Go 0.x.y -| -* IMDG 3.6.x through 3.12.x - -|CLC 5.x.y -| -* Platform 5.x.y -* IMDG 4.x.y - -|=== - - From 010878bb087d549a85df49dae0c0b713142b815f Mon Sep 17 00:00:00 2001 From: Amanda Lindsay Date: Tue, 11 Nov 2025 12:58:52 +0000 Subject: [PATCH 2/7] DOC-300: adjust column width --- docs/modules/deploy/pages/versioning-compatibility.adoc | 6 ++++-- 1 file changed, 4 insertions(+), 2 deletions(-) diff --git a/docs/modules/deploy/pages/versioning-compatibility.adoc b/docs/modules/deploy/pages/versioning-compatibility.adoc index 44e1e589a..a3433bb70 100644 --- a/docs/modules/deploy/pages/versioning-compatibility.adoc +++ b/docs/modules/deploy/pages/versioning-compatibility.adoc @@ -170,8 +170,10 @@ For each Platform version, you can see which versions of Management Center, Haze NOTE: The most recent version is shown in bold to indicate the recommended and most up-to-date option for that Platform version. If you are unsure which version to choose, always select the latest version for best compatibility and support. -[cols="1,2,3,4,5,6,7,8,9,10",options="header"] -.Compatibility at a glance +// [cols="1,2,3,4,5,6,7,8,9,10",options="header"] +// .Compatibility at a glance + +[cols="^10%,^10%,^10%,^10%,^10%,^10%,^10%,^10%,^10%,^10%", options="header"] |=== |Platform version | Management Center | Operator | CLC | Java client | .NET | C++ | Python | Node.js | Go From 32d4a3ecadd065f530df3502fdd9a16955d91450 Mon Sep 17 00:00:00 2001 From: Amanda Lindsay Date: Tue, 11 Nov 2025 13:24:01 +0000 Subject: [PATCH 3/7] DOC-300: tweak table heading --- docs/modules/deploy/pages/versioning-compatibility.adoc | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/docs/modules/deploy/pages/versioning-compatibility.adoc b/docs/modules/deploy/pages/versioning-compatibility.adoc index a3433bb70..68ececb6d 100644 --- a/docs/modules/deploy/pages/versioning-compatibility.adoc +++ b/docs/modules/deploy/pages/versioning-compatibility.adoc @@ -166,7 +166,7 @@ Hazelcast Platform runs on Java, and supports the following LTS JDKs. It may run The following table shows compatibility between Hazelcast Platform, its management and monitoring components, and clients. -For each Platform version, you can see which versions of Management Center, Hazelcast Operator, CLC, and all official clients (Java, .NET, C++, Python, Node.js, Go) are recommended or supported. +For each Platform version, you can see which versions of Management Center (MC), Hazelcast Operator, CLC, and all official clients (Java, .NET, C++, Python, Node.js, Go) are recommended or supported. NOTE: The most recent version is shown in bold to indicate the recommended and most up-to-date option for that Platform version. If you are unsure which version to choose, always select the latest version for best compatibility and support. @@ -175,7 +175,7 @@ NOTE: The most recent version is shown in bold to indicate the recommended and m [cols="^10%,^10%,^10%,^10%,^10%,^10%,^10%,^10%,^10%,^10%", options="header"] |=== -|Platform version | Management Center | Operator | CLC | Java client | .NET | C++ | Python | Node.js | Go +|Platform version | MC | Operator | CLC | Java client | .NET | C++ | Python | Node.js | Go |5.5.x |5.5.0 - *5.8.0* From a29744a7b8408ee044a897104bd6bd53f7f37fe3 Mon Sep 17 00:00:00 2001 From: Amanda Lindsay Date: Wed, 12 Nov 2025 16:05:07 +0000 Subject: [PATCH 4/7] DOC-300: add another table --- .../pages/versioning-compatibility.adoc | 47 +++++++++++++++++-- 1 file changed, 44 insertions(+), 3 deletions(-) diff --git a/docs/modules/deploy/pages/versioning-compatibility.adoc b/docs/modules/deploy/pages/versioning-compatibility.adoc index 68ececb6d..b2e4d775c 100644 --- a/docs/modules/deploy/pages/versioning-compatibility.adoc +++ b/docs/modules/deploy/pages/versioning-compatibility.adoc @@ -164,15 +164,56 @@ Hazelcast Platform runs on Java, and supports the following LTS JDKs. It may run == Compatibility +The following table shows compatibility between this version of Hazelcast Platform, Management Center (MC), Hazelcast Operator, CLC, and all official clients. + +|=== +|Component/Client | Minimum version | Recommended version + +|MC +|5.5 +|{page-latest-supported-mc} + +|Operator +|5.13 +|{variable - TBC} + +|CLC +|5.2.0 +|{page-latest-supported-clc} + +|Java client +|same as platform +|same as platform + +|.NET client +|4.0.0 +|{page-latest-supported-csharp-client} + +|C++ client +|5.3.1 +|{page-latest-supported-cplusplus-client} + +|Python client +|4.0.0 +|{page-latest-supported-python-client} + +|Node.js client +|4.0.0 +|{page-latest-supported-nodejs-client} + +|Go client +|1.0.0 +|{page-latest-supported-go-client} + +|=== + + The following table shows compatibility between Hazelcast Platform, its management and monitoring components, and clients. For each Platform version, you can see which versions of Management Center (MC), Hazelcast Operator, CLC, and all official clients (Java, .NET, C++, Python, Node.js, Go) are recommended or supported. NOTE: The most recent version is shown in bold to indicate the recommended and most up-to-date option for that Platform version. If you are unsure which version to choose, always select the latest version for best compatibility and support. -// [cols="1,2,3,4,5,6,7,8,9,10",options="header"] -// .Compatibility at a glance - [cols="^10%,^10%,^10%,^10%,^10%,^10%,^10%,^10%,^10%,^10%", options="header"] |=== |Platform version | MC | Operator | CLC | Java client | .NET | C++ | Python | Node.js | Go From 6a92f994e3f396b6527e2f3e06848e678a8e085b Mon Sep 17 00:00:00 2001 From: Amanda Lindsay Date: Thu, 11 Dec 2025 10:08:27 +0000 Subject: [PATCH 5/7] DOC-300: remove static table --- .../pages/versioning-compatibility.adoc | 86 +------------------ 1 file changed, 4 insertions(+), 82 deletions(-) diff --git a/docs/modules/deploy/pages/versioning-compatibility.adoc b/docs/modules/deploy/pages/versioning-compatibility.adoc index b2e4d775c..b6c967975 100644 --- a/docs/modules/deploy/pages/versioning-compatibility.adoc +++ b/docs/modules/deploy/pages/versioning-compatibility.adoc @@ -162,7 +162,7 @@ Hazelcast Platform runs on Java, and supports the following LTS JDKs. It may run |=== // end::supported-jvms[] -== Compatibility +== Client compatibility The following table shows compatibility between this version of Hazelcast Platform, Management Center (MC), Hazelcast Operator, CLC, and all official clients. @@ -175,7 +175,8 @@ The following table shows compatibility between this version of Hazelcast Platfo |Operator |5.13 -|{variable - TBC} +|{page-latest-supported-operator} +// variable TBC |CLC |5.2.0 @@ -207,86 +208,7 @@ The following table shows compatibility between this version of Hazelcast Platfo |=== - -The following table shows compatibility between Hazelcast Platform, its management and monitoring components, and clients. - -For each Platform version, you can see which versions of Management Center (MC), Hazelcast Operator, CLC, and all official clients (Java, .NET, C++, Python, Node.js, Go) are recommended or supported. - -NOTE: The most recent version is shown in bold to indicate the recommended and most up-to-date option for that Platform version. If you are unsure which version to choose, always select the latest version for best compatibility and support. - -[cols="^10%,^10%,^10%,^10%,^10%,^10%,^10%,^10%,^10%,^10%", options="header"] -|=== -|Platform version | MC | Operator | CLC | Java client | .NET | C++ | Python | Node.js | Go - -|5.5.x -|5.5.0 - *5.8.0* -|5.13 - *5.15* -|5.2.0 - *5.5.0* -|Same as Platform version -|4.0.0 - *5.5.1* -|5.3.1 - *5.4.0* -|4.0.0 - *5.5.0* -|4.0.0 - *5.3.0* -|1.0.0 - *1.4.2* - -|5.4.x -|5.4.0 - *5.8.0* -|5.11 - *5.15* -|" -|" -|" -|4.0.0 - *5.4.0* -|" -|" -|" - -|5.3.x -|5.3.0 - *5.8.0* -|5.8 - *5.15* -|" -|" -|" -|" -|" -|" -|" - -|5.2.x -|5.2.0 - *5.8.0* -|5.6 - *5.15* -|" -|" -|" -|" -|" -|" -|" - -|5.1.x -|5.1.0 - *5.8.0* -|N/A -|" -|" -|" -|" -|" -|" -|" - -|5.0.x -|5.0.0 - *5.8.0* -|N/A -|" -|" -|" -|" -|" -|" -|" - -|=== - -=== Compatibility guarantees +== Compatibility guarantees ==== Cluster members From 9ce19f3c1498eb22e509830b2912107d6974094c Mon Sep 17 00:00:00 2001 From: Amanda Lindsay Date: Tue, 16 Dec 2025 10:59:06 +0000 Subject: [PATCH 6/7] DOC-300: use operator latest variable --- docs/antora.yml | 1 + docs/modules/deploy/pages/versioning-compatibility.adoc | 3 +-- 2 files changed, 2 insertions(+), 2 deletions(-) diff --git a/docs/antora.yml b/docs/antora.yml index 3034225e8..ee0907510 100644 --- a/docs/antora.yml +++ b/docs/antora.yml @@ -25,6 +25,7 @@ asciidoc: # Must be lowercase because this is how the version appears in the docs page-latest-supported-mc: '5.10-snapshot' page-latest-supported-mc-installer: 'latest-snapshot' + page-latest-supported-po: 'latest-snapshot' page-latest-supported-java-client-new: '5.5.0-BETA' # https://github.com/hazelcast/hazelcast-go-client/releases page-latest-supported-go-client: '1.4.3' diff --git a/docs/modules/deploy/pages/versioning-compatibility.adoc b/docs/modules/deploy/pages/versioning-compatibility.adoc index b6c967975..aa0e48bf5 100644 --- a/docs/modules/deploy/pages/versioning-compatibility.adoc +++ b/docs/modules/deploy/pages/versioning-compatibility.adoc @@ -175,8 +175,7 @@ The following table shows compatibility between this version of Hazelcast Platfo |Operator |5.13 -|{page-latest-supported-operator} -// variable TBC +|{page-latest-supported-po} |CLC |5.2.0 From 01b419b83b93028a343073abda71d2024b4824f3 Mon Sep 17 00:00:00 2001 From: Rob Swain Date: Tue, 16 Dec 2025 11:18:55 +0000 Subject: [PATCH 7/7] fix validation error --- .../deploy/pages/versioning-compatibility.adoc | 13 ++++++------- 1 file changed, 6 insertions(+), 7 deletions(-) diff --git a/docs/modules/deploy/pages/versioning-compatibility.adoc b/docs/modules/deploy/pages/versioning-compatibility.adoc index aa0e48bf5..b5cf8bb12 100644 --- a/docs/modules/deploy/pages/versioning-compatibility.adoc +++ b/docs/modules/deploy/pages/versioning-compatibility.adoc @@ -42,7 +42,6 @@ Hazelcast Platform has been tested on the following system architectures. |AArch64/ARM64 |From Platform 5.3 - |=== == Supported operating systems @@ -209,17 +208,17 @@ The following table shows compatibility between this version of Hazelcast Platfo == Compatibility guarantees -==== Cluster members +=== Cluster members Hazelcast Platform members operating on the same major and minor Platform version are always compatible, regardless of the patch version. Each minor version is always compatible with the previous minor version. -==== Management Center +=== Management Center All 5.x.y versions of Management Center are compatible with Hazelcast Platform 5.x.y versions. We recommend you use a version of Management Center at least as high as the Hazelcast Platform version in your cluster. For example, Management Center 5.1.1 may not support all the features of Hazelcast Platform 5.2, or vice versa. You should generally upgrade to the latest version of Management Center when available and refer to xref:{page-latest-supported-mc}@management-center:release-notes:releases.adoc[Management Center release notes] for details on each version. -==== Job states +=== Job states Hazelcast Platform job states are only backward-compatible across the same minor versions. A newer patch version is able to understand the job states only from the previous patch versions of the same minor version. @@ -227,14 +226,14 @@ If you have a running job, using the rolling upgrades feature, you are able to u Hazelcast clients that submit jobs (currently only Java clients) are compatible with members running on the same minor version. This means that a client using an older or newer patch version is able to connect and submit a job to a cluster that's running a different patch version. -==== Command line tools +=== Command line tools Hazelcast xref:management:cluster-utilities.adoc#hazelcast-command-line-tool[CLI] and xref:management:cluster-utilities.adoc#using-the-hz-cluster-admin-script[cluster admin] tools are backwards-compatible across the same minor versions. -==== Configuration files +=== Configuration files XML and YAML configuration files provided with the Hazelcast Platform package are backward-compatible across the same minor versions. After upgrading a cluster to a new minor version, the configuration files for the previous version can be used without any modification. -==== Names of metrics +=== Names of metrics Hazelcast Platform sends metrics to Management Center and other means such as JMX. The names of these metrics may change across minor versions but not between patch versions.