This is the multi-page printable view of this section. Click here to print.

Return to the regular view of this page.

StorageClass Management

1: Configuring a StorageClass

1.1: Flash Storage (OceanStor Dorado/OceanStor V5/OceanStor V6 and Later)

1.1.1: File System
1.1.2: Dtree
1.1.3: Block Service

1.2: Flash Storage (OceanStor A600/A800)

1.2.1: File System

1.3: Mass Storage (FusionStorage Block/OceanStor Pacific Series)

1.3.1: File System
1.3.2: Dtree
1.3.3: Block Services

1.4: Mass Storage (OceanDisk Series)

1.4.1: File System
1.4.2: Block Services

2: Managing a StorageClass

2.1: Querying a StorageClass
2.2: Modifying a StorageClass
2.3: Deleting a StorageClass

A StorageClass provides administrators with methods to describe a storage “class”. Different types may map to a different group of capability definitions. Kubernetes cluster users can dynamically provision volumes based on a StorageClass.

1 - Configuring a StorageClass

Cluster administrators can define multiple StorageClass objects as required. When configuring a PV, the cluster administrators need to specify a StorageClass that meets service requirements. When applying for resources from Huawei storage devices, Huawei CSI creates storage resources that meet service requirements based on the preset StorageClass.

1.1 - Flash Storage (OceanStor Dorado/OceanStor V5/OceanStor V6 and Later)

1.1.1 - File System

Creating a StorageClass

Prepare a StorageClass configuration file, for example, msc .yaml. For details about the StorageClass configuration, see the following example.
Run the following command to create a StorageClass using the configuration file.
```
kubectl apply -f mysc.yaml
```

Run the following command to view the information about the created StorageClass.

kubectl get sc mysc

The following is an example of the command output.

NAME   PROVISIONER      RECLAIMPOLICY   VOLUMEBINDINGMODE   ALLOWVOLUMEEXPANSION   AGE
mysc   csi.huawei.com   Delete          Immediate           true                   8s

NFS Protocol Configuration Example

When a container uses the NFS protocol to connect to file system resources, refer to the following StorageClass configuration example. In this example, NFS version 4.1 is specified for mounting.

kind: StorageClass
apiVersion: storage.k8s.io/v1
metadata:
  name: mysc
provisioner: csi.huawei.com
parameters:
  backend: nfs-nas-181
  pool: StoragePool001
  volumeType: fs
  allocType: thin
  authClient: "*"
mountOptions:
  - nfsvers=4.1 # Specify the version 4.1 for NFS mounting.

NFS+ Protocol Configuration Example

When a container uses the NFS+ protocol to connect to file system resources, refer to the following StorageClass configuration example.

kind: StorageClass
apiVersion: storage.k8s.io/v1
metadata:
  name: mysc
provisioner: csi.huawei.com
parameters:
  backend: nfs-nas-181
  pool: StoragePool001
  volumeType: fs
  allocType: thin
  authClient: "*"

HyperMetro File System Configuration Example

When a container uses an NFS HyperMetro file system as a storage resource, refer to the following configuration example. In this example, the used backend supports HyperMetro, and hyperMetro is set to true.

kind: StorageClass
apiVersion: storage.k8s.io/v1
metadata:
  name: mysc
provisioner: csi.huawei.com
parameters:
  backend: nfs-hypermetro-dorado-181
  pool: pool001
  volumeType: fs
  hyperMetro: "true" # Provision HyperMetro volumes.
  allocType: thin
  authClient: "*"

Before provisioning a NAS HyperMetro volume, you need to configure the HyperMetro relationship between two storage devices, including the remote device and HyperMetro domain. The HyperMetro domain of the file system can only work in HyperMetro AA mode. For details about the configuration operation, see the product documentation of the corresponding storage model.
If a storage device is faulty, the logical management port may fail over. In this case, you need to manually clear the corresponding storage resources after deleting the NAS HyperMetro volume.

StorageClass Parameters Supported by File Systems

Table 1 StorageClass configuration parameters

Parameter	Description	Mandatory	Default Value	Whether the Volume Management Takes Effect	Remarks
metadata.name	User-defined name of a StorageClass object.	Yes	-	Yes	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.
provisioner	Name of the provisioner.	Yes	csi.huawei.com	Yes	Set this parameter to the driver name set during Huawei CSI installation. The value is the same as that of driverName in the values.yaml file.
reclaimPolicy	Reclamation policy. The following types are supported: Delete: Resources are automatically reclaimed. Retain: Resources are manually reclaimed.	No	Delete	Yes	Delete: When a PV/PVC is deleted, resources on the storage device are also deleted. Retain: When a PV/PVC is deleted, resources on the storage device are not deleted.
allowVolumeExpansion	Whether to allow volume expansion. If this parameter is set to true, the capacity of the PV that uses the StorageClass can be expanded.	No	false	Yes	This function can only be used to expand PV capacity but cannot be used to reduce PV capacity.
mountOptions	List of mount parameters, which can be used to specify the parameters of the -o option when the mount command is executed on a host.	No	-	Yes	For details about common parameters in mountOptions, see Table 2. You can also specify other mount parameters.
parameters.backend	Name of the backend where the resource to be created is located. This field must be set if parameters.pool is set.	Conditionally mandatory	-	No	If this parameter is not set, Huawei CSI will randomly select a backend that meets the capacity requirements to create resources. You are advised to specify a backend to ensure that the created resource is located on the expected backend.
parameters.pool	Name of the storage resource pool where the resource to be created is located.	No	-	No	If this parameter is not set, Huawei CSI will randomly select a storage pool that meets the capacity requirements from the selected backend to create resources. You are advised to specify a storage pool to ensure that the created resource is located in the expected storage pool.
parameters.volumeName	Name of the storage resource created by dynamic volume provisioning. You can configure a placeholder to customize the storage resource name. The following placeholders are supported: PVC namespace: {{ .PVCNamespace }} PVC name: {{ .PVCName }}	No	-	No	The value can contain letters, digits, hyphens (-), underscores (_), and periods (.). It cannot be left empty. The length of the expanded placeholder ranges from 1 to 255 characters. Both the PVC namespace and PVC name must be configured. To avoid duplicate resource names, the PVC UID is added to the end of the name as a unique identifier by default. Configuration example: PVC namespace: namespace. PVC name: pvc-1. PVC UID: c2fd3f46-bf17-4a7d-b88e-2e3232bae434. volumeName is set to prefix-{{ .PVCNamespace }}_{{ .PVCName }}. The ultimate storage resource name is prefix-namespace_pvc-1-c2fd3f46bf174a7db88e2e3232bae434.
parameters.volumeType	Type of the volume to be created. The following types are supported: lun: A LUN is provisioned on the storage side. fs: A file system is provisioned on the storage side. dtree: A volume of the Dtree type is provisioned on the storage side.	Yes	-	Yes	The value is fixed to fs.
parameters.allocType	Allocation type of the volume to be created. The following types are supported: thin: Not all required space is allocated during creation. Instead, the space is dynamically allocated based on the usage. thick: All required space is allocated during creation.	No	thin	No	If this parameter is set to thin, the required space is not allocated immediately when a volume is created. Instead, the space is dynamically allocated based on the usage. OceanStor Dorado does not support thick.
parameters.authClient	IP address of the NFS client that can access the volume. You can enter the client host name (a full domain name is recommended), client IP address, or client IP address segment.	Yes	-	No	The asterisk () can be used to indicate any client. If you are not sure about the IP address of the access client, you are advised to use the asterisk () to prevent the client access from being rejected by the storage system. If the client host name is used, you are advised to use the full domain name. The IP addresses can be IPv4 addresses, IPv6 addresses, or a combination of IPv4 and IPv6 addresses. You can enter multiple host names, IP addresses, or IP address segments and separate them with semicolons (;). Example: 192.168.0.10;192.168.0.0/24;myserver1.test
parameters.cloneSpeed	Cloning speed. The value ranges from 1 to 4.	No	3	No	4 indicates the highest speed. This parameter takes effect when a persistent volume is cloned or a persistent volume is created from a snapshot.
parameters.applicationType	Application type name when a file system is created.	No	-	Yes	Log in to DeviceManager and choose Services > File Service > File Systems > Create to obtain the application type name.
parameters.qos	QoS settings of the file system on the storage side for the PV. The value of the parameter is JSON character strings in dictionary format. A character string is enclosed by single quotation marks and the dictionary key by double quotation marks. Example: '{"maxMBPS": 999, "maxIOPS": 999}'	No	-	No	For details about the supported QoS configurations, see Table 3.
parameters.hyperMetro	Whether a HyperMetro volume is to be created. This parameter needs to be configured when the backend is of the HyperMetro type. "true": The created volume is a HyperMetro volume. If the storage backend is a HyperMetro backend, the value must be true. "false": The created volume is a common volume.	Conditionally mandatory	false	No	When the used backend is a HyperMetro backend and a HyperMetro volume needs to be provisioned, set this parameter to true. If this parameter is set to false, services may be interrupted if the logical management port connected to the backend fails over.
parameters.metroPairSyncSpeed	Data synchronization speed of a HyperMetro pair. The value ranges from 1 to 4. The value can be: 1: low 2: medium 3: high 4: highest	No	-	No	The configuration takes effect when a HyperMetro volume is created. Note: If this parameter is not configured, the storage speed of the HyperMetro pair is determined by the storage device. The highest synchronization speed may increase the host latency.
parameters.fsPermission	Permission on the directory mounted to a container.	No	-	No	For details about the configuration format, refer to the Linux permission settings, for example, 777 and 755.
parameters.rootSquash	Controls the root permission of the client. The value can be: root_squash: The client cannot access the storage system as user root. If a client accesses the storage system as user root, the client will be mapped as an anonymous user. no_root_squash: A client can access the storage system as user root and has the permission of user root.	No	-	No
parameters.allSquash	Whether to retain the user ID (UID) and group ID (GID) of a shared directory. The value can be: all_squash: The UID and GID of the shared directory are mapped to anonymous users. no_all_squash: The UID and GID of the shared directory are retained.	No	-	No
parameters.accesskrb5	Configures the krb5 security protocol. read_only: read-only read_write: read and write none: no permission	No	-	No	During mounting, you can specify the sec parameter in mountOptions.
parameters.accesskrb5i	Configures the krb5i security protocol. read_only: read-only read_write: read and write none: no permission	No	-	No	During mounting, you can specify the sec parameter in mountOptions.
parameters.accesskrb5p	Configures the krb5p security protocol. read_only: read-only read_write: read and write none: no permission	No	-	No	During mounting, you can specify the sec parameter in mountOptions.
parameters.snapshotDirectoryVisibility	Whether the snapshot directory is visible. The value can be: visible: The snapshot directory is visible. invisible: The snapshot directory is invisible.	No	-	No	Only NAS storage is supported.
parameters.reservedSnapshotSpaceRatio	Configures reserved snapshot space. Value type: character string Value range: 0 to 50	No	-	No	OceanStor Dorado 6.1.5+ and OceanStor 6.1.5+ NAS storage devices are supported.
parameters.disableVerifyCapacity	Whether to disable volume capacity verification. After this function is disabled, the system will not verify whether the volume capacity is an integer multiple of the sector size. The value can be: "true": disables volume capacity verification. "false": enables volume capacity verification. NOTICE: When Red Hat OpenShift Virtualization is used to connect to CSI, this parameter must be set to true.	No	"true"	Yes	For OceanStor Dorado and OceanStor storage, the sector size is 512 bytes.
parameters.description	Description of the file system to be created. Value type: character string The value contains 0 to 255 characters.	No	-	No
parameters.advancedOptions	Advanced volume creation parameters. The value of the parameter is JSON character strings in dictionary format. A character string is enclosed by single quotation marks and the dictionary key by double quotation marks. Example: '{"CAPACITYTHRESHOLD": 90}'	No	-	No	For details about the supported advanced parameters, see Table 4.

