doc: add VolumeGroupSnapshot examples for RBD

By labelling the PersistentVolumeClaim with `group: test`, the label
selector in the VolumeGroupSnapshot will create a snapshot of an RBD
group containing the single volume (or more if there are other volumes
in the same namespace with that label).

Once the VolumeGroupSnapshot is created, each volume in the group will
have a VolumeSnapshot that can be restored.

Signed-off-by: Niels de Vos <ndevos@ibm.com>
This commit is contained in:
Niels de Vos 2024-10-11 08:56:04 +02:00 committed by mergify[bot]
parent 6df173dbf3
commit 395b062d65
3 changed files with 34 additions and 0 deletions

View File

@ -0,0 +1,13 @@
---
apiVersion: groupsnapshot.storage.k8s.io/v1alpha1
kind: VolumeGroupSnapshot
metadata:
name: rbd-groupsnapshot
spec:
source:
selector:
matchLabels:
# The PVCs will need to have this label for it to be
# included in the VolumeGroupSnapshot
group: test
volumeGroupSnapshotClassName: csi-rbdplugin-groupsnapclass

View File

@ -0,0 +1,19 @@
---
apiVersion: groupsnapshot.storage.k8s.io/v1alpha1
kind: VolumeGroupSnapshotClass
metadata:
name: csi-rbdplugin-groupsnapclass
driver: rbd.csi.ceph.com
parameters:
# String representing a Ceph cluster to provision storage from.
# Should be unique across all Ceph clusters in use for provisioning,
# cannot be greater than 36 bytes in length, and should remain immutable for
# the lifetime of the StorageClass in use
clusterID: <cluster-id>
# eg: pool: rbdpool
pool: <rbd-pool-name>
csi.storage.k8s.io/group-snapshotter-secret-name: csi-rbd-secret
csi.storage.k8s.io/group-snapshotter-secret-namespace: default
deletionPolicy: Delete

View File

@ -3,6 +3,8 @@ apiVersion: v1
kind: PersistentVolumeClaim kind: PersistentVolumeClaim
metadata: metadata:
name: rbd-pvc name: rbd-pvc
labels:
group: test
spec: spec:
accessModes: accessModes:
- ReadWriteOnce - ReadWriteOnce