Tip for local backup CR name (#188)

* Tip for local backup CR name * Update docs/modules/ROOT/pages/backup-restore.adoc Co-authored-by: Kutluhan Metin <[email protected]> * clarify namespace requirement at getting started * Update docs/modules/ROOT/pages/backup-restore.adoc Co-authored-by: Serdar Ozmen <[email protected]> * Update docs/modules/ROOT/pages/backup-restore.adoc Co-authored-by: Serdar Ozmen <[email protected]> * Update docs/modules/ROOT/pages/backup-restore.adoc Co-authored-by: Serdar Ozmen <[email protected]> --------- Co-authored-by: Kutluhan Metin <[email protected]> Co-authored-by: Serdar Ozmen <[email protected]>
hazelcast · Apr 4, 2024 · d6c3afd · d6c3afd
1 parent 6e95348
commit d6c3afd
Show file tree

Hide file tree

Showing 3 changed files with 9 additions and 8 deletions.
diff --git a/docs/modules/ROOT/examples/hazelcast-persistence-restore-cr-name.yaml b/docs/modules/ROOT/examples/hazelcast-persistence-restore-cr-name.yaml
@@ -1,7 +1,7 @@
 apiVersion: hazelcast.com/v1alpha1
 kind: Hazelcast
 metadata:
-  name: hazelcast
+  name: hazelcast <1>
 spec:
   clusterSize: 3
   repository: 'docker.io/hazelcast/hazelcast-enterprise'
@@ -12,6 +12,6 @@ spec:
       accessModes: ["ReadWriteOnce"]
       requestStorage: 20Gi
     restore:
-      hotBackupResourceName: hot-backup <1>
-  agent: <2>
+      hotBackupResourceName: hot-backup <2>
+  agent: <3>
     repository: hazelcast/platform-operator-agent
diff --git a/docs/modules/ROOT/pages/backup-restore.adoc b/docs/modules/ROOT/pages/backup-restore.adoc
@@ -171,11 +171,14 @@ deployed with the Hazelcast container in the same Pod. The agent starts as an in
 include::ROOT:example$/hazelcast-persistence-restore-cr-name.yaml[]
 ----
 
-<1> `HotBackup` resource name used for restore. The backup folder name will be taken from the `HotBackup` resource.
-<2> Agent responsible for restoring data from the local storage.
+<1> Hazelcast custom resource name for both backup and restore CRs must be the same, otherwise, the restore fails.
+<2> `HotBackup` resource name used for the restore. The backup folder name will be the name you provide here.
+<3> Agent responsible for restoring data from the local storage.
 The agent configuration is optional. If you give `restore` under `persistence` and do not pass the agent configuration, Hazelcast Platform Operator
 uses the latest agent version that is compatible with its version.
 
+WARNING: You can use a local backup only once to restore a cluster. We recommend you backup externally if you need to persistently restore a backup across the clusters.
+
 === Restoring from Local Backups Created with other Methods
 
 To restore from local backups that were not created by the HotBackup resource, configure `localConfig`.
@@ -204,8 +207,6 @@ include::ROOT:example$/pod-local-pvc-content.yaml[]
 
 NOTE: Agent copies the backup to be restored from `{baseDir}/{backupDir}/{backupFolder}` to `/data/persistence/base-dir`.
 
-Note: You can only use a local backup once to restore a cluster. It is recommended to backup externally if you need to persistently restore a backup across clusters.
-
 == Restoring from External Backups
 
 To restore a cluster from external backups, you can either set up the bucket configuration or give the `HotBackup` resource name that you used to trigger the external backup. In either case, the backup is restored from the external bucket.

diff --git a/docs/modules/ROOT/pages/get-started.adoc b/docs/modules/ROOT/pages/get-started.adoc
@@ -51,7 +51,7 @@ Run the following commands to *deploy the Operator and the CRDs separately*. An
 helm install operator-crds hazelcast/hazelcast-platform-operator-crds --version={operator-chart-version}
 ----
 
-After installing CRDs, install the Operator by running the following command. This operation requires only namespace-scoped permissions for `hz-system`, `ns-1` and `ns-2` namespaces and they already exist.
+After installing CRDs, install the Operator by running the following command. This operation requires only namespace-scoped permissions for `hz-system`, `ns-1` and `ns-2` namespaces which should already exist.
 
 [source,shell,subs="attributes"]
 ----