Skip to content

Commit

Permalink
docs: update documentation for volume clone
Browse files Browse the repository at this point in the history
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>
  • Loading branch information
yati1998 committed May 16, 2024
1 parent 39f8852 commit dc9572f
Show file tree
Hide file tree
Showing 2 changed files with 30 additions and 5 deletions.
Original file line number Diff line number Diff line change
Expand Up @@ -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 RBD storageclass.

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 from the snapshot

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -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

Expand Down Expand Up @@ -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`.
The `storageClassName` can be any CephFS 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

Expand Down

0 comments on commit dc9572f

Please sign in to comment.