The module lifecycle stage: General Availability
The module has requirements for installation

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.
  • status
    object
    Current information of a snapshot.
    • status.creationTime
      integer
      Timestamp when the point-in-time snapshot is taken by the underlying storage system. For dynamic snapshot creation, filled by the CSI snapshotter sidecar with the creation_time value returned from CSI CreateSnapshot gRPC call. For a pre-existing snapshot, filled with the creation_time value returned from the CSI ListSnapshots gRPC call if the driver supports it. If not specified, the creation time is unknown. Format is a Unix nanoseconds time encoded as an int64. On Unix, the command date +%s%N returns the current time in nanoseconds since 1970-01-01 00:00:00 UTC.
    • status.error
      object
      Last observed error during snapshot creation, if any. Upon success after retry, the field is cleared.
      • status.error.message
        string
        Details of the encountered error during snapshot creation if specified. Note: message may be logged, and should not contain sensitive information.
      • status.error.time
        string
        Timestamp when the error was encountered.
    • status.readyToUse
      boolean
      Indicates whether a snapshot is ready to be used to restore a volume. For dynamic snapshot creation, filled by the CSI snapshotter sidecar with the ready_to_use value returned from CSI CreateSnapshot gRPC call. For a pre-existing snapshot, filled with the ready_to_use value returned from the CSI ListSnapshots gRPC call if the driver supports it, otherwise set to True. If not specified, the readiness of a snapshot is unknown.
    • status.restoreSize
      integer
      Complete size of the snapshot in bytes. For dynamic snapshot creation, filled by the CSI snapshotter sidecar with the size_bytes value returned from CSI CreateSnapshot gRPC call. For a pre-existing snapshot, filled with the size_bytes value returned from the CSI ListSnapshots gRPC call if the driver supports it. When restoring a volume from this snapshot, the volume size must not be smaller than the restoreSize if specified, otherwise the restoration will fail. If not specified, the size is unknown.

      Allowed values: 0 <= X

    • status.snapshotHandle
      string
      CSI snapshot_id of a snapshot on the underlying storage system. If not specified, dynamic snapshot creation has either failed or is still in progress.
    • status.volumeGroupSnapshotHandle
      string
      CSI group_snapshot_id of a group snapshot on the underlying storage system.
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.
  • status
    object
    Current information of a snapshot.
    • status.creationTime
      integer
      Timestamp when the point-in-time snapshot is taken by the underlying storage system. For dynamic snapshot creation, filled by the CSI snapshotter sidecar with the creation_time value returned from CSI CreateSnapshot gRPC call. For a pre-existing snapshot, filled with the creation_time value returned from the CSI ListSnapshots gRPC call if the driver supports it. If not specified, the creation time is unknown. Format is a Unix nanoseconds time encoded as an int64. On Unix, the command date +%s%N returns the current time in nanoseconds since 1970-01-01 00:00:00 UTC.
    • status.error
      object
      Last observed error during snapshot creation, if any. Upon success after retry, the field is cleared.
      • status.error.message
        string
        Details of the encountered error during snapshot creation if specified. Note: message may be logged, and should not contain sensitive information.
      • status.error.time
        string
        Timestamp when the error was encountered.
    • status.readyToUse
      boolean
      Indicates whether a snapshot is ready to be used to restore a volume. For dynamic snapshot creation, filled by the CSI snapshotter sidecar with the ready_to_use value returned from CSI CreateSnapshot gRPC call. For a pre-existing snapshot, filled with the ready_to_use value returned from the CSI ListSnapshots gRPC call if the driver supports it, otherwise set to True. If not specified, the readiness of a snapshot is unknown.
    • status.restoreSize
      integer
      Complete size of the snapshot in bytes. For dynamic snapshot creation, filled by the CSI snapshotter sidecar with the size_bytes value returned from CSI CreateSnapshot gRPC call. For a pre-existing snapshot, filled with the size_bytes value returned from the CSI ListSnapshots gRPC call if the driver supports it. When restoring a volume from this snapshot, the volume size must not be smaller than the restoreSize if specified, otherwise the restoration will fail. If not specified, the size is unknown.

      Allowed values: 0 <= X

    • status.snapshotHandle
      string
      CSI snapshot_id of a snapshot on the underlying storage system. If not specified, dynamic snapshot creation has either failed or is still in progress.

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.
  • status
    object
    Current information of a snapshot. Before using this object, verify that binding between VolumeSnapshot and VolumeSnapshotContent objects is successful by ensuring both objects point at each other.
    • status.boundVolumeSnapshotContentName
      string
      Name of the VolumeSnapshotContent object to which this VolumeSnapshot object is bound. If not specified, the VolumeSnapshot object has not been successfully bound to a VolumeSnapshotContent object yet. Note: To prevent security issues, verify that binding between VolumeSnapshot and VolumeSnapshotContent objects is successful by ensuring both objects point at each other before using this object.
    • status.creationTime
      string
      Timestamp when the point-in-time snapshot is taken by the underlying storage system. For dynamic snapshot creation, filled by the snapshot controller with the creation_time value returned from CSI CreateSnapshot gRPC call. For a pre-existing snapshot, filled with the creation_time value returned from the CSI ListSnapshots gRPC call if the driver supports it. If not specified, the creation time of the snapshot is unknown.
    • status.error
      object
      Last observed error during snapshot creation, if any. Useful to upper level controllers (i.e., application controller) to decide whether to continue waiting for the snapshot to be created based on the error type. The snapshot controller keeps retrying when an error occurs during snapshot creation. Upon success, the field is cleared.
      • status.error.message
        string
        Details of the encountered error during snapshot creation if specified. Note: message may be logged, and it should not contain sensitive information.
      • status.error.time
        string
        Timestamp when the error was encountered.
    • status.readyToUse
      boolean
      Indicates if the snapshot is ready to be used to restore a volume. For dynamic snapshot creation, filled by the snapshot controller with the ready_to_use value returned from CSI CreateSnapshot gRPC call. For a pre-existing snapshot, filled with the ready_to_use value returned from the CSI ListSnapshots gRPC call if the driver supports it, otherwise set to True. If not specified, the readiness of a snapshot is unknown.
    • status.restoreSize
      string
      Minimum size of volume required to create a volume from this snapshot. For dynamic snapshot creation, filled by the snapshot controller with the size_bytes value returned from CSI CreateSnapshot gRPC call. For a pre-existing snapshot, filled with the size_bytes value returned from the CSI ListSnapshots gRPC call if the driver supports it. When restoring a volume from this snapshot, the volume size must not be smaller than the restoreSize if specified, otherwise the restoration will fail. If not specified, the size is unknown.

      Pattern: ^(\+|-)?(([0-9]+(\.[0-9]*)?)|(\.[0-9]+))(([KMGTPE]i)|[numkMGTPE]|([eE](\+|-)?(([0-9]+(\.[0-9]*)?)|(\.[0-9]+))))?$

    • status.volumeGroupSnapshotName
      string
      Name of the VolumeGroupSnapshot of which this VolumeSnapshot is a part.
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.
  • status
    object
    Current information of a snapshot. Before using this object, verify that binding between VolumeSnapshot and VolumeSnapshotContent objects is successful by ensuring both objects point at each other.
    • status.boundVolumeSnapshotContentName
      string
      Name of the VolumeSnapshotContent object to which this VolumeSnapshot object is bound. If not specified, the VolumeSnapshot object has not been successfully bound to a VolumeSnapshotContent object yet. Note: To prevent security issues, verify that binding between VolumeSnapshot and VolumeSnapshotContent objects is successful by ensuring both objects point at each other before using this object.
    • status.creationTime
      string
      Timestamp when the point-in-time snapshot is taken by the underlying storage system. For dynamic snapshot creation, filled by the snapshot controller with the creation_time value returned from CSI CreateSnapshot gRPC call. For a pre-existing snapshot, filled with the creation_time value returned from the CSI ListSnapshots gRPC call if the driver supports it. If not specified, the creation time of the snapshot is unknown.
    • status.error
      object
      Last observed error during snapshot creation, if any. Useful to upper level controllers (i.e., application controller) to decide whether to continue waiting for the snapshot to be created based on the error type. The snapshot controller keeps retrying when an error occurs during snapshot creation. Upon success, the field is cleared.
      • status.error.message
        string
        Details of the encountered error during snapshot creation if specified. Note: message may be logged, and it should not contain sensitive information.
      • status.error.time
        string
        Timestamp when the error was encountered.
    • status.readyToUse
      boolean
      Indicates if the snapshot is ready to be used to restore a volume. For dynamic snapshot creation, filled by the snapshot controller with the ready_to_use value returned from CSI CreateSnapshot gRPC call. For a pre-existing snapshot, filled with the ready_to_use value returned from the CSI ListSnapshots gRPC call if the driver supports it, otherwise set to True. If not specified, the readiness of a snapshot is unknown.
    • status.restoreSize
      string
      Minimum size of volume required to create a volume from this snapshot. For dynamic snapshot creation, filled by the snapshot controller with the size_bytes value returned from CSI CreateSnapshot gRPC call. For a pre-existing snapshot, filled with the size_bytes value returned from the CSI ListSnapshots gRPC call if the driver supports it. When restoring a volume from this snapshot, the volume size must not be smaller than the restoreSize if specified, otherwise the restoration will fail. If not specified, the size is unknown.

      Pattern: ^(\+|-)?(([0-9]+(\.[0-9]*)?)|(\.[0-9]+))(([KMGTPE]i)|[numkMGTPE]|([eE](\+|-)?(([0-9]+(\.[0-9]*)?)|(\.[0-9]+))))?$

    • status.volumeGroupSnapshotName
      string
      Name of the VolumeGroupSnapshot of which this VolumeSnapshot is a part.