Add support for Volume snapshot for CloudStack CSI driver

Author: Pearl1594

deploy/k8s/controller-deployment.yaml

@@ -178,8 +178,45 @@ spec:
               type: RuntimeDefault
             readOnlyRootFilesystem: true
             allowPrivilegeEscalation: false
-
+        - name: csi-snapshotter
+          image: registry.k8s.io/sig-storage/csi-snapshotter:v6.3.0
+          args:
+            - "--v=5"
+            - "--csi-address=$(CSI_ADDRESS)"
+            - "--leader-election"
+            - "--leader-election-lease-duration=30s"
+            - "--leader-election-renew-deadline=20s"
+            - "--leader-election-retry-period=10s"
+          env:
+            - name: CSI_ADDRESS
+              value: /var/lib/csi/sockets/pluginproxy/csi.sock
+          volumeMounts:
+            - name: socket-dir
+              mountPath: /var/lib/csi/sockets/pluginproxy/
+          resources:
+            limits:
+              cpu: 400m
+              memory: 200Mi
+            requests:
+              cpu: 10m
+              memory: 20Mi
+        - name: snapshot-controller
+          image: registry.k8s.io/sig-storage/snapshot-controller:v6.3.0
+          args:
+            - "--v=5"
+            - "--leader-election"
+            - "--leader-election-lease-duration=30s"
+            - "--leader-election-renew-deadline=20s"
+            - "--leader-election-retry-period=10s"
+          resources:
+            limits:
+              cpu: 400m
+              memory: 200Mi
+            requests:
+              cpu: 10m
+              memory: 20Mi
         - name: liveness-probe
+          imagePullPolicy: IfNotPresent
           image: registry.k8s.io/sig-storage/livenessprobe:v2.12.0
           args:
             - "--v=4"

deploy/k8s/rbac.yaml

@@ -36,6 +36,9 @@ rules:
   - apiGroups: ["storage.k8s.io"]
     resources: ["volumeattachments/status"]
     verbs: ["patch"]
+  - apiGroups: ["snapshot.storage.k8s.io"]
+    resources: ["volumesnapshots", "volumesnapshots/status", "volumesnapshotclasses", "volumesnapshotcontents", "volumesnapshotcontents/status"]
+    verbs: ["get", "list", "watch", "update", "create", "patch"]  
 ---
 apiVersion: rbac.authorization.k8s.io/v1
 kind: ClusterRoleBinding

deploy/k8s/volume-snapshot-class.yaml

@@ -0,0 +1,6 @@
+apiVersion: snapshot.storage.k8s.io/v1
+kind: VolumeSnapshotClass
+metadata:
+  name: cloudstack-snapshot
+driver: csi.cloudstack.apache.org
+deletionPolicy: Delete

examples/k8s/snapshot/pvc-from-snapshot.yaml

@@ -0,0 +1,15 @@
+apiVersion: v1
+kind: PersistentVolumeClaim
+metadata:
+  name: snapshot-pvc-1
+spec:
+  accessModes:
+    - ReadWriteOnce
+  resources:
+    requests:
+      storage: 10Gi
+  dataSource:
+    name: snapshot-1
+    kind: VolumeSnapshot
+    apiGroup: snapshot.storage.k8s.io
+  storageClassName: cloudstack-custom

examples/k8s/snapshot/pvc.yaml

@@ -0,0 +1,11 @@
+apiVersion: v1
+kind: PersistentVolumeClaim
+metadata:
+  name: my-pvc
+spec:
+  accessModes:
+  - ReadWriteOnce
+  resources:
+    requests:
+      storage: 10Gi
+  storageClassName: cloudstack-custom

examples/k8s/snapshot/snapshot.yaml

@@ -0,0 +1,8 @@
+apiVersion: snapshot.storage.k8s.io/v1
+kind: VolumeSnapshot
+metadata:
+  name: snapshot-1
+spec:
+  volumeSnapshotClassName: cloudstack-snapshot
+  source:
+    persistentVolumeClaimName: my-pvc

