doc: Update documentation for volume clone #14190

yati1998 · 2024-05-13T04:33:31Z

After cross-storageclass clone/restore, now we can clone across different storageclass.
This commit updates the documentation indicating
the same.

parth-gr · 2024-05-13T07:56:07Z

Documentation/Storage-Configuration/Ceph-CSI/ceph-csi-volume-clone.md

-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 storageclass (not necessarily same as Parent PVC) with the


The storageClassName can be any RBD storageclass (not necessarily same as Parent PVC) with the

can we make this section as a note?

parth-gr · 2024-05-13T07:57:27Z

Documentation/Storage-Configuration/Ceph-CSI/ceph-csi-volume-clone.md

+The `storageClassName` can be any storageclass (not necessarily same as Parent PVC) with the
+following conditions:
+
+* `provisinor` should be same for both the Parent PVC and the Clone PVC.


does clone doesnt work cross operator? LIke in a DR operation where there maybe two rook operator?

In the case of 2 different rook operators, the provisioner name will be different too right? hence it won't work for that case

so we can say clone doesn't work cross-cluster....

parth-gr · 2024-05-13T07:58:09Z

Documentation/Storage-Configuration/Ceph-CSI/ceph-csi-volume-clone.md

+following conditions:
+
+* `provisinor` should be same for both the Parent PVC and the Clone PVC.
+* The non-encrypted PVC cannot be cloned to an encrypted one and vise-versa.


can we have a high level chart,

encrypted -> encrypted possible
encrypted -> non-encrypted not possible
and soo on....

travisn · 2024-05-13T14:20:59Z

Documentation/Storage-Configuration/Ceph-CSI/ceph-csi-volume-clone.md

+CSI driver. The `dataSource` kind should be the `PersistentVolumeClaim`.
+The `storageClassName` can be any RBD storageclass (not necessarily same as Parent PVC)
+
+!!!note


The notes are usually just short unformatted paragraphs. If using bullets, let's not use the "!!! note". How about this?

Suggested change

!!!note

Please note:

travisn · 2024-05-13T14:22:22Z

Documentation/Storage-Configuration/Ceph-CSI/ceph-csi-volume-clone.md

+The `storageClassName` can be any RBD storageclass (not necessarily same as Parent PVC)
+
+!!!note
+    * `provisinor` should be same for both the Parent PVC and the Clone PVC.


What if the provisioner is not the same? Is there a scenario for that? If not, let's use "must" instead of "should"

Suggested change

* `provisinor` should be same for both the Parent PVC and the Clone PVC.

* `provisioner` must be same for both the Parent PVC and the Clone PVC.

travisn · 2024-05-13T14:22:55Z

Documentation/Storage-Configuration/Ceph-CSI/ceph-csi-volume-clone.md

+
+!!!note
+    * `provisinor` should be same for both the Parent PVC and the Clone PVC.
+    * The non-encrypted PVC cannot be cloned to an encrypted one and vise-versa.


Suggested change

* The non-encrypted PVC cannot be cloned to an encrypted one and vise-versa.

* The non-encrypted PVC cannot be cloned to an encrypted one and vice-versa.

travisn · 2024-05-13T14:23:21Z

Documentation/Storage-Configuration/Ceph-CSI/ceph-csi-volume-clone.md

+The `storageClassName` can be any CephFS storageclass (not necessarily same as Parent PVC)
+
+!!!note
+    * `provisinor` should be same for both the Parent PVC and the Clone PVC.


Suggested change

* `provisinor` should be same for both the Parent PVC and the Clone PVC.

* `provisioner` must be the same for both the Parent PVC and the Clone PVC.

travisn · 2024-05-13T14:23:28Z

Documentation/Storage-Configuration/Ceph-CSI/ceph-csi-volume-clone.md

+CSI driver. The `dataSource` kind should be the `PersistentVolumeClaim`.
+The `storageClassName` can be any CephFS storageclass (not necessarily same as Parent PVC)
+
+!!!note


same as above

travisn · 2024-05-13T14:23:37Z

