Documentation changes for SYNC replication (#1289)

* Updated the docs for SYNC * Updated the docs for SYNC * Updated the docs for SYNC * Updated the docs for SYNC
dell · Oct 16, 2024 · dd03932 · dd03932
1 parent afa5749
commit dd03932
Show file tree

Hide file tree

Showing 3 changed files with 10 additions and 1 deletion.
diff --git a/content/docs/deployment/helm/modules/installation/replication/powerstore.md b/content/docs/deployment/helm/modules/installation/replication/powerstore.md
@@ -228,6 +228,12 @@ On your source cluster, create a PersistentVolumeClaim using one of the replicat
 The CSI PowerStore driver will create a volume on the array, add it to a VolumeGroup and configure replication
 using the parameters provided in the replication enabled Storage Class.
 
+>**NOTE**:  
+    To add or remove volumes in an existing SYNC Replication Group in PowerStore, first pause the replication group, add or delete the volume, and then resume the replication group.<br>
+    Use the following commands:<br>
+    > - Pause the replication group:  `repctl --rg <rg-id> exec -a suspend` 
+    > - Resume the replication group:   `repctl --rg <rg-id> exec -a resume`  
+
 ### Supported Replication Actions
 The CSI PowerStore driver supports the following list of replication actions:
 - FAILOVER_REMOTE

diff --git a/content/docs/replication/_index.md b/content/docs/replication/_index.md
@@ -22,7 +22,7 @@ CSM for Replication provides the following capabilities:
 | Asynchronous file volume replication                                                                                                |   no     |     no     |    yes     |    no     |  no   |
 | Asynchronous block volume replication                                                                                               |   yes    |    yes     |    n/a     |    yes    |  no   |
 | Synchronous file volume replication                                                                                                 |   no     |     no     |     no     |    no     |  no   |
-| Synchronous block volume replication                                                                                                |   yes    |     no     |    n/a     |    no     |  no   |
+| Synchronous block volume replication                                                                                                |   yes    |     yes    |    n/a     |    no     |  no   |
 | Active-Active (Metro) block volume replication                                                                                      |   yes    |     yes    |    n/a     |    no     |  no   |
 | Active-Active (Metro) file volume replication                                                                                       |   no     |     no     |     no     |    no     |  no   |
 | Create `PersistentVolume` objects in the cluster representing the replicated volume                                                 |   yes    |    yes     |    yes     |    yes    |  no   |
@@ -32,6 +32,8 @@ CSM for Replication provides the following capabilities:
 | Provides a command line utility - [repctl](tools) for configuring & managing replication related resources across multiple clusters |   yes    |    yes     |    yes     |    yes    |  no   |
 {{</table>}}
 
+> _**NOTE**_: To add or delete volumes to the existing SYNC Replication Group in PowerStore, the user needs to pause and then resume the replication group. For more details, please refer to the troubleshooting section.
+
 ## Details
 
 As on the storage arrays, all replication related Kubernetes entities are required/created in pairs -

diff --git a/content/docs/replication/troubleshooting.md b/content/docs/replication/troubleshooting.md
@@ -16,3 +16,4 @@ description: >
 | When installing common replication controller using helm you see an error that states `invalid ownership metadata` and `missing key "app.kubernetes.io/managed-by": must be set to "Helm"` | This means that you haven't fully deleted the previous release, you can fix it by either deleting entire manifest by using `kubectl delete -f deploy/controller.yaml` or manually deleting conflicting resources (ClusterRoles, ClusterRoleBinding, etc.) |
 | PV and/or PVCs are not being created at the source/target cluster. If you check the controller's logs you can see `no such host` errors| Make sure cluster-1's API is pingable from cluster-2 and vice versa. If one of your clusters is OpenShift located in a private network and needs records in /etc/hosts, `exec` into controller pod and modify `/etc/hosts` manually. |
 | After upgrading to Replication v1.4.0, if `kubectl get rg` returns an error `Unable to list "replication.storage.dell.com/v1alpha1, Resource=dellcsireplicationgroups"`| This means `kubectl` still doesn't recognize the new version of CRD `dellcsireplicationgroups.replication.storage.dell.com` after upgrade. Running the command `kubectl get DellCSIReplicationGroup.v1.replication.storage.dell.com/<rg-id> -o yaml` will resolve the issue. |
+| To add or delete volumes in the existing SYNC Replication Group in PowerStore, you may encounter the error `The operation is restricted as sync replication session for resource <Replication Group Name> is not paused` | To resolve this, you need to pause the replication group, add the volume, and then resume the replication group (RG). The commands for the pause and resume operations are: `repctl --rg <rg-id> exec -a suspend`  `repctl --rg <rg-id> exec -a resume` |