The snapshot-controller module: Custom Resources

The module lifecycle stage: General Availability

The Deckhouse Kubernetes Platform installs CRDs but does not remove them when a module is disabled. If you no longer need the created CRDs, delete them.

VolumeSnapshotClass

Scope: Cluster

v1 v1beta1

VolumeSnapshotClass defines parameters for volume snapshot creation used by the underlying storage system. To use, reference by name in a VolumeSnapshot object. Non-namespaced resource.

apiVersion

string
API version of this object representation. Servers convert recognized schemas to the latest internal value and may reject unrecognized values. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#resources
deletionPolicy

string
Controls the deletion behavior of VolumeSnapshotContent and its physical snapshot when the bound VolumeSnapshot is deleted. Supported values:
- Retain: VolumeSnapshotContent and its physical snapshot on the underlying storage system are preserved.
- Delete: VolumeSnapshotContent and its physical snapshot on the underlying storage system are removed.
Allowed values: Delete, Retain
driver

string
Name of the storage driver that handles this VolumeSnapshotClass.
kind

string
Kind of REST resource this object represents. Servers may infer this value from the endpoint the client submits requests to. Cannot be updated after creation. Value must be in CamelCase. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds
metadata

object
parameters

object
Key-value map of driver-specific parameters used when creating snapshots. Parameters are not interpreted by Kubernetes.

VolumeSnapshotClass defines parameters for volume snapshot creation used by the underlying storage system. To use, reference by name in a VolumeSnapshot object. Non-namespaced resource.

apiVersion

string
API version of this object representation. Servers convert recognized schemas to the latest internal value and may reject unrecognized values. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#resources
deletionPolicy

string
Controls the deletion behavior of VolumeSnapshotContent and its physical snapshot when the bound VolumeSnapshot is deleted. Supported values:
- Retain: VolumeSnapshotContent and its physical snapshot on the underlying storage system are preserved.
- Delete: VolumeSnapshotContent and its physical snapshot on the underlying storage system are removed.
Allowed values: Delete, Retain
driver

string
Name of the storage driver that handles this VolumeSnapshotClass.
kind

string
Kind of REST resource this object represents. Servers may infer this value from the endpoint the client submits requests to. Cannot be updated after creation. Value must be in CamelCase. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds
parameters

object
Key-value map of driver-specific parameters used when creating snapshots. Parameters are not interpreted by Kubernetes.

VolumeSnapshotContent

Scope: Cluster

v1 v1beta1

VolumeSnapshotContent represents the actual "on-disk" snapshot object in the underlying storage system.

apiVersion

string
API version of this object representation. Servers convert recognized schemas to the latest internal value and may reject unrecognized values. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#resources
kind

string
Kind of REST resource this object represents. Servers may infer this value from the endpoint the client submits requests to. Cannot be updated after creation. Value must be in CamelCase. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds
metadata

object
spec

object
Properties of VolumeSnapshotContent created by the underlying storage system.
- spec.deletionPolicy
  
  string
  Required value
  Controls deletion behavior of VolumeSnapshotContent and its physical snapshot when the bound VolumeSnapshot is deleted. Supported values:
  - Retain: VolumeSnapshotContent and its physical snapshot on the underlying storage system are preserved.
  - Delete: VolumeSnapshotContent and its physical snapshot on the underlying storage system are removed.
  For dynamically provisioned snapshots, automatically filled by the CSI snapshotter sidecar with the DeletionPolicy field defined in the corresponding VolumeSnapshotClass. For pre-existing snapshots, users must specify when creating the VolumeSnapshotContent object.
  Allowed values: Delete, Retain
- spec.driver
  
  string
  Required value
  
  CSI driver name used to create the physical snapshot on the underlying storage system. Must be the same as the name returned by the CSI GetPluginName() call for that driver.
- spec.source
  
  object
  Required value
  
  Specifies whether the snapshot is (or should be) dynamically provisioned or already exists and requires a Kubernetes object representation. Immutable after creation.
  - spec.source.snapshotHandle
    
    string
    CSI snapshot_id of a pre-existing snapshot on the underlying storage system for which a Kubernetes object representation was (or should be) created. Immutable.
  - spec.source.volumeHandle
    
    string
    CSI volume_id of the volume from which a snapshot should be dynamically taken. Immutable.
- spec.sourceVolumeMode
  
  string
  Mode of the volume whose snapshot is taken. Can be either Filesystem or Block. If not specified, the source volume's mode is unknown. Immutable.
- spec.volumeSnapshotClassName
  
  string
  VolumeSnapshotClass name from which this snapshot was (or will be) created. After provisioning, the VolumeSnapshotClass may be deleted or recreated with different values and should not be referenced post-snapshot creation.
