From 78968f76e85c0698c430f351ab657146332be522 Mon Sep 17 00:00:00 2001 From: yati1998 Date: Thu, 1 Oct 2020 14:05:28 +0530 Subject: [PATCH] doc: update snap-clone with rbd snapshot RBD Snapshot doc was the part of the README.md file. Hence, renamed the cephfs-snap-clone.md file to snap-clone.md file and moved the rbd snapshot document there. Signed-off-by: yati1998 --- docs/{cephfs-snap-clone.md => snap-clone.md} | 127 +++++++++++++++++-- 1 file changed, 114 insertions(+), 13 deletions(-) rename docs/{cephfs-snap-clone.md => snap-clone.md} (52%) diff --git a/docs/cephfs-snap-clone.md b/docs/snap-clone.md similarity index 52% rename from docs/cephfs-snap-clone.md rename to docs/snap-clone.md index 35a8fcc66..6f1b4e0b3 100644 --- a/docs/cephfs-snap-clone.md +++ b/docs/snap-clone.md @@ -1,12 +1,16 @@ -# Create CephFS snapshot and Clone Volume +# Create snapshot and Clone Volume -- [Create CephFS snapshot and Clone Volume](#create-cephfs-snapshot-and-clone-volume) - - [Prerequisite](#prerequisite) - - [Snapshot](#snapshot) - - [Create snapshotclass](#create-snapshotclass) - - [Create snapshot](#create-snapshot) - - [Restore snapshot to a new PVC](#restore-snapshot-to-a-new-pvc) - - [Clone PVC](#clone-pvc) +- [Prerequisite](#prerequisite) +- [Create CephFS Snapshot and Clone Volume](#create-cephfs-snapshot-and-clone-volume) + - [Create CephFS SnapshotClass](#create-cephfs-snapshotclass) + - [Create CephFS Snapshot](#create-cephfs-snapshot) + - [Restore CephFS Snapshot to a new PVC](#restore-cephfs-snapshot-to-a-new-pvc) + - [Clone CephFS PVC](#clone-cephfs-pvc) +- [Create RBD Snapshot and Clone Volume](#create-rbd-snapshot-and-clone-volume) + - [Create RBD SnapshotClass](#create-rbd-snapshotclass) + - [Create RBD Snapshot](#create-rbd-snapshot) + - [Restore RBD Snapshot to a new PVC](#restore-rbd-snapshot-to-a-new-pvc) + - [Clone RBD PVC](#clone-rbd-pvc) ## Prerequisite @@ -42,15 +46,15 @@ Also PVC cannot be deleted if it's having snapshots. Make sure all the snapshots on the PVC are deleted before you delete the PVC.** -## Snapshot +## Create CephFS Snapshot and Clone Volume -### Create snapshotclass +### Create SnapshotClass ```console kubectl create -f ../examples/cephfs/snapshotclass.yaml ``` -### Create snapshot +### Create Snapshot The snapshot is created on/for an existing PVC. You should have a PVC in bound state before creating snapshot from it. @@ -90,7 +94,7 @@ NAME READYTOUSE RESTORESIZE DE snapcontent-34476204-a14a-4d59-bfbc-2bbba695652c true 1073741824 Delete cephfs.csi.ceph.com csi-cephfsplugin-snapclass cephfs-pvc-snapshot 64s ``` -## Restore snapshot to a new PVC +### Restore Snapshot to a new PVC ```console kubectl create -f ../examples/cephfs/pvc-restore.yaml @@ -103,7 +107,7 @@ csi-cephfs-pvc Bound pvc-1ea51547-a88b-4ab0-8b4a-812caeaf025d 1Gi cephfs-pvc-restore Bound pvc-95308c75-6c93-4928-a551-6b5137192209 1Gi RWX csi-cephfs-sc 11m ``` -## Clone PVC +### Clone PVC ```console kubectl create -f ../examples/cephfs/pvc-clone.yaml @@ -116,3 +120,100 @@ csi-cephfs-pvc Bound pvc-1ea51547-a88b-4ab0-8b4a-812caeaf025d 1Gi cephfs-pvc-clone Bound pvc-b575bc35-d521-4c41-b4f9-1d733cd28fdf 1Gi RWX csi-cephfs-sc 39s cephfs-pvc-restore Bound pvc-95308c75-6c93-4928-a551-6b5137192209 1Gi RWX csi-cephfs-sc 55m ``` + +## Create RBD Snapshot and Clone Volume + +In the `examples/rbd` directory you will find two files related to snapshots: +[snapshotclass.yaml](../examples/rbd/snapshotclass.yaml) +and [snapshot.yaml](../examples/rbd/snapshot.yaml) + +Once you created RBD PVC, you'll need to customize `snapshotclass.yaml` and +make sure the `clusterid` parameter matches `clusterid` mentioned in the +storageclass from which the PVC got created. +If you followed the documentation to create the rbdplugin, you shouldn't +have to edit any other file. + +After configuring everything you needed, deploy the snapshotclass: + +### Create RBD-SnapshotClass + +```bash +kubectl create -f snapshotclass.yaml +``` + +### Verify that the SnapshotClass was created + +```console +$ kubectl get volumesnapshotclass +NAME AGE +csi-rbdplugin-snapclass 4s +``` + +### Create rbd-Snapshot + +```bash +kubectl create -f snapshot.yaml +``` + +### Verify if your Volume Snapshot has successfully been created + +```console +$ kubectl get volumesnapshot +NAME AGE +rbd-pvc-snapshot 6s +``` + +### Check the status of the Snapshot + +```console +$ kubectl describe volumesnapshot rbd-pvc-snapshot + +Name: rbd-pvc-snapshot +Namespace: default +Labels: +Annotations: +API Version: snapshot.storage.k8s.io/v1alpha1 +Kind: VolumeSnapshot +Metadata: + Creation Timestamp: 2019-02-06T08:52:34Z + Finalizers: + snapshot.storage.kubernetes.io/volumesnapshot-protection + Generation: 5 + Resource Version: 84239 + Self Link: /apis/snapshot.storage.k8s.io/v1alpha1/namespaces/default/volumesnapshots/rbd-pvc-snapshot + UID: 8b9b5740-29ec-11e9-8e0f-b8ca3aad030b +Spec: + Snapshot Class Name: csi-rbdplugin-snapclass + Snapshot Content Name: snapcontent-8b9b5740-29ec-11e9-8e0f-b8ca3aad030b + Source: + API Group: + Kind: PersistentVolumeClaim + Name: rbd-pvc +Status: + Creation Time: 2019-02-06T08:52:34Z + Ready To Use: true + Restore Size: 1Gi +Events: +``` + +### Restore the Snapshot + +To restore the snapshot to a new PVC, create +[pvc-restore.yaml](../examples/rbd/pvc-restore.yaml) +and a testing pod [pod-restore.yaml](../examples/rbd/pod-restore.yaml) + +```bash +kubectl create -f pvc-restore.yaml +kubectl create -f pod-restore.yaml +``` + +### Clone the PVC + +```console +$ kubectl create -f ../examples/rbd/pvc-clone.yaml +$ kubectl get pvc +NAME STATUS VOLUME CAPACITY ACCESS MODES STORAGECLASS AGE +rbd-pvc Bound pvc-c2ffdc98-3abe-4b07-838c-35a2a8067771 1Gi RWO rook-ceph-block 41m +rbd-pvc-clone Bound pvc-b575bc35-d521-4c41-b4f9-1d733cd28fdf 1Gi RWO rook-ceph-block 45m +rbd-pvc-restore Bound pvc-95308c75-6c93-4928-a551-6b5137192209 1Gi RWO rook-ceph-block 45m +``` \ No newline at end of file