Table 2 Common parameters in mountOptions

Parameter	Description	Mandatory	Default Value	Remarks
mountOptions.nfsvers	NFS mount option on the host. The following mount option is supported: nfsvers: protocol version for NFS mounting. The value can be 3, 4, 4.0, 4.1, or 4.2.	No	-	This parameter is optional after the -o parameter when the mount command is executed on the host. The value is in list format. If the NFS version is specified for mounting, NFS 3, 4.0, 4.1, and 4.2 protocols are supported (the protocol must be supported and enabled on storage devices). If nfsvers is set to 4, the latest protocol version NFS 4 may be used for mounting due to different OS configurations, for example, 4.2. If the 4.0 protocol is required, you are advised to set nfsvers to 4.0.
mountOptions.sec	Kerberos 5 protocol for mounting NFS file systems.	No	-	If Kerberos 5 is used, set this parameter to krb5. If Kerberos 5i is used, set this parameter to krb5i. If Kerberos 5p is used, set this parameter to krb5p. Kerberos supports only NFSv4.0 and later versions. OceanStor Dorado and OceanStor 6.1.3 and later versions support Kerberos.
mountOptions.proto	Transmission protocol used for NFS mounting. The value can be rdma.	No	-	The parameter is supported for NAS storage of OceanStor Dorado and OceanStor 6.1.7 and later.
mountOptions.port	Protocol port used for NFS mounting.	Conditionally mandatory	-	If the transmission protocol is rdma, set this parameter to 20049.

Table 3 Supported QoS configurations

Storage Type	Parameter	Description	Remarks
OceanStor V5	IOTYPE	Read/write type.	This parameter is optional. If it is not specified, the default value of the storage backend is used. For details, see related storage documents. The value can be: 0: read I/O 1: write I/O 2: read and write I/Os
	MAXBANDWIDTH	Maximum bandwidth. This is a restriction policy parameter.	The value is an integer greater than 0, expressed in MB/s.
	MINBANDWIDTH	Minimum bandwidth. This is a protection policy parameter.	The value is an integer greater than 0, expressed in MB/s.
	MAXIOPS	Maximum IOPS. This is a restriction policy parameter.	The value is an integer greater than 0.
	MINIOPS	Minimum IOPS. This is a protection policy parameter.	The value is an integer greater than 0.
	LATENCY	Maximum latency. This is a protection policy parameter.	The value is an integer greater than 0, expressed in ms.
OceanStor Dorado/OceanStor	IOTYPE	Read/write type.	The value can be: 2: read and write I/Os
	MAXBANDWIDTH	Maximum bandwidth. This is a restriction policy parameter.	The value is an integer ranging from 1 to 999999999, expressed in MB/s.
	MINBANDWIDTH	Minimum bandwidth. This is a protection policy parameter.	The value is an integer ranging from 1 to 999999999, expressed in MB/s.
	MAXIOPS	Maximum IOPS. This is a restriction policy parameter.	The value is an integer ranging from 100 to 999999999.
	MINIOPS	Minimum IOPS. This is a protection policy parameter.	The value is an integer ranging from 100 to 999999999.
	LATENCY	Maximum latency. This is a protection policy parameter.	The value can be 0.5 or 1.5, expressed in ms.

Table 4 Supported advanced volume creation parameters

Parameter	Description	Remarks
CAPACITYTHRESHOLD	Total capacity alarm threshold.	Parameter type: uint64. For details about the default value and value range, see the corresponding storage product manual.

Parameter

Description

Remarks

CAPACITYTHRESHOLD

Total capacity alarm threshold.

Parameter type: uint64.

For details about the default value and value range, see the corresponding storage product manual.

1.1.2 - Dtree

Creating a StorageClass

Prepare a StorageClass configuration file, for example, msc .yaml. For details about the StorageClass configuration, see the following example.
Run the following command to create a StorageClass using the configuration file.
```
kubectl apply -f mysc.yaml
```

Run the following command to view the information about the created StorageClass.

kubectl get sc mysc

The following is an example of the command output.

NAME   PROVISIONER      RECLAIMPOLICY   VOLUMEBINDINGMODE   ALLOWVOLUMEEXPANSION   AGE
mysc   csi.huawei.com   Delete          Immediate           true                   8s

Example of StorageClass Configuration Supported by the NFS Protocol

When a container uses the NFS protocol to connect to dtree resources, refer to the following StorageClass configuration example. In this example, NFS version 4.1 is specified for mounting.

kind: StorageClass
apiVersion: storage.k8s.io/v1
metadata:
  name: mysc
provisioner: csi.huawei.com
parameters:
  backend: nfs-dtree-181
  parentname: parent-filesystem-name
  volumeType: dtree
  allocType: thin
  authClient: "*"
mountOptions:
  - nfsvers=4.1 # Specify the version 4.1 for NFS mounting.

Example of StorageClass Configuration Supported by the NFS+ Protocol

When a container uses the NFS+ protocol to connect to dtree resources, refer to the following StorageClass configuration example.

kind: StorageClass
apiVersion: storage.k8s.io/v1
metadata:
  name: mysc
provisioner: csi.huawei.com
parameters:
  backend: nfs-dtree-181
  parentname: parent-filesystem-name
  volumeType: dtree
  allocType: thin
  authClient: "*"

Storage Class Parameters Supported by Dtrees

Table 1 StorageClass configuration parameters

Parameter	Description	Mandatory	Default Value	Remarks
metadata.name	User-defined name of a StorageClass object.	Yes	-	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.
provisioner	Name of the provisioner.	Yes	csi.huawei.com	Set this parameter to the driver name set during Huawei CSI installation. The value is the same as that of driverName in the values.yaml file.
reclaimPolicy	Reclamation policy. The following types are supported: Delete: Resources are automatically reclaimed. Retain: Resources are manually reclaimed.	No	Delete	Delete: When a PV/PVC is deleted, resources on the storage device are also deleted. Retain: When a PV/PVC is deleted, resources on the storage device are not deleted.
allowVolumeExpansion	Whether to allow volume expansion. If this parameter is set to true, the capacity of the PV that uses the StorageClass can be expanded.	No	false	This function can only be used to expand PV capacity but cannot be used to reduce PV capacity.
mountOptions	List of mount parameters, which can be used to specify the parameters of the -o option when the mount command is executed on a host.	No	-	For details about common parameters in mountOptions, see Table 2. You can also specify other mount parameters.
parameters.backend	Name of the backend where the resource to be created is located.	Conditionally mandatory	-	If this parameter is not set, Huawei CSI will randomly select a backend that meets the capacity requirements to create resources. You are advised to specify a backend to ensure that the created resource is located on the expected backend. This parameter is mandatory if parameters.parentname is configured.
parameters.parentname	Name of a file system on the current storage device. Dtree is created in the file system.	Conditionally mandatory	-	This parameter is mandatory when parentname is not configured for the backend. If parentname is configured only in the StorageClass but not configured in the storage backend, set CSIDriverObject.attachRequired to true during CSI installation.
parameters.volumeName	Name of the storage resource created by dynamic volume provisioning. You can configure a placeholder to customize the storage resource name. The following placeholders are supported: PVC namespace: {{ .PVCNamespace }} PVC name: {{ .PVCName }}	No	-	The value can contain letters, digits, hyphens (-), underscores (_), and periods (.). It cannot be left empty. The length of the expanded placeholder ranges from 1 to 255 characters. Both the PVC namespace and PVC name must be configured. To avoid duplicate resource names, the PVC UID is added to the end of the name as a unique identifier by default. Configuration example: PVC namespace: namespace. PVC name: pvc-1. PVC UID: c2fd3f46-bf17-4a7d-b88e-2e3232bae434. volumeName is set to prefix-{{ .PVCNamespace }}_{{ .PVCName }}. The ultimate storage resource name is prefix-namespace_pvc-1-c2fd3f46bf174a7db88e2e3232bae434.
parameters.volumeType	Type of the volume to be created. The following types are supported: lun: A LUN is provisioned on the storage side. fs: A file system is provisioned on the storage side. dtree: A volume of the Dtree type is provisioned on the storage side.	Yes	-	When dtree is used, the value must be dtree.
parameters.authClient	IP address of the NFS client that can access the volume. You can enter the client host name (a full domain name is recommended), client IP address, or client IP address segment.	Yes	-	The asterisk () can be used to indicate any client. If you are not sure about the IP address of the access client, you are advised to use the asterisk () to prevent the client access from being rejected by the storage system. If the client host name is used, you are advised to use the full domain name. The IP addresses can be IPv4 addresses, IPv6 addresses, or a combination of IPv4 and IPv6 addresses. You can enter multiple host names, IP addresses, or IP address segments and separate them with semicolons (;). Example: 192.168.0.10;192.168.0.0/24;myserver1.test
parameters.fsPermission	Permission on the directory mounted to a container.	No	-	For details about the configuration format, refer to the Linux permission settings, for example, 777 and 755.
parameters.rootSquash	Controls the root permission of the client. The value can be: root_squash: The client cannot access the storage system as user root. If a client accesses the storage system as user root, the client will be mapped as an anonymous user. no_root_squash: A client can access the storage system as user root and has the permission of user root.	No	-
parameters.allSquash	Whether to retain the user ID (UID) and group ID (GID) of a shared directory. The value can be: all_squash: The UID and GID of the shared directory are mapped to anonymous users. no_all_squash: The UID and GID of the shared directory are retained.	No	-
parameters.accesskrb5	Configures the krb5 security protocol. read_only: read-only read_write: read and write none: no permission	No	-	During mounting, you can specify the sec parameter in mountOptions.
parameters.accesskrb5i	Configures the krb5i security protocol. read_only: read-only read_write: read and write none: no permission	No	-	During mounting, you can specify the sec parameter in mountOptions.
parameters.accesskrb5p	Configures the krb5p security protocol. read_only: read-only read_write: read and write none: no permission	No	-	During mounting, you can specify the sec parameter in mountOptions.
parameters.disableVerifyCapacity	Whether to disable volume capacity verification. After this function is disabled, the system will not verify whether the volume capacity is an integer multiple of the sector size. The value can be: "true": disables volume capacity verification. "false": enables volume capacity verification. NOTICE: When Red Hat OpenShift Virtualization is used to connect to CSI, this parameter must be set to true.	No	"true"	For OceanStor Dorado and OceanStor storage, the sector size is 512 bytes.
parameters.description	Description of the dtree share to be created. Value type: character string The value contains 0 to 255 characters.	No	-

Table 2 Common parameters in mountOptions

Parameter	Description	Mandatory	Default Value	Remarks
mountOptions.nfsvers	NFS mount option on the host. The following mount option is supported: nfsvers: protocol version for NFS mounting. The value can be 3, 4, 4.0, 4.1, or 4.2.	No	-	This parameter is optional after the -o parameter when the mount command is executed on the host. The value is in list format. If the NFS version is specified for mounting, NFS 3, 4.0, 4.1, and 4.2 protocols are supported (the protocol must be supported and enabled on storage devices). If nfsvers is set to 4, the latest protocol version NFS 4 may be used for mounting due to different OS configurations, for example, 4.2. If the 4.0 protocol is required, you are advised to set nfsvers to 4.0.
mountOptions.sec	Kerberos 5 protocol for mounting NFS file systems.	No	-	If Kerberos 5 is used, set this parameter to krb5. If Kerberos 5i is used, set this parameter to krb5i. If Kerberos 5p is used, set this parameter to krb5p. Kerberos supports only NFSv4.0 and later versions. OceanStor Dorado and OceanStor 6.1.3 and later versions support Kerberos.
mountOptions.proto	Transmission protocol used for NFS mounting. The value can be rdma.	No	-	The parameter is supported for NAS storage of OceanStor Dorado and OceanStor 6.1.7 and later.
mountOptions.port	Protocol port used for NFS mounting.	Conditionally mandatory	-	If the transmission protocol is rdma, set this parameter to 20049.

1.1.3 - Block Service

Creating a StorageClass

Prepare a StorageClass configuration file, for example, msc .yaml. For details about the StorageClass configuration, see the following example.
Run the following command to create a StorageClass using the configuration file.
```
kubectl apply -f mysc.yaml
```

Run the following command to view the information about the created StorageClass.

kubectl get sc mysc

The following is an example of the command output.

NAME   PROVISIONER      RECLAIMPOLICY   VOLUMEBINDINGMODE   ALLOWVOLUMEEXPANSION   AGE
mysc   csi.huawei.com   Delete          Immediate           true                   8s

Block Storage Class Configuration Example

If LUNs are used as storage resources and the file system needs to be formatted to a local file system, refer to the following example.

kind: StorageClass
apiVersion: storage.k8s.io/v1
metadata:
  name: mysc
provisioner: csi.huawei.com
parameters:
  backend: lun-181
  pool: StoragePool001
  volumeType: lun
  allocType: thin
  fsType: ext4

StorageClass Parameters Supported by Block Services

Table 1 StorageClass configuration parameters

Parameter	Description	Mandatory	Default Value	Whether the Volume Management Takes Effect	Remarks
metadata.name	User-defined name of a StorageClass object.	Yes	-	Yes	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.
provisioner	Name of the provisioner.	Yes	csi.huawei.com	Yes	Set this parameter to the driver name set during Huawei CSI installation. The value is the same as that of driverName in the values.yaml file.
reclaimPolicy	Reclamation policy. The following types are supported: Delete: Resources are automatically reclaimed. Retain: Resources are manually reclaimed.	No	Delete	Yes	Delete: When a PV/PVC is deleted, resources on the storage device are also deleted. Retain: When a PV/PVC is deleted, resources on the storage device are not deleted.
allowVolumeExpansion	Whether to allow volume expansion. If this parameter is set to true, the capacity of the PV that uses the StorageClass can be expanded.	No	false	Yes	This function can only be used to expand PV capacity but cannot be used to reduce PV capacity.
mountOptions	List of mount parameters, which can be used to specify the parameters of the -o option when the mount command is executed on a host.	No	-	Yes	For details about common parameters in mountOptions, see Table 2. You can also specify other mount parameters.
parameters.backend	Name of the backend where the resource to be created is located. This field must be set if parameters.pool is set.	Conditionally mandatory	-	No	If this parameter is not set, Huawei CSI will randomly select a backend that meets the capacity requirements to create resources. You are advised to specify a backend to ensure that the created resource is located on the expected backend.
parameters.pool	Name of the storage resource pool where the resource to be created is located.	No	-	No	If this parameter is not set, Huawei CSI will randomly select a storage pool that meets the capacity requirements from the selected backend to create resources. You are advised to specify a storage pool to ensure that the created resource is located in the expected storage pool.
parameters.volumeName	Name of the storage resource created by dynamic volume provisioning. You can configure a placeholder to customize the storage resource name. The following placeholders are supported: PVC namespace: {{ .PVCNamespace }} PVC name: {{ .PVCName }}	No	-	No	The value can contain letters, digits, hyphens (-), underscores (_), and periods (.). It cannot be left empty. The length of the expanded placeholder ranges from 1 to 255 characters. Both the PVC namespace and PVC name must be configured. To avoid duplicate resource names, the PVC UID is added to the end of the name as a unique identifier by default. Configuration example: PVC namespace: namespace. PVC name: pvc-1. PVC UID: c2fd3f46-bf17-4a7d-b88e-2e3232bae434. volumeName is set to prefix-{{ .PVCNamespace }}_{{ .PVCName }}. The ultimate storage resource name is prefix-namespace_pvc-1-c2fd3f46bf174a7db88e2e3232bae434.
parameters.volumeType	Type of the volume to be created. The following types are supported: lun: A LUN is provisioned on the storage side. fs: A file system is provisioned on the storage side. dtree: A volume of the dtree type is provisioned on the storage side.	Yes	-	Yes	The value is fixed to lun.
parameters.allocType	Allocation type of the volume to be created. The following types are supported: thin: Not all required space is allocated during creation. Instead, the space is dynamically allocated based on the usage. thick: All required space is allocated during creation.	No	thin	No	If this parameter is set to thin, the required space is not allocated immediately when a volume is created. Instead, the space is dynamically allocated based on the usage. OceanStor Dorado does not support thick.
parameters.fsType	Type of a host file system. The supported types are: ext2 ext3 ext4 xfs	No	ext4	Yes	This parameter is available only when volumeMode of the PVC is set to Filesystem.
parameters.cloneSpeed	Cloning speed. The value ranges from 1 to 4.	No	3	No	4 indicates the highest speed. This parameter takes effect when a PVC is cloned or a PVC is created from a snapshot.
parameters.applicationType	Application type name of the LUN to be created.	No	-	Yes	Log in to DeviceManager and choose Services > Block Service > LUN Groups (or Namespace Groups) > LUNs (or Namespaces) > Create to obtain the application type name.
parameters.qos	LUN/NAS QoS settings of the PV on the storage side. The value of the parameter is JSON character strings in dictionary format. A character string is enclosed by single quotation marks and the dictionary key by double quotation marks. Example: '{"maxMBPS": 999, "maxIOPS": 999}'	No	-	No	For details about the supported QoS configurations, see Table 3.
parameters.fsPermission	Permission on the directory mounted to a container.	No	-	No	For details about the configuration format, refer to the Linux permission settings, for example, 777 and 755.
parameters.disableVerifyCapacity	Whether to disable volume capacity verification. After this function is disabled, the system will not verify whether the volume capacity is an integer multiple of the sector size. The value can be: "true": disables volume capacity verification. "false": enables volume capacity verification. NOTICE: When Red Hat OpenShift Virtualization is used to connect to CSI, this parameter must be set to true.	No	"true"	Yes	For OceanStor Dorado and OceanStor storage, the sector size is 512 bytes.
parameters.description	Description of the LUN to be created. Value type: character string The value contains 0 to 255 characters.	No	-	No

Table 2 Common parameters in mountOptions

Parameter	Description	Mandatory	Default Value	Remarks
mountOptions.discard	Automatically triggers the Trim or Discard operation when a file system is mounted. This operation instructs a block device to release unused blocks.	No	-	The xfs and ext4 file systems are supported.

Table 3 Supported QoS configurations

Parameter	Description	Remarks
IOTYPE	Read/write type.	The value can be: 2: read and write I/Os
MAXBANDWIDTH	Maximum bandwidth. This is a restriction policy parameter.	The value is an integer ranging from 1 to 999999999, expressed in MB/s.
MINBANDWIDTH	Minimum bandwidth. This is a protection policy parameter.	The value is an integer ranging from 1 to 999999999, expressed in MB/s.
MAXIOPS	Maximum IOPS. This is a restriction policy parameter.	The value is an integer ranging from 100 to 999999999.
MINIOPS	Minimum IOPS. This is a protection policy parameter.	The value is an integer ranging from 100 to 999999999.
LATENCY	Maximum latency. This is a protection policy parameter.	The value can be 0.5 or 1.5, expressed in ms.

1.2 - Flash Storage (OceanStor A600/A800)

1.2.1 - File System

Creating a StorageClass

Prepare a StorageClass configuration file, for example, msc .yaml. For details about the StorageClass configuration, see the following example.
Run the following command to create a StorageClass using the configuration file.
```
kubectl apply -f mysc.yaml
```

Run the following command to view the information about the created StorageClass.

kubectl get sc mysc

The following is an example of the command output.

NAME   PROVISIONER      RECLAIMPOLICY   VOLUMEBINDINGMODE   ALLOWVOLUMEEXPANSION   AGE
mysc   csi.huawei.com   Delete          Immediate           true                   8s

NFS Protocol Configuration Example

When a container uses the NFS protocol to connect to file system resources, refer to the following StorageClass configuration example. In this example, NFS version 4.1 is specified for mounting.