Documentation/Storage-Configuration/Ceph-CSI/ceph-csi-volume-clone.md

+
+!!!note
+    * `provisinor` should be same for both the Parent PVC and the Clone PVC.
+    * The non-encrypted PVC cannot be cloned to an encrypted one and vise-versa.


Suggested change

* The non-encrypted PVC cannot be cloned to an encrypted one and vise-versa.

* The non-encrypted PVC cannot be cloned to an encrypted one and vice-versa.

travisn · 2024-05-13T16:14:50Z

Documentation/Storage-Configuration/Ceph-CSI/ceph-csi-volume-clone.md

+The `storageClassName` can be any RBD storageclass (not necessarily same as Parent PVC)
+
+Please note:
+    * `provisinor` must be the same for both the Parent PVC and the Clone PVC.


typo?

Suggested change

* `provisinor` must be the same for both the Parent PVC and the Clone PVC.

* `provisioner` must be the same for both the Parent PVC and the Clone PVC.

oops, thanks for the catch

parth-gr

lgtm

Madhu-1 · 2024-05-14T06:09:56Z

Documentation/Storage-Configuration/Ceph-CSI/ceph-csi-volume-clone.md

+        * encrypted -> encrypted (possible)
+        * non-encrypted -> non-encrypted (possible)
+        * encrypted -> non-encrypted (not possible)
+        * non-encrypted -> encryptes (not possible)


encryptes to encrypted

Madhu-1 · 2024-05-14T06:10:24Z

Documentation/Storage-Configuration/Ceph-CSI/ceph-csi-volume-clone.md

+        * encrypted -> encrypted (possible)
+        * non-encrypted -> non-encrypted (possible)
+        * encrypted -> non-encrypted (not possible)
+        * non-encrypted -> encryptes (not possible)


encryptes to encrypted

Documentation/Storage-Configuration/Ceph-CSI/ceph-csi-volume-clone.md

yati1998 · 2024-05-16T06:37:24Z

/retest Linters

yati1998 · 2024-05-16T06:38:03Z

@Madhu-1 can you please review the PR again. I have updated the same for PVC-restore.

Madhu-1 · 2024-05-16T06:58:45Z

Documentation/Storage-Configuration/Ceph-CSI/ceph-csi-snapshot.md

+
+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.


cannot be cloned to cannot be restored

Madhu-1 · 2024-05-16T06:59:39Z

Documentation/Storage-Configuration/Ceph-CSI/ceph-csi-snapshot.md

