diff --git a/docs/ceph-csi-upgrade.md b/docs/ceph-csi-upgrade.md index 09a36d5dd..594a10b60 100644 --- a/docs/ceph-csi-upgrade.md +++ b/docs/ceph-csi-upgrade.md @@ -2,7 +2,7 @@ - [Ceph-csi Upgrade](#ceph-csi-upgrade) - [Pre-upgrade considerations](#pre-upgrade-considerations) - - [snapshot-controller and snapshot Beta CRD](#snapshot-controller-and-snapshot-beta-crd) + - [snapshot-controller and snapshot CRD](#snapshot-controller-and-snapshot-crd) - [Upgrading from v1.2 to v2.0](#upgrading-from-v12-to-v20) - [Upgrading from v2.0 to v2.1](#upgrading-from-v20-to-v21) - [Upgrading from v2.1 to v3.0](#upgrading-from-v21-to-v30) @@ -52,7 +52,7 @@ fuse client or rbd-nbd as of now. This guide will walk you through the steps to upgrade the software in a cluster from v3.0 to v3.1 -### Snapshot-controller +### Snapshot-controller and snapshot crd Its kubernetes distributor responsibility to install new snapshot controller and snapshot CRD. more info can be found diff --git a/docs/releases.md b/docs/releases.md index 4a943708a..44b7786cd 100644 --- a/docs/releases.md +++ b/docs/releases.md @@ -1,10 +1,10 @@ # Ceph CSI driver Release Process -- [Ceph CSI driver Release Process](#Ceph-csi-driver-release-process) +- [Ceph CSI driver Release Process](#ceph-csi-driver-release-process) - [Introduction](#introduction) - [Versioning](#versioning) - [Tagging repositories](#tagging-repositories) - - [Release process](#release-process) + - [Release process](#release-process-tbd) ## Introduction diff --git a/docs/snap-clone.md b/docs/snap-clone.md index 5220f67de..6d502552b 100644 --- a/docs/snap-clone.md +++ b/docs/snap-clone.md @@ -4,12 +4,12 @@ - [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) + - [Restore CephFS Snapshot to a new PVC](#restore-cephfs-snapshot) - [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) + - [Restore RBD Snapshot to a new PVC](#restore-rbd-snapshot) - [Clone RBD PVC](#clone-rbd-pvc) ## Prerequisite @@ -48,13 +48,13 @@ on the PVC are deleted before you delete the PVC.** ## Create CephFS Snapshot and Clone Volume -### Create SnapshotClass +### Create CephFS SnapshotClass ```console kubectl create -f ../examples/cephfs/snapshotclass.yaml ``` -### Create Snapshot +### Create CephFS Snapshot The snapshot is created on/for an existing PVC. You should have a PVC in bound state before creating snapshot from it. @@ -94,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 CephFS Snapshot ```console kubectl create -f ../examples/cephfs/pvc-restore.yaml @@ -107,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 CephFS PVC ```console kubectl create -f ../examples/cephfs/pvc-clone.yaml @@ -135,7 +135,7 @@ have to edit any other file. After configuring everything you needed, deploy the snapshotclass: -### Create RBD-SnapshotClass +### Create RBD SnapshotClass ```bash kubectl create -f snapshotclass.yaml @@ -149,7 +149,7 @@ NAME AGE csi-rbdplugin-snapclass 4s ``` -### Create rbd-Snapshot +### Create RBD Snapshot ```bash kubectl create -f snapshot.yaml @@ -196,7 +196,7 @@ Status: Events: ``` -### Restore the Snapshot +### Restore RBD Snapshot To restore the snapshot to a new PVC, create [pvc-restore.yaml](../examples/rbd/pvc-restore.yaml) @@ -207,7 +207,7 @@ kubectl create -f pvc-restore.yaml kubectl create -f pod-restore.yaml ``` -### Clone the PVC +### Clone RBD PVC ```console $ kubectl create -f ../examples/rbd/pvc-clone.yaml