kind: StorageClass
apiVersion: storage.k8s.io/v1
metadata:
  name: mysc
provisioner: csi.huawei.com
parameters:
  backend: nfs-nas-181
  pool: StoragePool001
  volumeType: fs
  allocType: thin
  authClient: "*"
mountOptions:
  - nfsvers=4.1 # Specify the version 4.1 for NFS mounting.

DataTurbo Protocol Configuration Example

If a container uses OceanStor A series storage and the storage supports DataTurbo-based access, you can refer to the following configuration example. In this example, the DataTurbo share user name is user01.

kind: StorageClass
apiVersion: storage.k8s.io/v1
metadata:
  name: mysc
provisioner: csi.huawei.com
parameters:
  backend: dtfs-nas-181
  pool: pool001
  volumeType: fs
  allocType: thin
  authUser: user01

StorageClass Parameters Supported by File Services

Table 1 StorageClass configuration parameters

Parameter	Description	Mandatory	Default Value	Whether the Volume Management Takes Effect	Remarks
metadata.name	User-defined name of a StorageClass object.	Yes	-	Yes	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.
provisioner	Name of the provisioner.	Yes	csi.huawei.com	Yes	Set this parameter to the driver name set during Huawei CSI installation. The value is the same as that of driverName in the values.yaml file.
reclaimPolicy	Reclamation policy. The following types are supported: Delete: Resources are automatically reclaimed. Retain: Resources are manually reclaimed.	No	Delete	Yes	Delete: When a PV/PVC is deleted, resources on the storage device are also deleted. Retain: When a PV/PVC is deleted, resources on the storage device are not deleted.
allowVolumeExpansion	Whether to allow volume expansion. If this parameter is set to true, the capacity of the PV that uses the StorageClass can be expanded.	No	false	Yes	This function can only be used to expand PV capacity but cannot be used to reduce PV capacity.
mountOptions	List of mount parameters, which can be used to specify the parameters of the -o option when the mount command is executed on a host.	No	-	Yes	For details about common parameters in mountOptions, see Table 2. You can also specify other mount parameters.
parameters.backend	Name of the backend where the resource to be created is located. This field must be set if parameters.pool is set.	Conditionally mandatory	-	No	If this parameter is not set, Huawei CSI will randomly select a backend that meets the capacity requirements to create resources. You are advised to specify a backend to ensure that the created resource is located on the expected backend.
parameters.pool	Name of the storage resource pool where the resource to be created is located.	No	-	No	If this parameter is not set, Huawei CSI will randomly select a storage pool that meets the capacity requirements from the selected backend to create resources. You are advised to specify a storage pool to ensure that the created resource is located in the expected storage pool.
parameters.volumeName	Name of the storage resource created by dynamic volume provisioning. You can configure a placeholder to customize the storage resource name. The following placeholders are supported: PVC namespace: {{ .PVCNamespace }} PVC name: {{ .PVCName }}	No	-	No	The value can contain letters, digits, hyphens (-), underscores (_), and periods (.). It cannot be left empty. The length of the expanded placeholder ranges from 1 to 255 characters. Both the PVC namespace and PVC name must be configured. To avoid duplicate resource names, the PVC UID is added to the end of the name as a unique identifier by default. Configuration example: PVC namespace: namespace. PVC name: pvc-1. PVC UID: c2fd3f46-bf17-4a7d-b88e-2e3232bae434. volumeName is set to prefix-{{ .PVCNamespace }}_{{ .PVCName }}. The ultimate storage resource name is prefix-namespace_pvc-1-c2fd3f46bf174a7db88e2e3232bae434.
parameters.volumeType	Type of the volume to be created. The following types are supported: lun: A LUN is provisioned on the storage side. fs: A file system is provisioned on the storage side. dtree: A volume of the dtree type is provisioned on the storage side.	Yes	-	Yes	To use the file service, you must set this parameter to fs.
parameters.allocType	Allocation type of the volume to be created. The following types are supported: thin: Not all required space is allocated during creation. Instead, the space is dynamically allocated based on the usage.	No	thin	No	If this parameter is set to thin, the required space is not allocated immediately when a volume is created. Instead, the space is dynamically allocated based on the usage.
parameters.authClient	IP address of the NFS client that can access the volume. This parameter is mandatory when the nfs or nfs+ protocol is used. You can enter the client host name (a full domain name is recommended), client IP address, or client IP address segment.	Conditionally mandatory	-	No	The asterisk () can be used to indicate any client. If you are not sure about the IP address of the access client, you are advised to use the asterisk () to prevent the client access from being rejected by the storage system. If the client host name is used, you are advised to use the full domain name. The IP addresses can be IPv4 addresses, IPv6 addresses, or a combination of IPv4 and IPv6 addresses. You can enter multiple host names, IP addresses, or IP address segments and separate them with semicolons (;). Example: 192.168.0.10;192.168.0.0/24;myserver1.test
parameters.authUser	DataTurbo user who can access the DataTurbo share. This parameter is mandatory when the DataTurbo(dtfs) protocol is used.	Conditionally mandatory	-	No	You can enter multiple DataTurbo users at a time and separate them with semicolons (;). Example: auth_user1;auth_user2;auth_user3
parameters.applicationType	Application type name when a file system is created.	No	-	Yes	Log in to DeviceManager and choose Services > File Service > File Systems > Create to obtain the application type name.
parameters.fsPermission	Permission on the directory mounted to a container.	No	-	No	For details about the configuration format, refer to the Linux permission settings, for example, 777 and 755.
parameters.rootSquash	Controls the root permission of the client. The value can be: root_squash: The client cannot access the storage system as user root. If a client accesses the storage system as user root, the client will be mapped as an anonymous user. no_root_squash: A client can access the storage system as user root and has the permission of user root.	No	-	No
parameters.allSquash	Whether to retain the user ID (UID) and group ID (GID) of a shared directory. The value can be: all_squash: The UID and GID of the shared directory are mapped to anonymous users. no_all_squash: The UID and GID of the shared directory are retained.	No	-	No
parameters.disableVerifyCapacity	Whether to disable volume capacity verification. After this function is disabled, the system will not verify whether the volume capacity is an integer multiple of the sector size. The value can be: "true": disables volume capacity verification. "false": enables volume capacity verification. NOTICE: When Red Hat OpenShift Virtualization is used to connect to CSI, this parameter must be set to true.	No	"true"	Yes	The sector size of OceanStor A series is 512 bytes.
parameters.description	Description of the file system to be created. Value type: character string The value contains 0 to 255 characters.	No	-	No
parameters.advancedOptions	Advanced volume creation parameters. The value of the parameter is JSON character strings in dictionary format. A character string is enclosed by single quotation marks and the dictionary key by double quotation marks. Example: '{"CAPACITYTHRESHOLD": 90}'	No	-	No	For details about the supported advanced parameters, see Table 3.

Table 2 Common parameters in mountOptions

Parameter

Description

Mandatory

Default Value

Remarks

mountOptions.nfsvers

NFS mount option on the host. The following mount option is supported:

nfsvers: protocol version for NFS mounting. The value can be 3, 4, 4.0, 4.1, or 4.2.

This parameter is optional after the -o parameter when the mount command is executed on the host. The value is in list format.

If the NFS version is specified for mounting, NFS 3, 4.0, 4.1, and 4.2 protocols are supported (the protocol must be supported and enabled on storage devices). If nfsvers is set to 4, the latest protocol version NFS 4 may be used for mounting due to different OS configurations, for example, 4.2. If the 4.0 protocol is required, you are advised to set nfsvers to 4.0.

mountOptions.dn

Domain name of the logical port used for mounting when the DataTurbo(dtfs) protocol is used.

WWN of a storage device.

To mount the HyperScale cluster file system, enter the domain name of the HyperScale cluster.

The description of the dn parameter is for reference only. For details about other mounting parameters of the DataTurbo protocol, see OceanStor DataTurbo DTFS User Guide.

Table 3 Supported advanced volume creation parameters

Parameter	Description	Remarks
CAPACITYTHRESHOLD	Total capacity alarm threshold.	Parameter type: uint64. For details about the default value and value range, see the corresponding storage product manual.

Parameter

Description

Remarks

CAPACITYTHRESHOLD

Total capacity alarm threshold.

Parameter type: uint64.

For details about the default value and value range, see the corresponding storage product manual.

1.3 - Mass Storage (FusionStorage Block/OceanStor Pacific Series)

1.3.1 - File System

Creating a StorageClass

Prepare a StorageClass configuration file, for example, msc .yaml. For details about the StorageClass configuration, see the following example.
Run the following command to create a StorageClass using the configuration file.
```
kubectl apply -f mysc.yaml
```

Run the following command to view the information about the created StorageClass.

kubectl get sc mysc

The following is an example of the command output.

NAME   PROVISIONER      RECLAIMPOLICY   VOLUMEBINDINGMODE   ALLOWVOLUMEEXPANSION   AGE
mysc   csi.huawei.com   Delete          Immediate           true                   8s

NFS Protocol Configuration Example

When a container uses the NFS protocol to connect to file system resources, refer to the following StorageClass configuration example. In this example, NFS version 4.1 is specified for mounting.

kind: StorageClass
apiVersion: storage.k8s.io/v1
metadata:
  name: mysc
provisioner: csi.huawei.com
parameters:
  backend: nfs-nas-181
  pool: pool001
  volumeType: fs
  allocType: thin
  authClient: "*"
mountOptions:
  - nfsvers=4.1 # Specify the version 4.1 for NFS mounting.

DPC Protocol Configuration Example

When the storage supports access using the DPC protocol, you can configure the mount parameters for DPC access in the StorageClass. In this example, acl is used as the authentication parameter for mounting, and cnflush is used to set the asynchronous disk flushing mode.

kind: StorageClass
apiVersion: storage.k8s.io/v1
metadata:
  name: mysc
provisioner: csi.huawei.com
parameters:
  backend: nfs-dpc-101
  pool: pool001
  volumeType: fs
  allocType: thin
mountOptions:
  - acl # Set the authentication parameter.
  - cnflush # Set the asynchronous disk flushing mode.

StorageClass Parameters Supported by File Systems

Table 1 StorageClass configuration parameters

