Using an EVS Disk Through a Dynamic PV

Prerequisites

• You have created a cluster and installed the CCE Container Storage (Everest) add-on in the cluster.
• To create a cluster using commands, ensure kubectl is used. For details, see Accessing a Cluster Using kubectl.

Notes and Constraints

• EVS disks cannot be attached across AZs and cannot be used by multiple workloads, multiple pods of the same workload, or multiple tasks. Data sharing of a shared disk is not supported between nodes in a CCE cluster. If an EVS disk is attached to multiple nodes, I/O conflicts and data cache conflicts may occur. Therefore, select only one pod when creating a Deployment that uses EVS disks.
• For clusters earlier than v1.19.10, if an HPA policy is used to scale out a workload with EVS volumes mounted, the existing pods cannot be read or written when a new pod is scheduled to another node.

  For clusters of v1.19.10 and later, if an HPA policy is used to scale out a workload with EVS volumes mounted, a new pod cannot be started because EVS disks cannot be attached.

• Resource tags can be added to dynamically created EVS disks. After the EVS disks are created, the resource tags cannot be updated on CCE. To update them, go to the EVS console. If you use an existing EVS disk to create a PV, you also need to add or update resource tags on the EVS console.

Automatically Creating an EVS Disk on the Console

1. Log in to the CCE console and click the cluster name to access the cluster console.
2. Dynamically create a PVC and PV.
   1. Choose Storage in the navigation pane. In the right pane, click the PVCs tab. Click Create PVC in the upper right corner. In the dialog box displayed, configure PVC parameters.

      Parameter	Description
      PVC Type	In this example, select EVS.
      PVC Name	Enter the PVC name, which must be unique in a namespace.
      Creation Method	If no underlying storage is available, select Dynamically provision to create a PVC, PV, and underlying storage on the console in cascading mode. If underlying storage is available, create a PV or use an existing PV to statically create a PVC. For details, see Using an Existing EVS Disk Through a Static PV. In this example, select Dynamically provision.
      Storage Classes	The default StorageClasses for EVS disks are csi-disk and csi-disk-topology. NOTE: If you use the csi-disk (EVS) StorageClass, a PVC and PV will be created immediately. The EVS disk is created with the PV, and then the PVC is bound to the PV. If you use the csi-disk-topology (EVS created with a delay) StorageClass, a PV will not be immediately created when a PVC is created. Instead, the pods that will be associated with the PVC are scheduled first, and then the EVS disk and PV are created, and finally the PV is bound to the PVC. You can customize a StorageClass and configure its reclaim policy and binding mode. For details, see Creating a StorageClass Using the CCE Console.
      (Optional) Storage Volume Name Prefix	Available only when the cluster version is v1.23.14-r0, v1.25.9-r0, v1.27.6-r0, v1.28.4-r0, or later, and Everest of v2.4.15 or later is installed in the cluster. This parameter specifies the name of the underlying storage that is automatically created. The actual underlying storage name is in the format of "Storage volume name prefix + PVC UID". If this parameter is left blank, the default prefix pvc will be used. For example, if the storage volume name prefix is set to test, the actual underlying storage name is test-{UID}.
      AZ	Select the AZ of the EVS disk. The AZ must be the same as that of the cluster node. NOTE: An EVS disk can only be mounted to a node in the same AZ. After an EVS disk is created, its AZ cannot be changed.
      Disk Type	Select an EVS disk type. EVS disk types vary depending on regions. Obtain the available EVS types on the console.
      Capacity (GiB)	Capacity of the requested storage volume.
      Access Mode	EVS volumes support only ReadWriteOnce, indicating that a storage volume can be mounted to one node in read/write mode. For details, see Volume Access Modes.
      Encryption	Configure whether to encrypt underlying storage. If you select Enabled (key), an encryption key must be configured. Before using encryption, check whether the region where the EVS disk is located supports disk encryption.
      Enterprise Project	The default enterprise project, the enterprise project to which the cluster belongs, or the enterprise project specified by StorageClass is available.
      Resource Tag	You can add resource tags to classify resources, which is supported only when the Everest version in the cluster is 2.1.39 or later. You can create predefined tags on the TMS console. These tags are available to all resources that support tags. You can use these tags to improve the tag creation and resource migration efficiency. CCE automatically creates system tags CCE-Cluster-ID={Cluster ID}, CCE-Cluster-Name={Cluster name}, and CCE-Namespace={Namespace name}. These tags cannot be modified. NOTE: After a dynamic PV of the EVS type is created, the resource tags cannot be updated on the CCE console. To update these resource tags, go to the EVS console.

   2. Click Create.

      You can choose Storage in the navigation pane and view the created PVC and PV on the PVCs and PVs tab pages, respectively.