- spec.volumeSnapshotRef
  
  object
  Required value
  
  VolumeSnapshot object (hereinafter referred to as the referent) to which this VolumeSnapshotContent is bound. VolumeSnapshot.Spec.VolumeSnapshotContentName field must reference this VolumeSnapshotContent name for the bidirectional binding to be valid. For a pre-existing VolumeSnapshotContent object, name and namespace of the VolumeSnapshot object must be provided for binding. Immutable after creation.
  - spec.volumeSnapshotRef.apiVersion
    
    string
    API version of the referent.
  - spec.volumeSnapshotRef.fieldPath
    
    string
    If referring to a piece of an object instead of an entire object, this string should contain a valid JSON/Go field access statement, such as desiredState.manifest.containers[2]. For example, if the object reference is to a container within a pod, this would take on a value like: spec.containers{name} (where name refers to the name of the container that triggered the event) or if no container name is specified spec.containers[2] (container with index 2 in this pod). This syntax is chosen only to have some well-defined way of referencing a part of an object.
  - spec.volumeSnapshotRef.kind
    
    string
    Kind of the referent. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds
  - spec.volumeSnapshotRef.name
    
    string
    Name of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names
  - spec.volumeSnapshotRef.namespace
    
    string
    Namespace of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/namespaces/
  - spec.volumeSnapshotRef.resourceVersion
    
    string
    Specific resourceVersion to which this reference is made, if any. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#concurrency-control-and-consistency
  - spec.volumeSnapshotRef.uid
    
    string
    UID of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#uids

VolumeSnapshotContent represents the actual "on-disk" snapshot object in the underlying storage system.

apiVersion

string
API version of this object representation. Servers convert recognized schemas to the latest internal value and may reject unrecognized values. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#resources
kind

string
Kind of REST resource this object represents. Servers may infer this value from the endpoint the client submits requests to. Cannot be updated after creation. Value must be in CamelCase. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds
spec

object
Properties of VolumeSnapshotContent created by the underlying storage system.
- spec.deletionPolicy
  
  string
  Required value
  Controls deletion behavior of VolumeSnapshotContent and its physical snapshot when the bound VolumeSnapshot is deleted. Supported values:
  - Retain: VolumeSnapshotContent and its physical snapshot on the underlying storage system are preserved.
  - Delete: VolumeSnapshotContent and its physical snapshot on the underlying storage system are removed. For dynamically provisioned snapshots, automatically filled by the CSI snapshotter sidecar with the DeletionPolicy field defined in the corresponding VolumeSnapshotClass. For pre-existing snapshots, users must specify when creating the VolumeSnapshotContent object.
  Allowed values: Delete, Retain
- spec.driver
  
  string
  Required value
  
  CSI driver name used to create the physical snapshot on the underlying storage system.
- spec.source
  
  object
  Required value
  
  Specifies whether the snapshot is (or should be) dynamically provisioned or already exists and requires a Kubernetes object representation. Immutable after creation.
  - spec.source.snapshotHandle
    
    string
    CSI snapshot_id of a pre-existing snapshot on the underlying storage system for which a Kubernetes object representation was (or should be) created. Immutable.
  - spec.source.volumeHandle
    
    string
    CSI volume_id of the volume from which a snapshot should be dynamically taken. Immutable.
- spec.volumeSnapshotClassName
  
  string
  VolumeSnapshotClass name from which this snapshot was (or will be) created. After provisioning, the VolumeSnapshotClass may be deleted or recreated with different values and should not be referenced post-snapshot creation.
- spec.volumeSnapshotRef
  
  object
  Required value
  
  VolumeSnapshot object (hereinafter referred to as the referent) to which this VolumeSnapshotContent is bound. VolumeSnapshot.Spec.VolumeSnapshotContentName field must reference this VolumeSnapshotContent name for the bidirectional binding to be valid. For a pre-existing VolumeSnapshotContent object, name and namespace of the VolumeSnapshot object must be provided for binding. Immutable after creation.
  - spec.volumeSnapshotRef.apiVersion
    
    string
    API version of the referent.
  - spec.volumeSnapshotRef.fieldPath
    
    string
    If referring to a piece of an object instead of an entire object, this string should contain a valid JSON/Go field access statement, such as desiredState.manifest.containers[2]. For example, if the object reference is to a container within a pod, this would take on a value like: spec.containers{name} (where name refers to the name of the container that triggered the event) or if no container name is specified spec.containers[2] (container with index 2 in this pod). This syntax is chosen only to have some well-defined way of referencing a part of an object.
  - spec.volumeSnapshotRef.kind
    
    string
    Kind of the referent. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds
  - spec.volumeSnapshotRef.name
    
    string
    Name of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names
  - spec.volumeSnapshotRef.namespace
    
    string
    Namespace of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/namespaces/
  - spec.volumeSnapshotRef.resourceVersion
    
    string
    Specific resourceVersion to which this reference is made, if any. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#concurrency-control-and-consistency
  - spec.volumeSnapshotRef.uid
    
    string
    UID of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#uids

