Skip to main content
Version: main 🚧

Volume snapshot classes

Supported Configurations
Running the control plane as a container with:

By default, this is disabled.

Sync VolumeSnapshotClass resources from the control plane cluster to the tenant cluster. A VolumeSnapshotClass tells a CSI driver how to take a snapshot, similar to how a StorageClass tells it how to provision a volume. A VolumeSnapshot created in the tenant cluster normally references a VolumeSnapshotClass by name. Sync the classes that exist in the control plane cluster before enabling VolumeSnapshot syncing.

Sync VolumeSnapshotClasses from the control plane cluster to the tenant cluster​

sync:
  fromHost:
    volumeSnapshotClasses:
      enabled: true

Patches​

Use sync.fromHost.volumeSnapshotClasses.patches to transform VolumeSnapshotClass fields while syncing to the tenant cluster. See Patching synced resources for syntax, directionality, and examples.

Config reference​

volumeSnapshotClasses object ​

VolumeSnapshotClasses defines if volume snapshot classes created within the host cluster should get synced to the virtual cluster.

enabled boolean false ​

Enabled defines if this option should be enabled.

patches object[] ​

Patches patch the resource according to the provided specification.

path required string ​

Path is the path within the patch to target. If the path is not found within the patch, the patch is not applied.

expression string ​

Expression transforms the value according to the given JavaScript expression.

reverseExpression string ​

ReverseExpression transforms the value according to the given JavaScript expression.

reference object ​

Reference treats the path value as a reference to another object and will rewrite it based on the chosen mode automatically. In single-namespace mode this will translate the name to "vxxxxxxxxx" to avoid conflicts with other names, in multi-namespace mode this will not translate the name.

apiVersion required string ​

APIVersion is the apiVersion of the referenced object.

apiVersionPath string ​

APIVersionPath is optional relative path to use to determine the kind. If APIVersionPath is not found, will fallback to apiVersion.

kind required string ​

Kind is the kind of the referenced object.

kindPath string ​

KindPath is the optional relative path to use to determine the kind. If KindPath is not found, will fallback to kind.

namePath string ​

NamePath is the optional relative path to the reference name within the object.

namespacePath string ​

NamespacePath is the optional relative path to the reference namespace within the object. If omitted or not found, namespacePath equals to the metadata.namespace path of the object.

labels object ​

Labels treats the path value as a labels selector.