3. Create an application.
   1. Choose Workloads in the navigation pane. In the right pane, click the StatefulSets tab.
   2. Click Create Workload in the upper right corner. On the displayed page, click Data Storage in the Container Information area under Container Settings and choose Add Volume > PVC.

      Mount and use storage volumes, as shown in Table 1. For details about other parameters, see Workloads.

      Table 1 Mounting a storage volume

      Parameter	Description
      PVC	Select an existing EVS volume. An EVS volume can be mounted to only one workload.
      Mount Path	Enter a mount path, for example, /tmp. This parameter specifies a container path to which a data volume will be mounted. Do not mount the volume to a system directory such as / or /var/run. This may lead to container errors. Mount the volume to an empty directory. If the directory is not empty, ensure that there are no files that affect container startup. Otherwise, the files will be replaced, leading to container startup failures or workload creation failures. NOTICE: If a volume is mounted to a high-risk directory, use an account with minimum permissions to start the container. Otherwise, high-risk files on the host may be damaged.
      Subpath	Enter the subpath of the storage volume and mount a path in the storage volume to the container. In this way, different folders of the same storage volume can be used in a single pod. tmp, for example, indicates that data in the mount path of the container is stored in the tmp folder of the storage volume. If this parameter is left blank, the root path will be used by default.
      Permission	Read-only: You can only read the data in the mounted volumes. Read-write: You can modify the data volumes mounted to the path. Newly written data will not be migrated if the container is migrated, which may cause data loss.

      In this example, the disk is mounted to the /data path of the container. The container data generated in this path is stored in the EVS disk.

      Note

      A non-shared EVS disk can be attached to only one workload pod. If there are multiple pods, extra pods cannot start properly. Ensure that the number of workload pods is 1 if an EVS disk is attached.

   3. After the configuration, click Create Workload.

      After the workload is created, the data in the container mount directory will be persistently stored. Verify the storage by referring to Verifying Data Persistence.

Automatically Creating an EVS Volume Through kubectl

1. Use kubectl to access the cluster.
2. Use StorageClass to dynamically create a PVC and PV.
   1. Create the pvc-evs-auto.yaml file.

      apiVersion: v1
      kind: PersistentVolumeClaim
      metadata:
        name: pvc-evs-auto
        namespace: default
        annotations:
            everest.io/disk-volume-type: SAS    # EVS disk type
          everest.io/crypt-key-id: <your_key_id>    # (Optional) Encryption key ID. Mandatory for an encrypted disk.
          everest.io/enterprise-project-id: <your_project_id>  # (Optional) Enterprise project ID
          everest.io/disk-volume-tags: '{"key1":"value1","key2":"value2"}' # (Optional) Custom resource tags
      
          everest.io/csi.volume-name-prefix: test  # (Optional) Storage volume name prefix of the automatically created underlying storage
        labels:
          failure-domain.beta.kubernetes.io/region: <your_region>   # Region of the node where the application is to be deployed
          failure-domain.beta.kubernetes.io/zone: <your_zone>       # AZ of the node where the application is to be deployed
      spec:
        accessModes:
        - ReadWriteOnce               # The value must be ReadWriteOnce for EVS disks.
        resources:
          requests:
            storage: 10Gi             # EVS disk capacity, ranging from 1 to 32768
        storageClassName: csi-disk    # The StorageClass is EVS.
      
      

      Table 2 Key parameters

      Parameter	Mandatory	Description
      failure-domain.beta.kubernetes.io/region	Yes	Region where the cluster is located. For details about its value, see Regions and Endpoints.
      failure-domain.beta.kubernetes.io/zone	Yes	AZ where the EVS volume is created. It must be the same as the AZ planned for the workload. For details about its value, see Regions and Endpoints.
      everest.io/disk-volume-type	Yes	EVS disk type. All letters are in uppercase. SAS: high I/O SSD: ultra-high I/O ESSD: extreme SSD
      everest.io/crypt-key-id	No	This parameter is mandatory when an EVS disk is encrypted. Enter the encryption key ID selected during EVS disk creation. You can use a custom key or the default key named evs/default. To obtain a key ID, log in to the DEW console, locate the key to be encrypted, and copy the key ID.
      everest.io/enterprise-project-id	No	Enterprise project ID of the EVS disk. This parameter is optional. To obtain an enterprise project ID, log in to the EPS console, click the name of the target enterprise project, and copy the enterprise project ID.
      everest.io/disk-volume-tags	No	(Optional) This parameter is supported when the Everest version in the cluster is 2.1.39 or later. You can add resource tags to classify resources. You can create predefined tags on the TMS console. These tags are available to all resources that support tags. You can use these tags to improve the tag creation and resource migration efficiency. CCE automatically creates system tags CCE-Cluster-ID={Cluster ID}, CCE-Cluster-Name={Cluster name}, and CCE-Namespace={Namespace name}. These tags cannot be modified.
      everest.io/csi.volume-name-prefix	No	(Optional) This parameter is available only when the cluster version is v1.23.14-r0, v1.25.9-r0, v1.27.6-r0, v1.28.4-r0, or later, and Everest of v2.4.15 or later is installed in the cluster. This parameter specifies the name of the underlying storage that is automatically created. The actual underlying storage name is in the format of "Storage volume name prefix + PVC UID". If this parameter is left blank, the default prefix pvc will be used. Enter 1 to 26 characters that cannot start or end with a hyphen (-). Only lowercase letters, digits, and hyphens (-) are allowed. For example, if the storage volume name prefix is set to test, the actual underlying storage name is test-{UID}.
      storage	Yes	Requested PVC capacity, in Gi. The value is an integer ranging from 1 to 32768. If storage is set to a decimal, the value will be rounded up for the EVS disk. For example, if storage is set to 10.1Gi, an 11-GiB EVS disk will be created.
      storageClassName	Yes	StorageClass name, which is csi-disk for an EVS disk.

   2. Run the following command to create a PVC:

      kubectl apply -f pvc-evs-auto.yaml
      
      