VolumeSnapshot

Scope: Namespaced

v1 v1beta1

VolumeSnapshot is a user's request for either creating a point-in-time snapshot of a persistent volume, or binding to a pre-existing snapshot.

apiVersion

string
API version of this object representation. Servers convert recognized schemas to the latest internal value and may reject unrecognized values. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#resources
kind

string
Kind of REST resource this object represents. Servers may infer this value from the endpoint the client submits requests to. Cannot be updated after creation. Value must be in CamelCase. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds
metadata

object
spec

object
Desired characteristics of a snapshot requested by a user. More info: https://kubernetes.io/docs/concepts/storage/volume-snapshots#volumesnapshots
- spec.source
  
  object
  Required value
  
  Specifies where a snapshot will be created from. Immutable after creation.
  - spec.source.persistentVolumeClaimName
    
    string
    Name of the PersistentVolumeClaim object representing the volume from which a snapshot should be created. PVC must be in the same namespace as the VolumeSnapshot object. Specified if the snapshot does not exist and needs to be created. Immutable.
  - spec.source.volumeSnapshotContentName
    
    string
    Name of a pre-existing VolumeSnapshotContent object representing an existing volume snapshot. Specified if the snapshot already exists and only needs a representation in Kubernetes. Immutable.
- spec.volumeSnapshotClassName
  
  string
  Name of the VolumeSnapshotClass requested by the VolumeSnapshot. May be empty to use the default SnapshotClass. A cluster may have multiple default Volume SnapshotClasses: one per CSI Driver. If a SnapshotClass is not specified, VolumeSnapshotSource is checked to determine the associated CSI Driver, and the default VolumeSnapshotClass for that CSI Driver is used. If multiple VolumeSnapshotClasses exist for a CSI Driver and more than one is marked as default, CreateSnapshot fails and generates an event. Empty string is not allowed.

VolumeSnapshot is a user's request for either creating a point-in-time snapshot of a persistent volume, or binding to a pre-existing snapshot.

apiVersion

string
API version of this object representation. Servers convert recognized schemas to the latest internal value and may reject unrecognized values. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#resources
kind

string
Kind of REST resource this object represents. Servers may infer this value from the endpoint the client submits requests to. Cannot be updated after creation. Value must be in CamelCase. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds
spec

object
Desired characteristics of a snapshot requested by a user. More info: https://kubernetes.io/docs/concepts/storage/volume-snapshots#volumesnapshots
- spec.source
  
  object
  Required value
  
  Specifies where a snapshot will be created from. Immutable after creation.
  - spec.source.persistentVolumeClaimName
    
    string
    Name of the PersistentVolumeClaim object representing the volume from which a snapshot should be created. PVC must be in the same namespace as the VolumeSnapshot object. Specified if the snapshot does not exist and needs to be created. Immutable.
  - spec.source.volumeSnapshotContentName
    
    string
    Name of a pre-existing VolumeSnapshotContent object representing an existing volume snapshot. Specified if the snapshot already exists and only needs a representation in Kubernetes. Immutable.
- spec.volumeSnapshotClassName
  
  string
  Name of the VolumeSnapshotClass requested by the VolumeSnapshot. May be empty to use the default SnapshotClass. A cluster may have multiple default Volume SnapshotClasses: one per CSI Driver. If a SnapshotClass is not specified, VolumeSnapshotSource is checked to determine the associated CSI Driver, and the default VolumeSnapshotClass for that CSI Driver is used. If multiple VolumeSnapshotClasses exist for a CSI Driver and more than one is marked as default, CreateSnapshot fails and generates an event. Empty string is not allowed.

The snapshot-controller module: Custom Resources

VolumeSnapshotClass

VolumeSnapshotContent

VolumeSnapshot

An error has occurred

Tell us what you didn’t like.

The snapshot-controller module: Custom Resources

VolumeSnapshotClass

VolumeSnapshotContent

VolumeSnapshot

An error has occurred

Tell us what you didn’t like.

Request trial access

Thank you

Error

Request callback

Thank you

Something went wrong

Book your sessions

Thank you

Error

Request demo

Thank you

Error

Get the PCI SSC Compliance Report

Thank you

Error