Skip to content

Commit a867196

Browse files
Kutluhan Metinamandalindsay
Kutluhan Metin
andauthored
[CN-1100]: add notes about helm-to-operator and operator-to-operator upgrade scenarios (#257)
Co-authored-by: Amanda Lindsay <v-amanda.lindsay@hazelcast.com>
1 parent 5db3c1e commit a867196

File tree

4 files changed

+38
-0
lines changed

4 files changed

+38
-0
lines changed

docs/modules/ROOT/nav.adoc

+1
Original file line numberDiff line numberDiff line change
@@ -4,6 +4,7 @@
44
* xref:ask-ai.adoc[Ask AI]
55
* xref:release-notes.adoc[Release notes]
66
* xref:get-support.adoc[Get support]
7+
* xref:migrating-from-helm.adoc[Migrating From Helm Chart]
78
89
.Deploy
910
// Deploy options

docs/modules/ROOT/pages/get-started.adoc

+1
Original file line numberDiff line numberDiff line change
@@ -9,6 +9,7 @@
99
* The link:https://kubernetes.io/docs/tasks/tools/#kubectl[`kubectl`] or link:https://docs.openshift.com/container-platform/latest/cli_reference/openshift_cli/getting-started-cli.html[`oc`] command-line tools, configured to communicate with your cluster
1010
* link:https://helm.sh/docs/intro/install[`Helm`]
1111

12+
NOTE: If you want to migrate from the Hazelcast Helm Chart, please follow the guidance in xref:migrating-from-helm.adoc[Migrating from Helm] document.
1213

1314
== Step 1. Deploy Hazelcast Platform Operator
1415

Original file line numberDiff line numberDiff line change
@@ -0,0 +1,20 @@
1+
= Migrating From Helm Chart to the Operator
2+
3+
Unfortunately there isn't any way to migrate without re-creating the cluster as the Operator needs to take control of the custom resources which were created by the Helm chart, which it is not possible.
4+
5+
There are two ways to migrate from a cluster that is created by the Hazelcast Helm Chart.
6+
7+
WARNING: For either solution to work, `persistence` must be enabled. You should also set the `cluster-data-recovery-policy` parameter's value to `PARTIAL_RECOVERY_MOST_COMPLETE` to avoid any issues during the restore process.
8+
9+
== Restoring from a Backup
10+
11+
Follow the steps below:
12+
13+
1. Install Management Center. (if you didn't before)
14+
2. Trigger a backup using the Management Center user interface.
15+
3. Uninstall existing cluster. (Don't forget to keep PVCs)
16+
4. Follow the steps explained in the xref:backup-restore#restoring-from-persistent-volumes.adoc[Restoring from Persistent Volumes] section.
17+
18+
== Attaching new Pods to Existing PVCs
19+
20+
You can also restore your data to the cluster that is installed by the Operator without creating a backup. You just need to adjust the newly created Hazelcast CR's name correctly. The name of the new CR must be in the following format: `<name>-hazelcast-persistence`. For example, assuming that the older cluster was installed with `helm install hz hazelcast/hazelcast-enterprise` command, the new CR name must be `hz-hazelcast-enterprise` so that PVCs created by the Helm Chart will attach to the pods created by the Operator correctly.

docs/modules/ROOT/pages/scaling-upgrading.adoc

+16
Original file line numberDiff line numberDiff line change
@@ -62,3 +62,19 @@ and you want to upgrade your Hazelcast version to {page-latest-supported-hazelca
6262
include::ROOT:example$/hazelcast.yaml[]
6363
----
6464

65+
Each Operator version has been tested and validated to work correctly with a specific Hazelcast version. You can find the test matrix below. We highly recommend you to consider it to avoid issues during Operator installations.
66+
67+
[cols="1,1"options="header"]
68+
|===
69+
| Operator Version | Hazelcast Version
70+
| 5.5 | 5.1.4
71+
| 5.6 | 5.2.1
72+
| 5.7 | 5.2.3
73+
| 5.8 | 5.3.1
74+
| 5.9 | 5.3.2
75+
| 5.10 | 5.3.5
76+
| 5.11 | 5.4.0
77+
| 5.12 | 5.4.0
78+
| 5.13 | 5.5.0
79+
| 5.14 | 5.5.2
80+
|===

0 commit comments

Comments
 (0)