Merge pull request #14190 from yati1998/cross-storage

doc: Update documentation for volume clone
rook · May 16, 2024 · 9f3d76c · 9f3d76c
2 parents bde9b40 + 945da17
commit 9f3d76c
Show file tree

Hide file tree

Showing 2 changed files with 20 additions and 3 deletions.
diff --git a/Documentation/Storage-Configuration/Ceph-CSI/ceph-csi-snapshot.md b/Documentation/Storage-Configuration/Ceph-CSI/ceph-csi-snapshot.md
@@ -66,7 +66,16 @@ The snapshot will be ready to restore to a new PVC when the `READYTOUSE` field o
 
 In [pvc-restore](https://github.com/rook/rook/tree/master/deploy/examples/csi/rbd/pvc-restore.yaml),
 `dataSource` should be the name of the `VolumeSnapshot` previously
-created. The `dataSource` kind should be the `VolumeSnapshot`.
+created. The `dataSource` kind should be the `VolumeSnapshot`. The `storageClassName`
+can be any RBD storageclass.
+
+Please Note:
+    * `provisioner` must be the same for both the Parent PVC and the restored PVC.
+    * The non-encrypted PVC cannot be restored to an encrypted one and vice-versa.
+        * encrypted -> encrypted (possible)
+        * non-encrypted -> non-encrypted (possible)
+        * encrypted -> non-encrypted (not possible)
+        * non-encrypted -> encrypted (not possible)
 
 Create a new PVC from the snapshot
 

diff --git a/Documentation/Storage-Configuration/Ceph-CSI/ceph-csi-volume-clone.md b/Documentation/Storage-Configuration/Ceph-CSI/ceph-csi-volume-clone.md
@@ -17,8 +17,16 @@ for more info.
 
 In [pvc-clone](https://github.com/rook/rook/tree/master/deploy/examples/csi/rbd/pvc-clone.yaml),
 `dataSource` should be the name of the `PVC` which is already created by RBD
-CSI driver. The `dataSource` kind should be the `PersistentVolumeClaim` and also storageclass
-should be same as the source `PVC`.
+CSI driver. The `dataSource` kind should be the `PersistentVolumeClaim`.
+The `storageClassName` can be any RBD storageclass (not necessarily same as Parent PVC)
+
+Please note:
+    * `provisioner` must be the same for both the Parent PVC and the Clone PVC.
+    * The non-encrypted PVC cannot be cloned to an encrypted one and vice-versa.
+        * encrypted -> encrypted (possible)
+        * non-encrypted -> non-encrypted (possible)
+        * encrypted -> non-encrypted (not possible)
+        * non-encrypted -> encrypted (not possible)
 
 Create a new PVC Clone from the PVC