Skip to content

Commit

Permalink
doc: add VolumeGroupSnapshot examples for RBD
Browse files Browse the repository at this point in the history
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 <[email protected]>
  • Loading branch information
nixpanic committed Oct 14, 2024
1 parent 3802dd2 commit f23a322
Show file tree
Hide file tree
Showing 3 changed files with 34 additions and 0 deletions.
13 changes: 13 additions & 0 deletions examples/rbd/groupsnapshot.yaml
Original file line number Diff line number Diff line change
@@ -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
19 changes: 19 additions & 0 deletions examples/rbd/groupsnapshotclass.yaml
Original file line number Diff line number Diff line change
@@ -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
2 changes: 2 additions & 0 deletions examples/rbd/pvc.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -3,6 +3,8 @@ apiVersion: v1
kind: PersistentVolumeClaim
metadata:
name: rbd-pvc
labels:
group: test
spec:
accessModes:
- ReadWriteOnce
Expand Down

0 comments on commit f23a322

Please sign in to comment.