Parameter	Description	Mandatory	Default Value	Whether the Volume Management Takes Effect	Remarks
metadata.name	User-defined name of a StorageClass object.	Yes	-	Yes	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.
provisioner	Name of the provisioner.	Yes	csi.huawei.com	Yes	Set this parameter to the driver name set during Huawei CSI installation. The value is the same as that of driverName in the values.yaml file.
reclaimPolicy	Reclamation policy. The following types are supported: Delete: Resources are automatically reclaimed. Retain: Resources are manually reclaimed.	No	Delete	Yes	Delete: When a PV/PVC is deleted, resources on the storage device are also deleted. Retain: When a PV/PVC is deleted, resources on the storage device are not deleted.
allowVolumeExpansion	Whether to allow volume expansion. If this parameter is set to true, the capacity of the PV that uses the StorageClass can be expanded.	No	false	Yes	This function can only be used to expand PV capacity but cannot be used to reduce PV capacity.
mountOptions	List of mount parameters, which can be used to specify the parameters of the -o option when the mount command is executed on a host.	No	-	Yes	For details about common parameters in mountOptions, see Table 2. You can also specify other mount parameters.
parameters.backend	Name of the backend where the resource to be created is located. This field must be set if parameters.pool is set.	Conditionally mandatory	-	No	If this parameter is not set, Huawei CSI will randomly select a backend that meets the capacity requirements to create resources. You are advised to specify a backend to ensure that the created resource is located on the expected backend.
parameters.pool	Name of the storage resource pool where the resource to be created is located.	No	-	No	If this parameter is not set, Huawei CSI will randomly select a storage pool that meets the capacity requirements from the selected backend to create resources. You are advised to specify a storage pool to ensure that the created resource is located in the expected storage pool.
parameters.volumeType	Type of the volume to be created. The following types are supported: lun: A LUN is provisioned on the storage side. fs: A file system is provisioned on the storage side. dtree: A volume of the Dtree type is provisioned on the storage side.	Yes	-	Yes	The value is fixed to fs.
parameters.allocType	Allocation type of the volume to be created. The following types are supported: thin: Not all required space is allocated during creation. Instead, the space is dynamically allocated based on the usage. thick: All required space is allocated during creation.	No	thin	No	If this parameter is set to thin, the required space is not allocated immediately when a volume is created. Instead, the space is dynamically allocated based on the usage.
parameters.authClient	IP address of the NFS client that can access the volume. This parameter is mandatory when the NFS protocol is used. You can enter the client host name (a full domain name is recommended), client IP address, or client IP address segment.	Conditionally mandatory	-	No	The asterisk () can be used to indicate any client. If you are not sure about the IP address of the access client, you are advised to use the asterisk () to prevent the client access from being rejected by the storage system. If the client host name is used, you are advised to use the full domain name. The IP addresses can be IPv4 addresses, IPv6 addresses, or a combination of IPv4 and IPv6 addresses. You can enter multiple host names, IP addresses, or IP address segments and separate them with semicolons (;). Example: 192.168.0.10;192.168.0.0/24;myserver1.test
parameters.storageQuota	File system quota settings. The value of the parameter is JSON character strings in dictionary format. A character string is enclosed by single quotation marks and the dictionary key by double quotation marks. Example: '{"spaceQuota": "softQuota", "gracePeriod": 100}'	No	-	No	For details about the supported quota configurations, see Table 4.
parameters.qos	QoS settings of the file system on the storage side of the PV. The value of the parameter is JSON character strings in dictionary format. A character string is enclosed by single quotation marks and the dictionary key by double quotation marks. Example: '{"maxMBPS": 999, "maxIOPS": 999}'	No	-	No	For details about the supported QoS configurations, see Table 3.
parameters.fsPermission	Permission on the directory mounted to a container.	No	-	No	For details about the configuration format, refer to the Linux permission settings, for example, 777 and 755.
parameters.rootSquash	Controls the root permission of the client. The value can be: root_squash: The client cannot access the storage system as user root. If a client accesses the storage system as user root, the client will be mapped as an anonymous user. no_root_squash: A client can access the storage system as user root and has the permission of user root.	No	-	No
parameters.allSquash	Whether to retain the user ID (UID) and group ID (GID) of a shared directory. The value can be: all_squash: The UID and GID of the shared directory are mapped to anonymous users. no_all_squash: The UID and GID of the shared directory are retained.	No	-	No
parameters.snapshotDirectoryVisibility	Whether the snapshot directory is visible. The value can be: visible: The snapshot directory is visible. invisible: The snapshot directory is invisible.	No	-	No
parameters.disableVerifyCapacity	Whether to disable volume capacity verification. After this function is disabled, the system will not verify whether the volume capacity is an integer multiple of the sector size. The value can be: "true": disables volume capacity verification. "false": enables volume capacity verification. NOTICE: When Red Hat OpenShift Virtualization is used to connect to CSI, this parameter must be set to true.	No	"true"	No	For OceanStor Pacific NAS, the sector size is 1 KB.

Table 2 Common parameters in mountOptions

Parameter	Description	Mandatory	Default Value	Remarks
mountOptions.nfsvers	NFS mount option on the host. The following mount option is supported: nfsvers: protocol version for NFS mounting. The value can be 3, 4, 4.0, 4.1, or 4.2.	No	-	This parameter is optional after the -o parameter when the mount command is executed on the host. The value is in list format. If the NFS version is specified for mounting, NFS 3, 4.0, 4.1, and 4.2 protocols are supported (the protocol must be supported and enabled on storage devices). If nfsvers is set to 4, the latest protocol version NFS 4 may be used for mounting due to different OS configurations, for example, 4.2. If the 4.0 protocol is required, you are advised to set nfsvers to 4.0.
mountOptions.proto	Transmission protocol used for NFS mounting. The value can be rdma.	No	-	This example applies to 8.2.0 or later.
mountOptions.port	Protocol port used for NFS mounting.	Conditionally mandatory	-	If the transmission protocol is rdma, set this parameter to 20049.
mountOptions.acl	The DPC namespace supports the ACL function. The DPC client supports POSIX ACL, NFSv4 ACL, and NT ACL authentication.	No	-	The descriptions of acl, aclonlyposix, cnflush, and cflush are for reference only. For details about the parameters, see OceanStor Pacific Series Product Documentation and choose Configuration > Basic Service Configuration Guide for File > Configuring Basic Services (DPC Scenario) > Accessing a DPC Share on a Client > Step 2.
mountOptions.aclonlyposix	The DPC namespace supports POSIX ACL, and the DPC client supports POSIX ACL authentication. The following protocols support POSIX ACL: DPC, NFSv3, and HDFS. If NFSv4 ACL or NT ACL is used, the DPC client cannot identify the ACL of this type. As a result, the ACL of this type does not take effect.	No	-	If aclonlyposix and acl are used together, only acl takes effect. That is, the namespace supports the ACL function.
mountOptions.cnflush	Asynchronous disk flushing mode. That is, data is not flushed to disks immediately when files in the namespace are closed.	No	-	Asynchronous flushing mode: When a file is closed, data in the cache is not flushed to storage media in synchronous mode. Instead, data is written from the cache to the storage media in asynchronous flushing mode. After the write service is complete, data is flushed from the cache to disks periodically based on the flushing period. In a multi-client scenario, if concurrent operations are performed on the same file, the file size update is affected by the disk flushing period. That is, the file size is updated only after the disk flushing is complete. Generally, the update is completed within several seconds. Synchronous I/Os are not affected by the disk flushing period.
mountOptions.cflush	Synchronous disk flushing mode. That is, data is flushed to disks immediately when files in the namespace are closed.	No	-	By default, the synchronous disk flushing mode is used.

Table 3 Supported QoS configurations

Parameter	Description	Remarks
maxMBPS	Maximum bandwidth. This is a restriction policy parameter.	This parameter is mandatory. The value is an integer greater than 0, expressed in MB/s. For details about the maximum value, see the actual limit of the storage device. For example, the maximum value of OceanStor Pacific NAS is 1073741824.
maxIOPS	Maximum IOPS. This is a restriction policy parameter.	This parameter is mandatory. The value is an integer greater than 0. For details about the maximum value, see the actual limit of the storage device. For example, the maximum value of OceanStor Pacific NAS is 1073741824000.

Table 4 Supported quota configurations

Parameter	Description	Remarks
spaceQuota	File quota type.	This parameter is mandatory. Only softQuota or hardQuota can be configured.
gracePeriod	Grace period allowed when the soft quota is configured.	This parameter is conditionally optional only when spaceQuota is set to softQuota. The value is an integer ranging from 0 to 4294967294.

Parameter

Description

Remarks

spaceQuota

File quota type.

This parameter is mandatory. Only softQuota or hardQuota can be configured.

gracePeriod

Grace period allowed when the soft quota is configured.

This parameter is conditionally optional only when spaceQuota is set to softQuota.

The value is an integer ranging from 0 to 4294967294.

1.3.2 - Dtree

Creating a StorageClass

Prepare a StorageClass configuration file, for example, msc .yaml. For details about the StorageClass configuration, see the following example.
Run the following command to create a StorageClass using the configuration file.
```
kubectl apply -f mysc.yaml
```

Run the following command to view the information about the created StorageClass.

kubectl get sc mysc

The following is an example of the command output.

NAME   PROVISIONER      RECLAIMPOLICY   VOLUMEBINDINGMODE   ALLOWVOLUMEEXPANSION   AGE
mysc   csi.huawei.com   Delete          Immediate           true                   8s

Example of StorageClass Configuration Supported by the NFS Protocol

When a container uses the NFS protocol to connect to dtree resources, refer to the following StorageClass configuration example. In this example, NFS version 4.1 is specified for mounting.

kind: StorageClass
apiVersion: storage.k8s.io/v1
metadata:
  name: mysc
provisioner: csi.huawei.com
parameters:
  backend: nfs-dtree-181
  parentname: parent-filesystem-name
  volumeType: dtree
  allocType: thin
  authClient: "*"
mountOptions:
  - nfsvers=4.1 # Specify the version 4.1 for NFS mounting.

Example of StorageClass Configuration Supported by the DPC Protocol

When a container uses the DPC protocol to connect to dtree resources, refer to the following StorageClass configuration example. In this example, acl is used as the authentication parameter for mounting, and cnflush is used to set the asynchronous disk flushing mode.

kind: StorageClass
apiVersion: storage.k8s.io/v1
metadata:
  name: mysc
provisioner: csi.huawei.com
parameters:
  backend: nfs-dtree-181
  parentname: parent-filesystem-name
  volumeType: dtree
  allocType: thin
  authClient: "*"
mountOptions:
  - acl # Set the authentication parameter.
  - cnflush # Set the asynchronous disk flushing mode.

StorageClass Parameters Supported by Dtrees

Table 1 StorageClass configuration parameters