pkg/cloud/cloud.go

@@ -23,6 +23,10 @@ type Interface interface {
 	AttachVolume(ctx context.Context, volumeID, vmID string) (string, error)
 	DetachVolume(ctx context.Context, volumeID string) error
 	ExpandVolume(ctx context.Context, volumeID string, newSizeInGB int64) error
+
+	CreateVolumeFromSnapshot(ctx context.Context, diskOfferingID, zoneID, name, domainID, projectID, snapshotID string, sizeInGB int64) (string, error)
+	CreateSnapshot(ctx context.Context, volumeID string) (*Snapshot, error)
+	DeleteSnapshot(ctx context.Context, snapshotID string) error
 }
 
 // Volume represents a CloudStack volume.
@@ -34,12 +38,26 @@ type Volume struct {
 	Size int64
 
 	DiskOfferingID string
+	DomainID       string
+	ProjectID      string
 	ZoneID         string
 
 	VirtualMachineID string
 	DeviceID         string
 }
 
+type Snapshot struct {
+	ID   string
+	Name string
+
+	DomainID  string
+	ProjectID string
+	ZoneID    string
+
+	VolumeID  string
+	CreatedAt string
+}
+
 // VM represents a CloudStack Virtual Machine.
 type VM struct {
 	ID     string

pkg/cloud/fake/fake.go

@@ -15,6 +15,7 @@ const zoneID = "a1887604-237c-4212-a9cd-94620b7880fa"
 
 type fakeConnector struct {
 	node          *cloud.VM
+	snapshot      *cloud.Snapshot
 	volumesByID   map[string]cloud.Volume
 	volumesByName map[string]cloud.Volume
 }
@@ -36,8 +37,18 @@ func New() cloud.Interface {
 		ZoneID: zoneID,
 	}
 
+	snapshot := &cloud.Snapshot{
+		ID:        "9d076136-657b-4c84-b279-455da3ea484c",
+		Name:      "pvc-vol-snap-1",
+		DomainID:  "51f0fcb5-db16-4637-94f5-30131010214f",
+		ZoneID:    "bdab539f-651e-431a-979d-5d3c48b54fcf",
+		VolumeID:  "4f1f610d-6f17-4ff9-9228-e4062af93e54",
+		CreatedAt: "2025-07-07 16:13:06",
+	}
+
 	return &fakeConnector{
 		node:          node,
+		snapshot:      snapshot,
 		volumesByID:   map[string]cloud.Volume{volume.ID: volume},
 		volumesByName: map[string]cloud.Volume{volume.Name: volume},
 	}
@@ -124,3 +135,15 @@ func (f *fakeConnector) ExpandVolume(_ context.Context, volumeID string, newSize
 
 	return cloud.ErrNotFound
 }
+
+func (f *fakeConnector) CreateVolumeFromSnapshot(ctx context.Context, diskOfferingID, zoneID, name, domainID, projectID, snapshotID string, sizeInGB int64) (string, error) {
+	return "1", nil
+}
+
+func (f *fakeConnector) CreateSnapshot(ctx context.Context, volumeID string) (*cloud.Snapshot, error) {
+	return f.snapshot, nil
+}
+
+func (f *fakeConnector) DeleteSnapshot(ctx context.Context, snapshotID string) error {
+	return nil
+}

pkg/cloud/snapshots.go

@@ -0,0 +1,64 @@
+package cloud
+
+import (
+	"context"
+	"strings"
+
+	"github.com/apache/cloudstack-go/v2/cloudstack"
+	"google.golang.org/grpc/codes"
+	"google.golang.org/grpc/status"
+)
+
+func (c *client) ListSnapshots(p *cloudstack.ListSnapshotsParams) (*Snapshot, error) {
+	l, err := c.Snapshot.ListSnapshots(p)
+	if err != nil {
+		return nil, err
+	}
+	if l.Count == 0 {
+		return nil, ErrNotFound
+	}
+	if l.Count > 1 {
+		return nil, ErrTooManyResults
+	}
+	snapshot := l.Snapshots[0]
+	s := Snapshot{
+		ID:        snapshot.Id,
+		Name:      snapshot.Name,
+		DomainID:  snapshot.Domainid,
+		ProjectID: snapshot.Projectid,
+		ZoneID:    snapshot.Zoneid,
+		VolumeID:  snapshot.Volumeid,
+	}
+
+	return &s, nil
+}
+
+func (c *client) CreateSnapshot(ctx context.Context, volumeID string) (*Snapshot, error) {
+	p := c.Snapshot.NewCreateSnapshotParams(volumeID)
+	snapshot, err := c.Snapshot.CreateSnapshot(p)
+	if err != nil {
+		return nil, status.Errorf(codes.Internal, "Error %v", err)
+	}
+
+	snap := Snapshot{
+		ID:        snapshot.Id,
+		Name:      snapshot.Name,
+		DomainID:  snapshot.Domainid,
+		ProjectID: snapshot.Projectid,
+		ZoneID:    snapshot.Zoneid,
+		VolumeID:  snapshot.Volumeid,
+		CreatedAt: snapshot.Created,
+	}
+	return &snap, nil
+}
+
+func (c *client) DeleteSnapshot(ctx context.Context, snapshotID string) error {
+	p := c.Snapshot.NewDeleteSnapshotParams(snapshotID)
+	_, err := c.Snapshot.DeleteSnapshot(p)
+	if err != nil && strings.Contains(err.Error(), "4350") {
+		// CloudStack error InvalidParameterValueException
+		return ErrNotFound
+	}
+
+	return err
+}

pkg/cloud/volumes.go

@@ -29,6 +29,8 @@ func (c *client) listVolumes(p *cloudstack.ListVolumesParams) (*Volume, error) {
 		Name:             vol.Name,
 		Size:             vol.Size,
 		DiskOfferingID:   vol.Diskofferingid,
+		DomainID:         vol.Domainid,
+		ProjectID:        vol.Projectid,
 		ZoneID:           vol.Zoneid,
 		VirtualMachineID: vol.Virtualmachineid,
 		DeviceID:         strconv.FormatInt(vol.Deviceid, 10),
@@ -153,3 +155,34 @@ func (c *client) ExpandVolume(ctx context.Context, volumeID string, newSizeInGB
 
 	return nil
 }
+
+func (c *client) CreateVolumeFromSnapshot(ctx context.Context, diskOfferingID, zoneID, name, domainID, projectID, snapshotID string, sizeInGB int64) (string, error) {
+	logger := klog.FromContext(ctx)
+	snapshot, _, err := c.Snapshot.GetSnapshotByID(snapshotID)
+	if err != nil {
+		return "", fmt.Errorf("failed to retrieve snapshot '%s': %w", snapshotID, err)
+	}
+
+	p := c.Volume.NewCreateVolumeParams()
+	p.SetDiskofferingid(diskOfferingID)
+	p.SetZoneid(zoneID)
+	if projectID != "" {
+		p.SetProjectid(projectID)
+	}
+	p.SetName(name)
+	p.SetSnapshotid(snapshot.Id)
+
+	logger.V(2).Info("CloudStack API call", "command", "CreateVolume", "params", map[string]string{
+		"name":       name,
+		"snapshotid": snapshotID,
+		"projectid":  projectID,
+	})
+	// Execute the API call to create volume from snapshot
+	vol, err := c.Volume.CreateVolume(p)
+	if err != nil {
+		// Handle the error accordingly
+		return "", fmt.Errorf("failed to create volume from snapshot'%s': %w", snapshotID, err)
+	}
+
+	return vol.Id, err
+}