3. Create an application.
   1. Create a file named web-evs-auto.yaml. In this example, the EVS volume is mounted to the /data path.

      apiVersion: apps/v1
      kind: StatefulSet
      metadata:
        name: web-evs-auto
        namespace: default
      spec:
        replicas: 1
        selector:
          matchLabels:
            app: web-evs-auto
        serviceName: web-evs-auto   # Headless Service name
        template:
          metadata:
            labels:
              app: web-evs-auto
          spec:
            containers:
            - name: container-1
              image: nginx:latest
              volumeMounts:
              - name: pvc-disk    # Volume name, which must be the same as the volume name in the volumes field
                mountPath: /data  # Location where the storage volume is mounted
            imagePullSecrets:
              - name: default-secret
            volumes:
              - name: pvc-disk    # Volume name, which can be customized
                persistentVolumeClaim:
                  claimName: pvc-evs-auto    # Name of the created PVC
      ---
      apiVersion: v1
      kind: Service
      metadata:
        name: web-evs-auto   # Headless Service name
        namespace: default
        labels:
          app: web-evs-auto
      spec:
        selector:
          app: web-evs-auto
        clusterIP: None
        ports:
          - name: web-evs-auto
            targetPort: 80
            nodePort: 0
            port: 80
            protocol: TCP
        type: ClusterIP
      
      

   2. Run the following command to create a workload to which the EVS volume is mounted:

      kubectl apply -f web-evs-auto.yaml
      
      

      After the workload is created, the data in the container mount directory will be persistently stored. Verify the storage by referring to Verifying Data Persistence.

Verifying Data Persistence

1. View the deployed application and EVS volume files.
   1. Run the following command to view the created pod:

      kubectl get pod | grep web-evs-auto
      
      

      Expected output:

      web-evs-auto-0                  1/1     Running   0               38s
      
      

   2. Run the following command to check whether the EVS volume has been mounted to the /data path:

      kubectl exec web-evs-auto-0 -- df | grep data
      
      

      Expected output:

      /dev/sdc              10255636     36888  10202364   0% /data
      
      

   3. Run the following command to check the files in the /data path:

      kubectl exec web-evs-auto-0 -- ls /data
      
      

      Expected output:

      lost+found
      
      

2. Run the following command to create a file named static in the /data path:

   kubectl exec web-evs-auto-0 --  touch /data/static
   
   

3. Run the following command to check the files in the /data path:

   kubectl exec web-evs-auto-0 -- ls /data
   
   

   Expected output:

   lost+found
   static
   
   

4. Run the following command to delete the pod named web-evs-auto-0:

   kubectl delete pod web-evs-auto-0
   
   

   Expected output:

   pod "web-evs-auto-0" deleted
   
   

5. After the deletion, the StatefulSet controller automatically creates a replica with the same name. Run the following command to check whether the files in the /data path have been modified:

   kubectl exec web-evs-auto-0 -- ls /data
   
   

   Expected output:

   lost+found
   static
   
   

   The static file is retained, indicating that the data in the EVS volume can be stored persistently.

Related Operations

You can also perform the operations listed in Table 3.