forked from hazelcast/hz-docs
-
Notifications
You must be signed in to change notification settings - Fork 0
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
OS to EE Rolling Restarts Doc Updates (hazelcast#1145)
New information and cross-references added to document the OS to EE rolling restart mission-driven cycle. NOTE: Updates will be required for the Release notes and What's New pages, as with other features; these files will be updated separately when all information is populated. NOTE: The update made to the data-migration-tool.adoc file has also been made locally to the updated version in hazelcast#936. I will ensure that any further changes are rolled into that file too so it does not affect things when that one is merged.
- Loading branch information
1 parent
a138bfb
commit c99d7e0
Showing
7 changed files
with
120 additions
and
2 deletions.
There are no files selected for viewing
This file contains 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 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 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 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,53 @@ | ||
= Move to {enterprise-product-name} from {open-source-product-name} | ||
:description: With Enterprise Edition, you can benefit from additional and extended features, patch releases, Hazelcast Support, and more connectors. If you are using the Open Source Edition and want to upgrade to Enterprise, you can do this with clusters of the same version from 5.5. | ||
|
||
{description} | ||
|
||
The {open-source-product-name} Edition does not include the following, which are be included with an Enterprise license: | ||
|
||
* Long term support (LTS) releases and short term support (STS) releases. For more information on LTS and STS releases, see xref:migrate:lts.adoc[] | ||
* Data Migration Tool. For more information on the Data Migration Tool, see xref:migrate:data-migration-tool.adoc[] | ||
* Patch releases, including those for security vulnerabilities from March 2024 | ||
* Hazelcast Support with defined SLAs. For more information on the benefits of Hazelcast Support, see xref:getting-started:support.adoc#customer-support[] | ||
NOTE: To use the following {enterprise-product-name} features they might need to be enabled on your {enterprise-product-name} license, and must be configured after all members have been moved to {enterprise-product-name}. | ||
For further information on the license requirements and configuration, see the linked documentation for the specific feature. | ||
|
||
* Security persistence. For more information on storing sensitive data on disk, see xref:secure-cluster:hardening-recommendations.adoc[] | ||
* CP Subsystem. For more information on building a strongly consistent layer for a set of distributed data structures that withstands server and client failures, see xref:cp-subsystem:cp-subsystem.adoc[] | ||
* High-Densisty Memory Store (HD Memory). For more information on Hazelcast's in-memory storage solution, which supports predictable application scaling and improved performance while minimizing pauses caused by garbage collection, see xref:storage:high-density-memory.adoc[] | ||
* WAN Replication. For more information on synchronizing the state of multiple Hazelcast clusters across a WAN, see xref:wan:wan.adoc[] | ||
* Rolling upgrades. For more information on upgrading the members of a cluster without downtime, see xref:maintain-cluster:rolling-upgrades.adoc[] | ||
* Thread-Per-Core (TPC). For more information on improving the system performance by using one thread for networking, storage, and compute on each CPU, see xref:cluster-performance:thread-per-core-tpc.adoc[] | ||
* User Code Namespaces. For more information on using a container for Java classpath resources, such as user code and accompanying artifacts, see xref:clusters:user-code-namespaces.adoc[] | ||
* Helm charts, with the exception of link:https://github.com/hazelcast/charts/tree/master/stable/hazelcast[Commmunity-driven Open Source Helm Charts, window=_blank]. For more information on using the Helm package manager for Kubernetes with Hazelcast, see xref:kubernetes:deploying-in-kubernetes.adoc[] | ||
* Updates to connectors available before version 5.4 | ||
* Any connectors added after version 5.4 | ||
+ | ||
For more information on Connectors, see xref:integrate:connectors.adoc[]. | ||
In addition, if you are using our tools, {open-source-product-name} does not include the following: | ||
|
||
* Hazelcast Operator to support your Kubernetes deployments. For more information on Operator, refer to the link:https://docs.hazelcast.com/operator/latest/[Hazelcast Operator, window=_blank] documentation | ||
* Client filtering, Prometheus Exporter, Config Health Check, clustered REST, or JMX support in Hazelcast Management Center | ||
+ | ||
Management Center also disables with clusters of more than three members. | ||
+ | ||
For more information on Management Center, refer to the xref:{page-latest-supported-mc}@management-center::index.adoc[Management Center, window=_blank] documentation. | ||
== High-level Process | ||
|
||
To upgrade your {open-source-product-name} cluster to an {enterprise-product-name} cluster of the same version, you can use a rolling restart. | ||
|
||
The rolling restart supports the IMap, ReplicatedMap, and Topic data structures. | ||
|
||
For each member in the {open-source-product-name} cluster, the rolling restart process is as follows: | ||
|
||
. Shut down the member and wait for all partitions to migrate to the rest of the cluster | ||
. Upgrade the member's codebase | ||
. Restart the member | ||
|
||
You must not configure the {enterprise-product-name} features that you want to use until all members have been successfully moved from {open-source-product-name} to {enterprise-product-name}. | ||
|
||
For further information on rolling restarts, see xref:migrate:rolling-restart.adoc[]. |
This file contains 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 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,44 @@ | ||
= Upgrade Cluster to {enterprise-product-name} | ||
:description: You can upgrade your Open Source cluster to an Enterprise cluster using an in-place rolling restart to change each member in turn. | ||
|
||
{description} | ||
|
||
This approach ensures that you can move your cluster without interruption to the service. | ||
Similar to the rolling upgrade process, a rolling restart allows you to move one member at a time. | ||
|
||
To use a rolling restart to upgrade your cluster to {enterprise-product-name}, the codebase of your {open-source-product-name} cluster must match the target {enterprise-product-name} release. | ||
|
||
For example, you can use a rolling restart to upgrade your cluster from {open-source-product-name} 5.5 to {enterprise-product-name} 5.5. However, you cannot use a rolling restart to move to {enterprise-product-name} 5.5 from an earlier {open-source-product-name} release, such as 5.3. To move from an earlier {open-source-product-name} release, you must migrate your {open-source-product-name} data and any other associated updates, then set-up {enterprise-product-name}. You might find the Data Migration Tool (DMT) suitable for migrating your data. For further information on the DMT, see xref:migrate:data-migration-tool.adoc[]. | ||
|
||
== Best Practice | ||
|
||
Before starting a rolling restart, consider the following best practices: | ||
|
||
* Backup your IMap and ReplicatedMap data structures using your usual method. This is not essential, but it is recommended practice | ||
* Ensure that the version of JDK meets the minimum required for the target {enterprise-product-name} release | ||
* Plan sufficient time for the rolling restart to complete, and remember that the member cannot change during the move | ||
|
||
== Perform a Rolling Restart | ||
|
||
To move your {open-source-product-name} cluster to {enterprise-product-name}, complete the following steps: | ||
|
||
. Gracefully shut down an existing {open-source-product-name} member. | ||
+ | ||
See xref:maintain-cluster:shutdown.adoc#shutting-down-a-hazelcast-member[Shutting Down a Hazelcast Member]. | ||
|
||
. Wait for all partitions to migrate to the rest of the cluster. | ||
+ | ||
During migrations, members cannot join or leave the cluster. | ||
|
||
. Upgrade the member's codebase to match the {enterprise-product-name} version. | ||
|
||
. Start the member and wait until it joins the {enterprise-product-name} cluster. | ||
|
||
. Repeat this process for each member in the {open-source-product-name} cluster. | ||
|
||
. When all members on the {open-source-product-name} cluster have been moved to the {enterprise-product-name} cluster, enable and configure the | ||
{enterprise-product-name} features that you want to use using dynamic configuration. | ||
+ | ||
For further information on dynamic configuration, see xref:configuration:dynamic-config.adoc[]. | ||
+ | ||
For further information on the available features, their license requirements, and configuration, see xref:migrate:community-to-enterprise.adoc[]. |
This file contains 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