Parameter	Description	Mandatory	Default Value	Remarks
metadata.name	User-defined name of a StorageClass object.	Yes	-	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.
provisioner	Name of the provisioner.	Yes	csi.huawei.com	Set this parameter to the driver name set during Huawei CSI installation. The value is the same as that of driverName in the values.yaml file.
reclaimPolicy	Reclamation policy. The following types are supported: Delete: Resources are automatically reclaimed. Retain: Resources are manually reclaimed.	No	Delete	Delete: When a PV/PVC is deleted, resources on the storage device are also deleted. Retain: When a PV/PVC is deleted, resources on the storage device are not deleted.
allowVolumeExpansion	Whether to allow volume expansion. If this parameter is set to true, the capacity of the PV that uses the StorageClass can be expanded.	No	false	This function can only be used to expand PV capacity but cannot be used to reduce PV capacity.
mountOptions	List of mount parameters, which can be used to specify the parameters of the -o option when the mount command is executed on a host.	No	-	For details about common parameters in mountOptions, see Table 2. You can also specify other mount parameters.
parameters.backend	Name of the backend where the resource to be created is located.	Conditionally mandatory	-	If this parameter is not set, Huawei CSI will randomly select a backend that meets the capacity requirements to create resources. You are advised to specify a backend to ensure that the created resource is located on the expected backend. This parameter is mandatory if parameters.parentname is set.
parameters.parentname	Name of a file system on the current storage device. Dtree is created in the file system.	Conditionally mandatory	-	This parameter is mandatory when parentname is not set for the backend. If parentname is configured only in the StorageClass but not configured in the storage backend, set CSIDriverObject.attachRequired to true during CSI installation.
parameters.volumeName	Name of the storage resource created by dynamic volume provisioning. You can configure a placeholder to customize the storage resource name. The following placeholders are supported: PVC namespace: {{ .PVCNamespace }} PVC name: {{ .PVCName }}	No	-	The value can contain letters, digits, hyphens (-), underscores (_), and periods (.). It cannot be left empty. The length of the expanded placeholder ranges from 1 to 255 characters. Both the PVC namespace and PVC name must be configured. To avoid duplicate resource names, the PVC UID is added to the end of the name as a unique identifier by default. Configuration example: PVC namespace: namespace. PVC name: pvc-1. PVC UID: c2fd3f46-bf17-4a7d-b88e-2e3232bae434. volumeName is set to prefix-{{ .PVCNamespace }}_{{ .PVCName }}. The ultimate storage resource name is prefix-namespace_pvc-1-c2fd3f46bf174a7db88e2e3232bae434.
parameters.volumeType	Type of the volume to be created. The following types are supported: lun: A LUN is provisioned on the storage side. fs: A file system is provisioned on the storage side. dtree: A volume of the Dtree type is provisioned on the storage side.	Yes	-	When dtree is used, the value must be dtree.
parameters.authClient	IP address of the NFS client that can access the volume. You can enter the client host name (a full domain name is recommended), client IP address, or client IP address segment.	Yes	-	The asterisk () can be used to indicate any client. If you are not sure about the IP address of the access client, you are advised to use the asterisk () to prevent the client access from being rejected by the storage system. If the client host name is used, you are advised to use the full domain name. The IP addresses can be IPv4 addresses, IPv6 addresses, or a combination of IPv4 and IPv6 addresses. You can enter multiple host names, IP addresses, or IP address segments and separate them with semicolons (;). Example: 192.168.0.10;192.168.0.0/24;myserver1.test
parameters.fsPermission	Permission on the directory mounted to a container.	No	-	For details about the configuration format, refer to the Linux permission settings, for example, 777 and 755.
parameters.rootSquash	Controls the root permission of the client. The value can be: root_squash: The client cannot access the storage system as user root. If a client accesses the storage system as user root, the client will be mapped as an anonymous user. no_root_squash: A client can access the storage system as user root and has the permission of user root.	No	-
parameters.allSquash	Whether to retain the user ID (UID) and group ID (GID) of a shared directory. The value can be: all_squash: The UID and GID of the shared directory are mapped to anonymous users. no_all_squash: The UID and GID of the shared directory are retained.	No	-
parameters.disableVerifyCapacity	Whether to disable volume capacity verification. After this function is disabled, the system will not verify whether the volume capacity is an integer multiple of the sector size. The value can be: "true": disables volume capacity verification. "false": enables volume capacity verification. NOTICE: When Red Hat OpenShift Virtualization is used to connect to CSI, this parameter must be set to true.	No	"true"	For OceanStor Pacific dtrees, the sector size is 1 byte.

Table 2 Common parameters in mountOptions

Parameter	Description	Mandatory	Default Value	Remarks
mountOptions.nfsvers	NFS mount option on the host. The following mount option is supported: nfsvers: protocol version for NFS mounting. The value can be 3, 4, 4.0, 4.1, or 4.2.	No	-	This parameter is optional after the -o parameter when the mount command is executed on the host. The value is in list format. If the NFS version is specified for mounting, NFS 3, 4.0, 4.1, and 4.2 protocols are supported (the protocol must be supported and enabled on storage devices). If nfsvers is set to 4, the latest protocol version NFS 4 may be used for mounting due to different OS configurations, for example, 4.2. If the 4.0 protocol is required, you are advised to set nfsvers to 4.0.
mountOptions.proto	Transmission protocol used for NFS mounting. The value can be rdma.	No	-	This parameter is supported by 8.2.0 or later.
mountOptions.port	Protocol port used for NFS mounting.	Conditionally mandatory	-	If the transmission protocol is rdma, set this parameter to 20049.
mountOptions.acl	The DPC namespace supports the ACL function. The DPC client supports POSIX ACL, NFSv4 ACL, and NT ACL authentication.	No	-	The descriptions of acl, aclonlyposix, cnflush, and cflush are for reference only. For details about the parameters, see OceanStor Pacific Series Product Documentation and choose Configuration > Basic Service Configuration Guide for File > Configuring Basic Services (DPC Scenario) > Accessing a DPC Share on a Client > Step 2.
mountOptions.aclonlyposix	The DPC namespace supports POSIX ACL, and the DPC client supports POSIX ACL authentication. The following protocols support POSIX ACL: DPC, NFSv3, and HDFS. If NFSv4 ACL or NT ACL is used, the DPC client cannot identify the ACL of this type. As a result, the ACL of this type does not take effect.	No	-	If aclonlyposix and acl are used together, only acl takes effect. That is, the namespace supports the ACL function.
mountOptions.cnflush	Asynchronous disk flushing mode. That is, data is not flushed to disks immediately when files in the namespace are closed.	No	-	Asynchronous flushing mode: When a file is closed, data in the cache is not flushed to storage media in synchronous mode. Instead, data is written from the cache to the storage media in asynchronous flushing mode. After the write service is complete, data is flushed from the cache to disks periodically based on the flushing period. In a multi-client scenario, if concurrent operations are performed on the same file, the file size update is affected by the disk flushing period. That is, the file size is updated only after the disk flushing is complete. Generally, the update is completed within several seconds. Synchronous I/Os are not affected by the disk flushing period.
mountOptions.cflush	Synchronous disk flushing mode. That is, data is flushed to disks immediately when files in the namespace are closed.	No	-	By default, the synchronous disk flushing mode is used.

1.3.3 - Block Services

Creating a StorageClass

Prepare a StorageClass configuration file, for example, msc .yaml. For details about the StorageClass configuration, see the following example.
Run the following command to create a StorageClass using the configuration file.
```
kubectl apply -f mysc.yaml
```

Run the following command to view the information about the created StorageClass.

kubectl get sc mysc

The following is an example of the command output.

NAME   PROVISIONER      RECLAIMPOLICY   VOLUMEBINDINGMODE   ALLOWVOLUMEEXPANSION   AGE
mysc   csi.huawei.com   Delete          Immediate           true                   8s

Block StorageClass Configuration Example

If LUNs are used as storage resources and the file system needs to be formatted to a local file system, refer to the following example.

kind: StorageClass
apiVersion: storage.k8s.io/v1
metadata:
  name: mysc
provisioner: csi.huawei.com
parameters:
  backend: lun-181
  pool: StoragePool001
  volumeType: lun
  allocType: thin
  fsType: ext4

StorageClass Parameters Supported by Block Services

Table 1 StorageClass configuration parameters

Parameter	Description	Mandatory	Default Value	Whether the Volume Management Takes Effect	Remarks
metadata.name	User-defined name of a StorageClass object.	Yes	-	Yes	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.
provisioner	Name of the provisioner.	Yes	csi.huawei.com	Yes	Set this parameter to the driver name set during Huawei CSI installation. The value is the same as that of driverName in the values.yaml file.
reclaimPolicy	Reclamation policy. The following types are supported: Delete: Resources are automatically reclaimed. Retain: Resources are manually reclaimed.	No	Delete	Yes	Delete: When a PV/PVC is deleted, resources on the storage device are also deleted. Retain: When a PV/PVC is deleted, resources on the storage device are not deleted.
allowVolumeExpansion	Whether to allow volume expansion. If this parameter is set to true, the capacity of the PV that uses the StorageClass can be expanded.	No	false	Yes	This function can only be used to expand PV capacity but cannot be used to reduce PV capacity.
mountOptions	List of mount parameters, which can be used to specify the parameters of the -o option when the mount command is executed on a host.	No	-	Yes	For details about common parameters in mountOptions, see Table 2. You can also specify other mount parameters.
parameters.backend	Name of the backend where the resource to be created is located. This field must be set if parameters.pool is set.	Conditionally mandatory	-	No	If this parameter is not set, Huawei CSI will randomly select a backend that meets the capacity requirements to create resources. You are advised to specify a backend to ensure that the created resource is located on the expected backend.
parameters.pool	Name of the storage resource pool where the resource to be created is located.	No	-	No	If this parameter is not set, Huawei CSI will randomly select a storage pool that meets the capacity requirements from the selected backend to create resources. You are advised to specify a storage pool to ensure that the created resource is located in the expected storage pool.
parameters.volumeType	Type of the volume to be created. The following types are supported: lun: A LUN is provisioned on the storage side. fs: A file system is provisioned on the storage side. dtree: A volume of the Dtree type is provisioned on the storage side.	Yes	-	Yes	The value is fixed to lun.
parameters.allocType	Allocation type of the volume to be created. The following types are supported: thin: Not all required space is allocated during creation. Instead, the space is dynamically allocated based on the usage. thick: All required space is allocated during creation.	No	thin	No	If this parameter is set to thin, the required space is not allocated immediately when a volume is created. Instead, the space is dynamically allocated based on the usage.
parameters.fsType	Type of a host file system. The supported types are: ext2 ext3 ext4 xfs	No	ext4	No	This parameter is available only when volumeMode of the PVC is set to Filesystem.
parameters.qos	LUN/NAS QoS settings of the PV on the storage side. The value of the parameter is JSON character strings in dictionary format. A character string is enclosed by single quotation marks and the dictionary key by double quotation marks. Example: '{"maxMBPS": 999, "maxIOPS": 999}'	No	-	No	For details about the supported QoS configurations, see Table 3.
parameters.fsPermission	Permission on the directory mounted to a container.	No	-	No	For details about the configuration format, refer to the Linux permission settings, for example, 777 and 755.
parameters.disableVerifyCapacity	Whether to disable volume capacity verification. After this function is disabled, the system will not verify whether the volume capacity is an integer multiple of the sector size. The value can be: "true": disables volume capacity verification. "false": enables volume capacity verification. NOTICE: When Red Hat OpenShift Virtualization is used to connect to CSI, this parameter must be set to true.	No	"true"	Yes	For OceanStor Pacific SAN, the sector size is 1 MiB.