@@ -143,7 +152,16 @@ The snapshot will be ready to restore to a new PVC when `READYTOUSE` field of th
 In
 [pvc-restore](https://github.com/rook/rook/tree/master/deploy/examples/csi/cephfs/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


This is not applicable to cephfs as of today as we don't support cephfs encryption yet.

Madhu-1 · 2024-05-16T07:00:11Z

Documentation/Storage-Configuration/Ceph-CSI/ceph-csi-volume-clone.md

@@ -55,8 +63,16 @@ kubectl delete -f deploy/examples/csi/rbd/pvc-clone.yaml

 In [pvc-clone](https://github.com/rook/rook/tree/master/deploy/examples/csi/cephfs/pvc-clone.yaml),
 `dataSource` should be the name of the `PVC` which is already created by CephFS
-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`.


Lets not update cephfs section as nothing is tested or support yet.

after cross-storageclass clone/restore, now we can clone across different storageclass. this commit updates the documentation indicating the same. Signed-off-by: yati1998 <ypadia@redhat.com>

doc: Update documentation for volume clone (backport #14190)

yati1998 requested review from travisn and Madhu-1 May 13, 2024 04:33

yati1998 force-pushed the cross-storage branch 2 times, most recently from 3c18878 to aac9b7d Compare May 13, 2024 05:37

parth-gr requested changes May 13, 2024

View reviewed changes

yati1998 force-pushed the cross-storage branch from aac9b7d to cdf59bf Compare May 13, 2024 08:26

yati1998 requested a review from parth-gr May 13, 2024 08:26

parth-gr added the skip-ci label May 13, 2024

yati1998 force-pushed the cross-storage branch from cdf59bf to f9cf063 Compare May 13, 2024 10:36

travisn requested changes May 13, 2024

View reviewed changes

yati1998 force-pushed the cross-storage branch from f9cf063 to 73a5e94 Compare May 13, 2024 15:46

yati1998 requested a review from travisn May 13, 2024 15:46

travisn requested changes May 13, 2024

View reviewed changes

yati1998 force-pushed the cross-storage branch from 73a5e94 to 90fd81b Compare May 13, 2024 16:47

travisn approved these changes May 13, 2024

View reviewed changes

parth-gr approved these changes May 14, 2024

View reviewed changes

Madhu-1 requested changes May 14, 2024

View reviewed changes

yati1998 force-pushed the cross-storage branch from 90fd81b to c86db0b Compare May 14, 2024 06:16

yati1998 requested a review from Madhu-1 May 14, 2024 06:20

yati1998 force-pushed the cross-storage branch from c86db0b to a265f6a Compare May 14, 2024 13:52

Madhu-1 reviewed May 16, 2024

View reviewed changes

yati1998 force-pushed the cross-storage branch 2 times, most recently from dc9572f to 05ecc8b Compare May 16, 2024 07:46

docs: update documentation for volume clone

945da17

after cross-storageclass clone/restore, now we can clone across different storageclass. this commit updates the documentation indicating the same. Signed-off-by: yati1998 <ypadia@redhat.com>

yati1998 force-pushed the cross-storage branch from 05ecc8b to 945da17 Compare May 16, 2024 07:47

yati1998 requested a review from Madhu-1 May 16, 2024 07:48

Madhu-1 approved these changes May 16, 2024

View reviewed changes

travisn added the backport-release-1.14 label May 16, 2024

travisn merged commit 9f3d76c into rook:master May 16, 2024
19 checks passed

mergify bot mentioned this pull request May 16, 2024

doc: Update documentation for volume clone (backport #14190) #14226

Merged

travisn added a commit that referenced this pull request May 16, 2024

Merge pull request #14226 from rook/mergify/bp/release-1.14/pr-14190

4b5c73c

doc: Update documentation for volume clone (backport #14190)

yati1998 mentioned this pull request May 17, 2024

Update the document for volume cloning #14085

Closed

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

doc: Update documentation for volume clone #14190

doc: Update documentation for volume clone #14190

yati1998 commented May 13, 2024

parth-gr May 13, 2024

parth-gr May 13, 2024

parth-gr May 13, 2024

parth-gr May 13, 2024

yati1998 May 13, 2024

parth-gr May 13, 2024

parth-gr May 13, 2024

travisn May 13, 2024

travisn May 13, 2024

travisn May 13, 2024

travisn May 13, 2024

travisn May 13, 2024

travisn May 13, 2024

travisn May 13, 2024

yati1998 May 13, 2024

parth-gr left a comment

Madhu-1 May 14, 2024

Madhu-1 May 14, 2024

yati1998 commented May 16, 2024

yati1998 commented May 16, 2024

Madhu-1 May 16, 2024

Madhu-1 May 16, 2024

Madhu-1 May 16, 2024

	* `provisinor` should be same for both the Parent PVC and the Clone PVC.
	* `provisioner` must be same for both the Parent PVC and the Clone PVC.

	* The non-encrypted PVC cannot be cloned to an encrypted one and vise-versa.
	* The non-encrypted PVC cannot be cloned to an encrypted one and vice-versa.

	* `provisinor` should be same for both the Parent PVC and the Clone PVC.
	* `provisioner` must be the same for both the Parent PVC and the Clone PVC.

	* `provisinor` must be the same for both the Parent PVC and the Clone PVC.
	* `provisioner` must be the same for both the Parent PVC and the Clone PVC.

doc: Update documentation for volume clone #14190

doc: Update documentation for volume clone #14190

Conversation

yati1998 commented May 13, 2024

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

parth-gr left a comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

yati1998 commented May 16, 2024

yati1998 commented May 16, 2024

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment