fix(vd): respect user-specified storage class when restoring from snapshot

[loktev-d]

Description

Fix the VirtualDisk controller to respect user-specified storageClassName when creating disks from VirtualDiskSnapshot. Previously, the controller was always using the storage class from the original disk (stored in VolumeSnapshot annotations), completely ignoring the user-specified value in spec.persistentVolumeClaim.storageClassName. Also add error message when user tries to perform cross-provider restore.

Why do we need it, and what problem does it solve?

When users tried to restore a VirtualDisk from a snapshot with a different storage class, the parameter spec.persistentVolumeClaim.storageClassName was silently ignored. The restored disk would always use the same storage class as the original disk.

What is the expected result?

Checklist

• The code is covered by unit tests.
• e2e tests passed.
• Documentation updated according to the changes.
• Changes were tested in the Kubernetes cluster manually.

Changelog entries

section: vd
type: fix
summary: respect user-specified storage class when restoring from snapshot

[deckhouse-BOaTswain]

Workflow has started.
Follow the progress here: Workflow Run

The target step completed with status: failure.

[deckhouse-BOaTswain]

Workflow has started.
Follow the progress here: Workflow Run

The target step completed with status: failure.

[deckhouse-BOaTswain]

Workflow has started.
Follow the progress here: Workflow Run

The target step completed with status: success.

[deckhouse-BOaTswain]

Workflow has started.
Follow the progress here: Workflow Run

The target step completed with status: failure.

[deckhouse-BOaTswain]

Workflow has started.
Follow the progress here: Workflow Run

The target step completed with status: failure.

[deckhouse-BOaTswain]

Workflow has started.
Follow the progress here: Workflow Run

The target step completed with status: failure.

[deckhouse-BOaTswain]

Workflow has started.
Follow the progress here: Workflow Run

The target step completed with status: failure.

[deckhouse-BOaTswain]

Workflow has started.
Follow the progress here: Workflow Run

The target step completed with status: failure.

[sourcery-ai]

Reviewer's Guide

This PR updates the VirtualDisk controller to respect a user-specified storageClassName when restoring from a snapshot, adds a pre-flight compatibility check to prevent cross-provider restores, and introduces annotation constants for storage provisioner tracking.

Sequence diagram for VirtualDisk restore with user-specified storageClassName and compatibility check

sequenceDiagram
    participant User
    participant Controller
    participant KubernetesAPI
    participant StorageClass
    participant PVC
    participant VolumeSnapshot

    User->>Controller: Request restore VirtualDisk from snapshot
    Controller->>VolumeSnapshot: Fetch snapshot metadata
    Controller->>KubernetesAPI: Fetch user-specified StorageClass
    Controller->>KubernetesAPI: Fetch original PVC from snapshot
    Controller->>KubernetesAPI: Fetch original storage provisioner annotation
    Controller->>StorageClass: Compare provisioner with original
    alt Provisioners are compatible
        Controller->>PVC: Create PVC with user-specified storageClassName
        Controller->>User: Success event
    else Provisioners are incompatible
        Controller->>User: Error event (cross-provider restore not supported)
    end

Loading

Class diagram for CreatePVCFromVDSnapshotStep changes

classDiagram
    class CreatePVCFromVDSnapshotStep {
        +Take(ctx, vd)
        +AddOriginalMetadata(vd)
        +buildPVC(vd, vs)
        +validateStorageClassCompatibility(ctx, vd, vdSnapshot, vs)
    }
    class VirtualDisk {
        +Spec: PersistentVolumeClaimSpec
        +Status: DiskStatus
    }
    class PersistentVolumeClaimSpec {
        +StorageClass: string
    }
    class VirtualDiskSnapshot {
        +Namespace: string
    }
    class VolumeSnapshot {
        +Annotations: map[string]string
        +Spec: VolumeSnapshotSpec
    }
    class StorageClass {
        +Provisioner: string
    }
    class PersistentVolumeClaim {
        +Annotations: map[string]string
    }
    CreatePVCFromVDSnapshotStep --> VirtualDisk
    CreatePVCFromVDSnapshotStep --> VirtualDiskSnapshot
    CreatePVCFromVDSnapshotStep --> VolumeSnapshot
    CreatePVCFromVDSnapshotStep --> StorageClass
    CreatePVCFromVDSnapshotStep --> PersistentVolumeClaim

