Configuring a VolumeSnapshotClass

VolumeSnapshotClass provides a way to describe the “classes” of storage when provisioning a VolumeSnapshot. Each VolumeSnapshotClass contains the driver, deletionPolicy, and parameters fields, which are used when a VolumeSnapshot belonging to the class needs to be dynamically provisioned.

The name of a VolumeSnapshotClass object is significant, and is how users can request a particular class. Administrators set the name and other parameters of a class when first creating VolumeSnapshotClass objects, and the objects cannot be updated once they are created.

The following is an example of a VolumeSnapshotClass used by Huawei CSI:

  • If api-versions in your environment supports v1, use the following example:

    apiVersion: snapshot.storage.k8s.io/v1
kind: VolumeSnapshotClass
metadata:
  name: mysnapclass
driver: csi.huawei.com
deletionPolicy: Delete

  • If api-versions in your environment supports v1beta1, use the following example:

    apiVersion: snapshot.storage.k8s.io/v1beta1
kind: VolumeSnapshotClass
metadata:
  name: mysnapclass
driver: csi.huawei.com
deletionPolicy: Delete

  • If api-versions in your environment supports both v1 and v1beta1, v1 is recommended.

You can modify the parameters according to Table 1. Currently, Huawei CSI does not support user-defined parameters (parameters) in a VolumeSnapshotClass. Therefore, you are advised to create a VolumeSnapshotClass for all snapshots.

Table 1 VolumeSnapshotClass parameters

Parameter

Description

Remarks

metadata.name

User-defined name of a VolumeSnapshotClass object.

Take Kubernetes v1.22.1 as an example. The value can contain digits, lowercase letters, hyphens (-), and periods (.), and must start and end with a letter or digit.

driver

driver identifier. This parameter is mandatory.

Set this parameter to the driver name set during Huawei CSI installation. The default driver name is csi.huawei.com.

deletionPolicy

Snapshot deletion policy. This parameter is mandatory. The value can be:

  • Delete
  • Retain
  • If the deletion policy is Delete, the snapshot on the storage device will be deleted together with the VolumeSnapshotContent object.
  • If the deletion policy is Retain, the snapshot and VolumeSnapshotContent object on the storage device will be retained.

Prerequisites

Huawei CSI supports snapshots, and the volume snapshot component CRD on which its running depends has been installed. For details about the CRD, see Checking Volume Snapshot-Dependent Components. For details about the Kubernetes versions that support VolumeSnapshot creation, see Table 1.

Procedure

  1. Run the following command to create a VolumeSnapshotClass using the created VolumeSnapshotClass configuration file.

    kubectl create -f mysnapclass.yaml

  2. Run the following command to view the information about the created VolumeSnapshotClass.

    kubectl get volumesnapshotclass

    The following is an example of the command output.

    NAME          DRIVER           DELETIONPOLICY   AGE
mysnapclass   csi.huawei.com   Delete           25s