Table 2 Common parameters in mountOptions

Parameter	Description	Mandatory	Default Value	Remarks
mountOptions.discard	Automatically triggers the Trim or Discard operation when a file system is mounted. This operation instructs a block device to release unused blocks.	No	-	The xfs and ext4 file systems are supported.

Table 3 Supported QoS configurations

Parameter	Description	Remarks
maxMBPS	Maximum bandwidth. This is a restriction policy parameter.	This parameter is mandatory. The value is an integer greater than 0, expressed in MB/s. For details about the maximum value, see the actual limit of the storage device. For example, the maximum value of OceanStor Pacific NAS is 1073741824.
maxIOPS	Maximum IOPS. This is a restriction policy parameter.	This parameter is mandatory. The value is an integer greater than 0. For details about the maximum value, see the actual limit of the storage device. For example, the maximum value of OceanStor Pacific NAS is 1073741824000.

1.4 - Mass Storage (OceanDisk Series)

1.4.1 - File System

Creating a StorageClass

Prepare a StorageClass configuration file, for example, msc .yaml. For details about the StorageClass configuration, see the following example.
Run the following command to create a StorageClass using the configuration file.
```
kubectl apply -f mysc.yaml
```

Run the following command to view the information about the created StorageClass.

kubectl get sc mysc

The following is an example of the command output.

NAME   PROVISIONER      RECLAIMPOLICY   VOLUMEBINDINGMODE   ALLOWVOLUMEEXPANSION   AGE
mysc   csi.huawei.com   Delete          Immediate           true                   8s

NFS Protocol Configuration Example

When a container uses the NFS protocol to connect to file system resources, refer to the following StorageClass configuration example. In this example, NFS version 4.0 is specified for mounting.

kind: StorageClass
apiVersion: storage.k8s.io/v1
metadata:
  name: mysc
provisioner: csi.huawei.com
parameters:
  backend: nfs-nas-181
  pool: StoragePool001
  volumeType: fs
  allocType: thin
  authClient: "*"
mountOptions:
  - nfsvers=4.0 # Specify the version 4.0 for NFS mounting.

StorageClass Parameters Supported by File Systems

Table 1 StorageClass configuration parameters

Parameter	Description	Mandatory	Default Value	Whether the Volume Management Takes Effect	Remarks
metadata.name	User-defined name of a StorageClass object.	Yes	-	Yes	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.
provisioner	Name of the provisioner.	Yes	csi.huawei.com	Yes	Set this parameter to the driver name set during Huawei CSI installation. The value is the same as that of driverName in the values.yaml file.
reclaimPolicy	Reclamation policy. The following types are supported: Delete: Resources are automatically reclaimed. Retain: Resources are manually reclaimed.	No	Delete	Yes	Delete: When a PV/PVC is deleted, resources on the storage device are also deleted. Retain: When a PV/PVC is deleted, resources on the storage device are not deleted.
allowVolumeExpansion	Whether to allow volume expansion. If this parameter is set to true, the capacity of the PV that uses the StorageClass can be expanded.	No	false	Yes	This function can only be used to expand PV capacity but cannot be used to reduce PV capacity.
mountOptions	List of mount parameters, which can be used to specify the parameters of the -o option when the mount command is executed on a host.	No	-	Yes	For details about common parameters in mountOptions, see Table 2. You can also specify other mount parameters.
parameters.backend	Name of the backend where the resource to be created is located. This field must be set if parameters.pool is set.	Conditionally mandatory	-	No	If this parameter is not set, Huawei CSI will randomly select a backend that meets the capacity requirements to create resources. You are advised to specify a backend to ensure that the created resource is located on the expected backend.
parameters.pool	Name of the storage resource pool where the resource to be created is located.	No	-	No	If this parameter is not set, Huawei CSI will randomly select a storage pool that meets the capacity requirements from the selected backend to create resources. You are advised to specify a storage pool to ensure that the created resource is located in the expected storage pool.
parameters.volumeName	Name of the storage resource created by dynamic volume provisioning. You can configure a placeholder to customize the storage resource name. The following placeholders are supported: PVC namespace: {{ .PVCNamespace }} PVC name: {{ .PVCName }}	No	-	No	The value can contain letters, digits, hyphens (-), underscores (_), and periods (.). It cannot be left empty. The length of the expanded placeholder ranges from 1 to 255 characters. Both the PVC namespace and PVC name must be configured. To avoid duplicate resource names, the PVC UID is added to the end of the name as a unique identifier by default. Configuration example: PVC namespace: namespace. PVC name: pvc-1. PVC UID: c2fd3f46-bf17-4a7d-b88e-2e3232bae434. volumeName is set to prefix-{{ .PVCNamespace }}_{{ .PVCName }}. The ultimate storage resource name is prefix-namespace_pvc-1-c2fd3f46bf174a7db88e2e3232bae434.
parameters.volumeType	Type of the volume to be created. The following types are supported: lun: A LUN is provisioned on the storage side. fs: A file system is provisioned on the storage side. dtree: A volume of the Dtree type is provisioned on the storage side.	Yes	-	Yes	The value is fixed to fs.
parameters.allocType	Allocation type of the volume to be created. The following types are supported: thin: Not all required space is allocated during creation. Instead, the space is dynamically allocated based on the usage.	No	thin	No	If this parameter is set to thin, the required space is not allocated immediately when a volume is created. Instead, the space is dynamically allocated based on the usage.
parameters.authClient	IP address of the NFS client that can access the volume. You can enter the client host name (a full domain name is recommended), client IP address, or client IP address segment.	Yes	-	No	The asterisk () can be used to indicate any client. If you are not sure about the IP address of the access client, you are advised to use the asterisk () to prevent the client access from being rejected by the storage system. If the client host name is used, you are advised to use the full domain name. The IP addresses can be IPv4 addresses, IPv6 addresses, or a combination of IPv4 and IPv6 addresses. You can enter multiple host names, IP addresses, or IP address segments and separate them with semicolons (;). Example: 192.168.0.10;192.168.0.0/24;myserver1.test
parameters.cloneSpeed	Cloning speed. The value ranges from 1 to 4.	No	3	No	4 indicates the highest speed. This parameter takes effect when a PV is cloned or a PV is created using a snapshot.
parameters.applicationType	Application type name when a file system is created.	No	-	Yes	Log in to DeviceManager and choose Services > File Service > File Systems > Create to obtain the application type name.
parameters.qos	QoS settings of the file system on the storage side of the PV. The value of the parameter is JSON character strings in dictionary format. A character string is enclosed by single quotation marks and the dictionary key by double quotation marks. Example: '{"maxMBPS": 999, "maxIOPS": 999}'	No	-	No	For details about the supported QoS configurations, see Table 3.
parameters.fsPermission	Permission on the directory mounted to a container.	No	-	No	For details about the configuration format, refer to the Linux permission settings, for example, 777 and 755.
parameters.rootSquash	Controls the root permission of the client. The value can be: root_squash: The client cannot access the storage system as user root. If a client accesses the storage system as user root, the client will be mapped as an anonymous user. no_root_squash: A client can access the storage system as user root and has the permission of user root.	No	-	No
parameters.allSquash	Whether to retain the user ID (UID) and group ID (GID) of a shared directory. The value can be: all_squash: The UID and GID of the shared directory are mapped to anonymous users. no_all_squash: The UID and GID of the shared directory are retained.	No	-	No
parameters.accesskrb5	Configures the krb5 security protocol. read_only: read-only read_write: read and write none: no permission	No	-	No	During mounting, you can specify the sec parameter in mountOptions.
parameters.accesskrb5i	Configures the krb5i security protocol. read_only: read-only read_write: read and write none: no permission	No	-	No	During mounting, you can specify the sec parameter in mountOptions.
parameters.accesskrb5p	Configures the krb5p security protocol. read_only: read-only read_write: read and write none: no permission	No	-	No	During mounting, you can specify the sec parameter in mountOptions.
parameters.snapshotDirectoryVisibility	Whether the snapshot directory is visible. The value can be: visible: The snapshot directory is visible. invisible: The snapshot directory is invisible.	No	-	No	Only NAS storage is supported.
parameters.reservedSnapshotSpaceRatio	Configures reserved snapshot space. Value type: character string Value range: 0 to 50	No	-	No	-
parameters.disableVerifyCapacity	Whether to disable volume capacity verification. After this function is disabled, the system will not verify whether the volume capacity is an integer multiple of the sector size. The value can be: "true": disables volume capacity verification. "false": enables volume capacity verification. NOTICE: When Red Hat OpenShift Virtualization is used to connect to CSI, this parameter must be set to true.	No	"true"	Yes	For OceanDisk, the sector size is 512 bytes.
parameters.description	Description of the file system to be created. Value type: character string The value contains 0 to 255 characters.	No	-	No
parameters.advancedOptions	Advanced volume creation parameters. The value of the parameter is JSON character strings in dictionary format. A character string is enclosed by single quotation marks and the dictionary key by double quotation marks. Example: '{"CAPACITYTHRESHOLD": 90}'	No	-	No	For details about the supported advanced parameters, see Table 4.

Table 2 Common parameters in mountOptions

Parameter	Description	Mandatory	Default Value	Remarks
mountOptions.nfsvers	NFS mount option on the host. The following mount option is supported: nfsvers: protocol version for NFS mounting. The value can be 3 or 4.0.	No	-	This parameter is optional after the -o parameter when the mount command is executed on the host. The value is in list format. If the NFS version is specified for mounting, NFS 3 and 4.0 protocols are supported (the protocol must be supported and enabled on storage devices).
mountOptions.sec	Kerberos 5 protocol for mounting NFS file systems.	No	-	If Kerberos 5 is used, set this parameter to krb5. If Kerberos 5i is used, set this parameter to krb5i. If Kerberos 5p is used, set this parameter to krb5p. Only NFS 4.0 supports Kerberos.
mountOptions.proto	Transmission protocol used for NFS mounting. The value can be rdma.	No	-	-
mountOptions.port	Protocol port used for NFS mounting.	Conditionally mandatory	-	If the transmission protocol is rdma, set this parameter to 20049.