Loading

Class diagram for new annotation constants in annotations.go

classDiagram
    class Annotations {
        +AnnStorageProvisioner: string
        +AnnStorageProvisionerDeprecated: string
    }

Loading

File-Level Changes

Change	Details	Files
Support user-specified storageClassName when building PVCs	Prefer spec.PersistentVolumeClaim.StorageClass over snapshot annotation Fallback to existing annotation values when not specified	create_pvc_from_vdsnapshot_step.go
Validate storage class compatibility before PVC creation	Invoke validateStorageClassCompatibility in Take() with error handling and event recording Fetch target StorageClass and original PVC, compare provisioners, and return error on mismatch	create_pvc_from_vdsnapshot_step.go
Add annotation constants for storage provisioner	Introduce AnnStorageProvisioner and AnnStorageProvisionerDeprecated entries	annotations/annotations.go

---

Tips and commands

Interacting with Sourcery

• Trigger a new review: Comment @sourcery-ai review on the pull request.
• Continue discussions: Reply directly to Sourcery's review comments.
• Generate a GitHub issue from a review comment: Ask Sourcery to create an
  issue from a review comment by replying to it. You can also reply to a
  review comment with @sourcery-ai issue to create an issue from it.
• Generate a pull request title: Write @sourcery-ai anywhere in the pull
  request title to generate a title at any time. You can also comment
  @sourcery-ai title on the pull request to (re-)generate the title at any time.
• Generate a pull request summary: Write @sourcery-ai summary anywhere in
  the pull request body to generate a PR summary at any time exactly where you
  want it. You can also comment @sourcery-ai summary on the pull request to
  (re-)generate the summary at any time.
• Generate reviewer's guide: Comment @sourcery-ai guide on the pull
  request to (re-)generate the reviewer's guide at any time.
• Resolve all Sourcery comments: Comment @sourcery-ai resolve on the
  pull request to resolve all Sourcery comments. Useful if you've already
  addressed all the comments and don't want to see them anymore.
• Dismiss all Sourcery reviews: Comment @sourcery-ai dismiss on the pull
  request to dismiss all existing Sourcery reviews. Especially useful if you
  want to start fresh with a new review - don't forget to comment
  @sourcery-ai review to trigger a new review!

Customizing Your Experience

Access your dashboard to:

• Enable or disable review features such as the Sourcery-generated pull request
  summary, the reviewer's guide, and others.
• Change the review language.
• Add, remove or edit custom review instructions.
• Adjust other review settings.

Getting Help

• Contact our support team for questions or feedback.
• Visit our documentation for detailed guides and information.
• Keep in touch with the Sourcery team by following us on X/Twitter, LinkedIn or GitHub.

[sourcery-ai]

Hey there - I've reviewed your changes - here's some feedback:

• In validateStorageClassCompatibility, add a nil check for vs.Spec.Source.PersistentVolumeClaimName before dereferencing it to avoid potential panics when the snapshot source isn’t a PVC.
• Consider extracting the repeated annotation-reading logic (storageClassName, provisioner, volumeMode, etc.) into a shared helper to reduce duplication between buildPVC and compatibility validation.

Prompt for AI Agents

Please address the comments from this code review:

## Overall Comments
- In validateStorageClassCompatibility, add a nil check for vs.Spec.Source.PersistentVolumeClaimName before dereferencing it to avoid potential panics when the snapshot source isn’t a PVC.
- Consider extracting the repeated annotation-reading logic (storageClassName, provisioner, volumeMode, etc.) into a shared helper to reduce duplication between buildPVC and compatibility validation.

---

Sourcery is free for open source - if you like our reviews please consider sharing them ✨

• X
• Mastodon
• LinkedIn
• Facebook

_{Help me be more useful! Please click 👍 or 👎 on each comment and I'll use the feedback to improve your reviews.}

[deckhouse-BOaTswain]

Workflow has started.
Follow the progress here: Workflow Run

The target step completed with status: failure.