From 98e51ae8e6f243383945c7bab3618eeaadb7139d Mon Sep 17 00:00:00 2001 From: krishhna24 Date: Thu, 10 Sep 2026 18:38:15 +0530 Subject: [PATCH 1/2] docs: fix VolumeGroupSnapshotClass example The example VolumeGroupSnapshotClass cannot be applied as written. It uses apiVersion v1alpha1, which external-snapshotter v8.2.0+ does not serve, and nests driver and deletionPolicy under spec. Both fields are top level and required on the CRD, which has no spec field at all. Applying the documented example fails with: no matches for kind "VolumeGroupSnapshotClass" in version "groupsnapshot.storage.k8s.io/v1alpha1" The same page already states that Velero 1.18.1+ uses the v1beta2 API and requires external-snapshotter v8.2.0 or later, so the example also contradicts its own prerequisites section. Verified against a kind cluster running external-snapshotter v8.6.0: the corrected example passes kubectl apply --dry-run=server, and the CRD reports driver and deletionPolicy as top level and required across v1, v1beta1 and v1beta2. Signed-off-by: krishhna24 --- site/content/docs/main/volume-group-snapshots.md | 7 +++---- site/content/docs/v1.18/volume-group-snapshots.md | 7 +++---- 2 files changed, 6 insertions(+), 8 deletions(-) diff --git a/site/content/docs/main/volume-group-snapshots.md b/site/content/docs/main/volume-group-snapshots.md index e62a75624..9b77979ce 100644 --- a/site/content/docs/main/volume-group-snapshots.md +++ b/site/content/docs/main/volume-group-snapshots.md @@ -160,15 +160,14 @@ kubectl get volumegroupsnapshotclass -o wide **Important:** The VolumeGroupSnapshotClass must have the label `velero.io/csi-volumegroupsnapshot-class: "true"` for Velero to automatically discover and use it: ```yaml -apiVersion: groupsnapshot.storage.k8s.io/v1alpha1 +apiVersion: groupsnapshot.storage.k8s.io/v1beta2 kind: VolumeGroupSnapshotClass metadata: name: csi-vgs-class labels: velero.io/csi-volumegroupsnapshot-class: "true" -spec: - driver: ebs.csi.aws.com - deletionPolicy: Delete +driver: ebs.csi.aws.com +deletionPolicy: Delete ``` Verify your VolumeGroupSnapshotClass has the correct label: diff --git a/site/content/docs/v1.18/volume-group-snapshots.md b/site/content/docs/v1.18/volume-group-snapshots.md index e62a75624..9b77979ce 100644 --- a/site/content/docs/v1.18/volume-group-snapshots.md +++ b/site/content/docs/v1.18/volume-group-snapshots.md @@ -160,15 +160,14 @@ kubectl get volumegroupsnapshotclass -o wide **Important:** The VolumeGroupSnapshotClass must have the label `velero.io/csi-volumegroupsnapshot-class: "true"` for Velero to automatically discover and use it: ```yaml -apiVersion: groupsnapshot.storage.k8s.io/v1alpha1 +apiVersion: groupsnapshot.storage.k8s.io/v1beta2 kind: VolumeGroupSnapshotClass metadata: name: csi-vgs-class labels: velero.io/csi-volumegroupsnapshot-class: "true" -spec: - driver: ebs.csi.aws.com - deletionPolicy: Delete +driver: ebs.csi.aws.com +deletionPolicy: Delete ``` Verify your VolumeGroupSnapshotClass has the correct label: From d4f6eee8997db7e6639c5139a1764310e1aa7e3c Mon Sep 17 00:00:00 2001 From: krishhna24 Date: Thu, 10 Sep 2026 18:39:04 +0530 Subject: [PATCH 2/2] Add changelog for #10520 Signed-off-by: krishhna24 --- changelogs/unreleased/10520-krishhna24 | 1 + 1 file changed, 1 insertion(+) create mode 100644 changelogs/unreleased/10520-krishhna24 diff --git a/changelogs/unreleased/10520-krishhna24 b/changelogs/unreleased/10520-krishhna24 new file mode 100644 index 000000000..6f6f184de --- /dev/null +++ b/changelogs/unreleased/10520-krishhna24 @@ -0,0 +1 @@ +Fix the VolumeGroupSnapshotClass example in the VolumeGroupSnapshot docs