Table 3 Supported QoS configurations

Storage Type	Parameter	Description	Remarks
OceanStor V5	IOTYPE	Read/write type.	This parameter is optional. If it is not specified, the default value of the storage backend is used. For details, see related storage documents. The value can be: 0: read I/O 1: write I/O 2: read and write I/Os
	MAXBANDWIDTH	Maximum bandwidth. This is a restriction policy parameter.	The value is an integer greater than 0, expressed in MB/s.
	MINBANDWIDTH	Minimum bandwidth. This is a protection policy parameter.	The value is an integer greater than 0, expressed in MB/s.
	MAXIOPS	Maximum IOPS. This is a restriction policy parameter.	The value is an integer greater than 0.
	MINIOPS	Minimum IOPS. This is a protection policy parameter.	The value is an integer greater than 0.
	LATENCY	Maximum latency. This is a protection policy parameter.	The value is an integer greater than 0, expressed in ms.
OceanStor Dorado/OceanStor	IOTYPE	Read/write type.	The value can be: 2: read and write I/Os
	MAXBANDWIDTH	Maximum bandwidth. This is a restriction policy parameter.	The value is an integer ranging from 1 to 999999999, expressed in MB/s.
	MINBANDWIDTH	Minimum bandwidth. This is a protection policy parameter.	The value is an integer ranging from 1 to 999999999, expressed in MB/s.
	MAXIOPS	Maximum IOPS. This is a restriction policy parameter.	The value is an integer ranging from 100 to 999999999.
	MINIOPS	Minimum IOPS. This is a protection policy parameter.	The value is an integer ranging from 100 to 999999999.
	LATENCY	Maximum latency. This is a protection policy parameter.	The value can be 0.5 or 1.5, expressed in ms.

Table 4 Supported advanced volume creation parameters

Parameter	Description	Remarks
CAPACITYTHRESHOLD	Total capacity alarm threshold.	Parameter type: uint64. For details about the default value and value range, see the corresponding storage product manual.

Parameter

Description

Remarks

CAPACITYTHRESHOLD

Total capacity alarm threshold.

Parameter type: uint64.

For details about the default value and value range, see the corresponding storage product manual.

1.4.2 - Block Services

Creating a StorageClass

Prepare a StorageClass configuration file, for example, msc .yaml. For details about the StorageClass configuration, see the following example.
Run the following command to create a StorageClass using the configuration file.
```
kubectl apply -f mysc.yaml
```

Run the following command to view the information about the created StorageClass.

kubectl get sc mysc

The following is an example of the command output.

NAME   PROVISIONER      RECLAIMPOLICY   VOLUMEBINDINGMODE   ALLOWVOLUMEEXPANSION   AGE
mysc   csi.huawei.com   Delete          Immediate           true                   8s

Block StorageClass Configuration Example

If LUNs are used as storage resources and the file system needs to be formatted to a local file system, refer to the following example.

kind: StorageClass
apiVersion: storage.k8s.io/v1
metadata:
  name: mysc
provisioner: csi.huawei.com
parameters:
  backend: lun-181
  pool: StoragePool001
  volumeType: lun
  allocType: thin
  fsType: ext4

StorageClass Parameters Supported by Block Services

Table 1 StorageClass configuration parameters

Parameter	Description	Mandatory	Default Value	Whether the Volume Management Takes Effect	Remarks
metadata.name	User-defined name of a StorageClass object.	Yes	-	Yes	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.
provisioner	Name of the provisioner.	Yes	csi.huawei.com	Yes	Set this parameter to the driver name set during Huawei CSI installation. The value is the same as that of driverName in the values.yaml file.
reclaimPolicy	Reclamation policy. The following types are supported: Delete: Resources are automatically reclaimed. Retain: Resources are manually reclaimed.	No	Delete	Yes	Delete: When a PV/PVC is deleted, resources on the storage device are also deleted. Retain: When a PV/PVC is deleted, resources on the storage device are not deleted.
allowVolumeExpansion	Whether to allow volume expansion. If this parameter is set to true, the capacity of the PV that uses the StorageClass can be expanded.	No	false	Yes	This function can only be used to expand PV capacity but cannot be used to reduce PV capacity.
mountOptions	List of mount parameters, which can be used to specify the parameters of the -o option when the mount command is executed on a host.	No	-	Yes	For details about common parameters in mountOptions, see Table 2. You can also specify other mount parameters.
parameters.backend	Name of the backend where the resource to be created is located. This field must be set if parameters.pool is set.	Conditionally mandatory	-	No	If this parameter is not set, Huawei CSI will randomly select a backend that meets the capacity requirements to create resources. You are advised to specify a backend to ensure that the created resource is located on the expected backend.
parameters.pool	Name of the storage resource pool where the resource to be created is located.	No	-	No	If this parameter is not set, Huawei CSI will randomly select a storage pool that meets the capacity requirements from the selected backend to create resources. You are advised to specify a storage pool to ensure that the created resource is located in the expected storage pool.
parameters.volumeType	Type of the volume to be created. The following types are supported: lun: A LUN is provisioned on the storage side. fs: A file system is provisioned on the storage side. dtree: A volume of the Dtree type is provisioned on the storage side.	Yes	-	Yes	The value is fixed to lun.
parameters.allocType	Allocation type of the volume to be created. The following types are supported: thin: Not all required space is allocated during creation. Instead, the space is dynamically allocated based on the usage. thick: All required space is allocated during creation.	No	thin	No	If this parameter is set to thin, the required space is not allocated immediately when a volume is created. Instead, the space is dynamically allocated based on the usage. OceanStor Dorado does not support thick.
parameters.fsType	Type of a host file system. The supported types are: ext2 ext3 ext4 xfs	No	ext4	No	This parameter is available only when volumeMode of the PVC is set to Filesystem.
parameters.cloneSpeed	Cloning speed. The value ranges from 1 to 4.	No	3	No	4 indicates the highest speed. This parameter takes effect when you clone a PVC or create a PVC from a snapshot.
parameters.applicationType	Application type name of the LUN to be created.	No	-	Yes	Log in to DeviceManager and choose Services > Block Service > LUN Groups (or Namespace Groups) > LUNs (or Namespaces) > Create to obtain the application type name.
parameters.qos	LUN/NAS QoS settings of the PV on the storage side. The value of the parameter is JSON character strings in dictionary format. A character string is enclosed by single quotation marks and the dictionary key by double quotation marks. Example: '{"maxMBPS": 999, "maxIOPS": 999}'	No	-	No	For details about the supported QoS configurations, see Table 3.
parameters.fsPermission	Permission on the directory mounted to a container.	No	-	No	For details about the configuration format, refer to the Linux permission settings, for example, 777 and 755.
parameters.disableVerifyCapacity	Whether to disable volume capacity verification. After this function is disabled, the system will not verify whether the volume capacity is an integer multiple of the sector size. The value can be: "true": disables volume capacity verification. "false": enables volume capacity verification. NOTICE: When Red Hat OpenShift Virtualization is used to connect to CSI, this parameter must be set to true.	No	"true"	Yes	For OceanDisk, the sector size is 512 bytes.
parameters.description	Description of the LUN to be created. Value type: character string The value contains 0 to 255 characters.	No	-	No

Table 2 Common parameters in mountOptions

Parameter	Description	Mandatory	Default Value	Remarks
mountOptions.discard	Automatically triggers the Trim or Discard operation when a file system is mounted. This operation instructs a block device to release unused blocks.	No	-	The xfs and ext4 file systems are supported.

Table 3 Supported QoS configurations

Parameter	Description	Remarks
IOTYPE	Read/write type.	The value can be: 2: read and write I/Os
MAXBANDWIDTH	Maximum bandwidth. This is a restriction policy parameter.	The value is an integer ranging from 1 to 999999999, expressed in MB/s.
MINBANDWIDTH	Minimum bandwidth. This is a protection policy parameter.	The value is an integer ranging from 1 to 999999999, expressed in MB/s.
MAXIOPS	Maximum IOPS. This is a restriction policy parameter.	The value is an integer ranging from 100 to 999999999.
MINIOPS	Minimum IOPS. This is a protection policy parameter.	The value is an integer ranging from 100 to 999999999.
LATENCY	Maximum latency. This is a protection policy parameter.	The value can be 0.5 or 1.5, expressed in ms.

2 - Managing a StorageClass

2.1 - Querying a StorageClass

Run the following command to view the information about the created StorageClass.

kubectl get sc mysc

The following is an example of the command output.

NAME   PROVISIONER      RECLAIMPOLICY   VOLUMEBINDINGMODE   ALLOWVOLUMEEXPANSION   AGE
mysc   csi.huawei.com   Delete          Immediate           true                   8s

2.2 - Modifying a StorageClass

Kubernetes allows only the allowVolumeExpansion field of a StorageClass to be modified. The modification method is as follows:

Run the following command to check whether the StorageClass can be expanded:

kubectl get sc mysc

If the command output is displayed as the following example, the StorageClass mysc cannot be expanded:

NAME   PROVISIONER      RECLAIMPOLICY   VOLUMEBINDINGMODE   ALLOWVOLUMEEXPANSION   AGE
mysc   csi.huawei.com   Delete          Immediate           false                  8s

Run the following command to enable capacity expansion for the StorageClass:
```
kubectl patch sc mysc --patch '{"allowVolumeExpansion":true}'
```

Check the StorageClass again and ensure that the modification is successful.

NAME   PROVISIONER      RECLAIMPOLICY   VOLUMEBINDINGMODE   ALLOWVOLUMEEXPANSION   AGE
mysc   csi.huawei.com   Delete          Immediate           true                   8s

2.3 - Deleting a StorageClass

Run the following command to view the StorageClass:

kubectl get sc mysc

The following is an example of the command output.

NAME   PROVISIONER      RECLAIMPOLICY   VOLUMEBINDINGMODE   ALLOWVOLUMEEXPANSION   AGE
mysc   csi.huawei.com   Delete          Immediate           false                  8s

Run the following command to delete the StorageClass:
```
kubectl delete sc mysc
```
If the following information is displayed, the deletion is successful:
```
storageclass.storage.k8s.io "mysc" deleted
```