Container Service for Kubernetes:Use dynamically provisioned NAS volumes

kubectl

1. Modify the following YAML content and save it as alicloud-nas-subpath.yaml.

   apiVersion: storage.k8s.io/v1
   kind: StorageClass
   metadata:
     name: alicloud-nas-subpath
   mountOptions:
   - nolock,tcp,noresvport
   - vers=3
   parameters:
     volumeAs: subpath
     server: "0cd8b4a576-g****.cn-hangzhou.nas.aliyuncs.com:/k8s"
     archiveOnDelete: "true"
   provisioner: nasplugin.csi.alibabacloud.com
   reclaimPolicy: Retain
   allowVolumeExpansion: true

   Parameter		Description
   mountOptions		The mount options for the NAS volume, including the NFS protocol version. By default, the NFSv3 protocol is used for mounting. You can specify the protocol version, for example, vers=4.0. For more information about the NFS protocols supported by different NAS types, see NFS protocol.
   parameters	volumeAs	The mount method. In this example, the value is set to subpath to create a subdirectory-type PV. One PV corresponds to one subdirectory in a NAS file system.
   	server	The address of the mount target and the subdirectory of the NAS file system to mount. The format is <NAS mount target address>:<mount directory>. If you do not specify a subdirectory, the root directory / is mounted by default.
   	archiveOnDelete	Specifies whether to delete the backend storage data when reclaimPolicy is set to Delete. This parameter is added for confirmation because NAS is a shared storage service. true (default): The directory or file is retained and is renamed to archived-{pvName}.{timestamp}. false: The backend storage resource is permanently deleted. Note For high-traffic workloads, setting this parameter to false is not recommended. For more information, see The task queue of the controller is full and no new PVs can be created when you use a dynamically provisioned NAS volume. To completely delete the backend storage data, you must set parameters.archiveOnDelete to false using kubectl.
   provisioner		The driver type. The value must be set to nasplugin.csi.alibabacloud.com, which indicates that the Alibaba Cloud NAS CSI plug-in is used.
   reclaimPolicy		The PV reclaim policy. The default value is Delete. Retain is also supported. Delete: This value must be used with archiveOnDelete. When archiveOnDelete is true, the files in the NAS file system are renamed but not deleted when the PVC is deleted. When archiveOnDelete is false, the files in the NAS file system are deleted when the PVC is deleted. Important The subpath directory and its files in the NAS file system will be deleted. The NAS file system itself is retained. To delete the NAS file system, see Delete a file system. Retain: When the PVC is deleted, the PV and the files in the NAS file system are retained. You must manually delete them. If data security is a high priority, we recommend that you set this parameter to Retain to prevent accidental data loss.
   allowVolumeExpansion		This parameter is supported only for General-purpose NAS file systems. If you enable this parameter, a directory quota is configured for the PV that is dynamically created by the StorageClass to limit the available capacity. You can also update the PVC to expand the volume capacity. For more information, see Set directory quotas for dynamically provisioned NAS volumes. Note The NAS quota takes effect asynchronously. After a PV is dynamically created, the directory quota may not take effect immediately. If you write a large amount of data in a short period, the storage usage may exceed the capacity limit. For more information about NAS directory quotas, see Directory quotas.

2. Create the StorageClass.

   kubectl create -f alicloud-nas-subpath.yaml

Console

1. Log on to the ACK console. In the left navigation pane, click Clusters.

2. On the Clusters page, click the name of the target cluster. In the navigation pane on the left, choose Storage > StorageClasses.

3. On the StorageClasses page, click Create.

4. In the Create dialog box, configure the StorageClass parameters and click Create.

   The following are the main configuration items.

   Configuration item	Description	Example value
   Name	The name of the StorageClass. For more information about the format requirements, see the instructions in the console.	alicloud-nas-subpath
   Persistent Volume Type	Select NAS.	NAS
   Select Mount Target	The address of the NAS file system's mount target.	0cd8b4a576-g****.cn-hangzhou.nas.aliyuncs.com
   Volume Mode	The access mode of the volume. In this example, select Subdirectory to use the subpath method. A unique subdirectory is automatically created under the mount path for each PV. Data is stored at <NAS mount target>:<mount path>/<pv-name>/. Note The Subdirectory mode requires CSI component version 1.31.4 or later. Otherwise, the system defaults to Shared Directory mode.	Subdirectory
   Mount Path	The subdirectory on the NAS file system to mount. If not set, the root directory is mounted by default. If the specified directory does not exist, it will be automatically created and then mounted. Note The root directory is / for a General-purpose NAS file system and /share for an Extreme NAS file system. When you mount a subdirectory on an Extreme NAS file system, the path must start with /share, such as /share/data.	/k8s
   Reclaim Policy	The reclaim policy for the PV. We recommend that you select Retain to prevent accidental data loss. Delete: This parameter must be configured with archiveOnDelete. In the console, selecting Delete does not take effect. This means that the PV and the data on the NAS volume are not deleted when you delete the PVC. This is because the underlying archiveOnDelete parameter cannot be configured through the UI. To configure archiveOnDelete, create the PV using a YAML manifest. For a YAML template, see the kubectl tab. Retain: When the PVC is deleted, the PV and the data on the NAS volume are not deleted. You must manually delete them.	Retain
   Mount Options	The mount options for the NAS volume, including the NFS protocol version. By default, the NFSv3 protocol is used for mounting. You can specify the protocol version, for example, vers=4.0. For more information about the NFS protocols supported by different NAS types, see NFS protocol.	Keep the default value

   After the StorageClass is created, you can view it in the StorageClasses list.

kubectl

1. Modify the YAML content and save it as nas-pvc.yaml.

   kind: PersistentVolumeClaim
   apiVersion: v1
   metadata: 
     name: nas-csi-pvc
   spec:
     accessModes:
     - ReadWriteMany 
     storageClassName: alicloud-nas-subpath
     resources: 
       requests:
         storage: 20Gi

   Parameter	Description
   accessModes	The access mode for the volume. The default value is ReadWriteMany. ReadWriteOnce and ReadOnlyMany are also supported.
   storageClassName	The name of the StorageClass to bind.
   storage	The capacity of the volume that you want to request. Important By default, the actual available capacity of a NAS volume is not limited by this configuration. The capacity is determined by the specifications of the NAS file system. For more information, see General-purpose NAS and Extreme NAS. If you use a General-purpose NAS file system and set allowVolumeExpansion of the StorageClass to true, the CSI component sets a directory quota based on this configuration to limit the available capacity of the NAS volume.

2. Create the PVC.

   kubectl create -f nas-pvc.yaml

3. View the PV.

   kubectl get pvc

   The output shows that the CSI component automatically created a PV based on the StorageClass and bound the PV to the PVC.

   NAME                                       CAPACITY   ACCESS MODES   RECLAIM POLICY   STATUS   CLAIM                 STORAGECLASS             VOLUMEATTRIBUTESCLASS   REASON   AGE
   nas-a7540d97-0f53-4e05-b7d9-557309******   20Gi       RWX            Retain           Bound    default/nas-csi-pvc   alicloud-nas-subpath     <unset>                          5m

Console

1. In the left-side navigation pane of the details page, choose Volumes > Persistent Volume Claims.

2. On the Persistent Volume Claims page, click Create.

3. In the Create PVC dialog box, configure the parameters and click Create.

   Configuration item	Description	Example value
   PVC Type	Select NAS.	NAS
   Name	The name of the PVC. The name must be unique within the namespace.	pvc-nas
   Allocation Mode	In this example, select Use StorageClass.	Use StorageClass
   Existing StorageClass	Click Select StorageClass and select the StorageClass that you created in the preceding step.	alicloud-nas-subpath
   Capacity	The capacity of the volume. This setting does not limit the maximum capacity that the application can use. Important By default, the actual available capacity of a NAS volume is not limited by this configuration. The capacity is determined by the specifications of the NAS file system. For more information, see General-purpose NAS and Extreme NAS. If you use a General-purpose NAS file system and set allowVolumeExpansion of the StorageClass to true, the CSI component sets a directory quota based on this configuration to limit the available capacity of the NAS volume.	20Gi
   Access Mode	The default value is ReadWriteMany. You can also select ReadWriteOnce or ReadOnlyMany.	ReadWriteMany

kubectl

Create two deployments and mount the same PVC to them. This allows them to share the same subdirectory in the same NAS file system.

1. Modify the following YAML content and save the files as nginx-1.yaml and nginx-2.yaml.

   The following YAML templates show that the configurations in nginx-1.yaml and nginx-2.yaml are the same, except for the metadata.name value. The two applications are bound to the same PVC.

   nginx-1.yaml

   apiVersion: apps/v1
   kind: Deployment
   metadata:
     name: nas-test-1     
     labels:
       app: nginx
   spec:
     selector:
       matchLabels:
         app: nginx
     template:
       metadata:
         labels:
           app: nginx
       spec:
         containers:
         - name: nginx
           image: anolis-registry.cn-zhangjiakou.cr.aliyuncs.com/openanolis/nginx:1.14.1-8.6
           ports:
           - containerPort: 80
           volumeMounts:
             - name: nas-pvc
               mountPath: "/data"           # The path where the NAS volume is mounted in the container.
         volumes:
           - name: nas-pvc                 
             persistentVolumeClaim:
               claimName: nas-csi-pvc       # Bind the PVC.

   nginx-2.yaml

   apiVersion: apps/v1
   kind: Deployment
   metadata:
     name: nas-test-2     
     labels:
       app: nginx
   spec:
     selector:
       matchLabels:
         app: nginx
     template:
       metadata:
         labels:
           app: nginx
       spec:
         containers:
         - name: nginx
           image: anolis-registry.cn-zhangjiakou.cr.aliyuncs.com/openanolis/nginx:1.14.1-8.6
           ports:
           - containerPort: 80
           volumeMounts:
             - name: nas-pvc
               mountPath: "/data"           # The path where the NAS volume is mounted in the container.
         volumes:
           - name: nas-pvc                 
             persistentVolumeClaim:
               claimName: nas-csi-pvc       # Bind the PVC.

2. Create the two deployments.

   kubectl create -f nginx-1.yaml -f nginx-2.yaml

3. View pod information.

   kubectl get pod -l app=nginx

   The output indicates that the same subdirectory of the same NAS file system is mounted to different applications.

   NAME                         READY   STATUS    RESTARTS   AGE
   nas-test-1-b75d5b6bc-vqwq9   1/1     Running   0          51s
   nas-test-2-b75d5b6bc-8k9vx   1/1     Running   0          44s

Console

Repeat the following steps to create two deployments that mount the same PVC. This enables them to share a single subdirectory within the NAS file system.

1. In the navigation pane on the left of the cluster details page, go to Workloads > Deployments.

2. On the Deployments page, click Create From Image.

3. Configure the parameters to create the application.

   The following table describes the key parameters. You can keep the default settings for other parameters. For more information, see Create a stateless workload (Deployment).

   Configuration item	Parameter	Description	Example
   Basic Information	Name	Enter a custom name for the deployment. The name must meet the format requirements displayed in the console.	deployment-nas-1
   	Number of Replicas	The number of deployment replicas.	1
   Container Configuration	Image Name	The address of the image used to deploy the application.	anolis-registry.cn-zhangjiakou.cr.aliyuncs.com/openanolis/nginx:1.14.1-8.6
   	Required Resources	The required vCPU and memory resources.	0.25 vCPU, 512 MiB
   	Volume	Click Add PVC and configure the parameters. Mount Source: Select the PVC that you created. Container Path: Specify the container path to which you want to mount the NAS file system.	Mount Source: pvc-nas Container Path: /data

4. View the application deployment status.

   1. On the Stateless page, click the application name.

   2. On the Pods tab, confirm that the pod is in the Running state.

kubectl

Console

1. Log on to the ACK console. In the left navigation pane, click Clusters.

2. On the Clusters page, click the name of the target cluster. In the navigation pane on the left, choose Storage > StorageClasses.

3. On the StorageClasses page, click Create.

4. In the Create dialog box, configure the StorageClass parameters and click Create.

   The main configuration items are described below.

   Configuration item	Description	Example value
   Name	The name of the StorageClass. For more information about the format requirements, see the instructions in the console.	alicloud-nas-sharepath
   PV Type	Select NAS.	NAS
   Select Mount Target	The address of the NAS file system's mount target.	0cd8b4a576-g****.cn-hangzhou.nas.aliyuncs.com
   Volume Mode	The access mode of the volume. In this example, select Shared Directory to use the sharepath method. When a PV is created, no actual directory is created. Instead, the path specified in the StorageClass is used. This means that each PV maps to the same NAS directory. This method is ideal for scenarios where you need to share a directory across namespaces.	Shared Directory
   Mount Path	The subdirectory on the NAS file system to mount. If not set, the root directory is mounted by default. If the specified directory does not exist, it will be automatically created and then mounted. Note The root directory is / for a General-purpose NAS file system and /share for an Extreme NAS file system. When you mount a subdirectory on an Extreme NAS file system, the path must start with /share, such as /share/data.	/sharepath
   Reclaim Policy	When you use the sharepath method, you must set this parameter to Retain.	Retain
   Mount Options	The mount options for the NAS volume, including the NFS protocol version. By default, the NFSv3 protocol is used for mounting. You can specify the protocol version, for example, vers=4.0. For more information about the NFS protocols supported by different NAS types, see NFS protocol.	Keep the default value

   After the StorageClass is created, you can view it in the StorageClasses list.

kubectl

To mount a NAS volume to pods in different namespaces, first create two namespaces.

1. Create the ns1 and ns2 namespaces.

   kubectl create ns ns1
   kubectl create ns ns2

2. Modify the following YAML content and save it as pvc.yaml.

   kind: PersistentVolumeClaim
   apiVersion: v1
   metadata: 
     name: nas-csi-pvc
     namespace: ns1
   spec:
     accessModes:
     - ReadWriteMany 
     storageClassName: alicloud-nas-sharepath
     resources: 
       requests:
         storage: 20Gi
   ---
   kind: PersistentVolumeClaim
   apiVersion: v1
   metadata: 
     name: nas-csi-pvc
     namespace: ns2
   spec:
     accessModes:
     - ReadWriteMany 
     storageClassName: alicloud-nas-sharepath
     resources: 
       requests:
         storage: 20Gi

   Parameter	Description
   accessModes	The access mode for the volume. The default value is ReadWriteMany. ReadWriteOnce and ReadOnlyMany are also supported.
   storageClassName	The name of the StorageClass to bind.
   storage	The capacity of the volume that you want to request. Important By default, the actual available capacity of a NAS volume is not limited by this configuration. The capacity is determined by the specifications of the NAS file system. For more information, see General-purpose NAS and Extreme NAS. If you use a General-purpose NAS file system and set allowVolumeExpansion of the StorageClass to true, the CSI component sets a directory quota based on this configuration to limit the available capacity of the NAS volume.

3. Create the PVCs.

   kubectl create -f pvc.yaml

4. View the PVs.

   kubectl get pv

   The output shows that the CSI component automatically created two PVs based on the StorageClass and bound them to the two PVCs in different namespaces.

   NAME                                       CAPACITY   ACCESS MODES   RECLAIM POLICY   STATUS   CLAIM                 STORAGECLASS             VOLUMEATTRIBUTESCLASS   REASON   AGE
   nas-0b448885-6226-4d22-8a5b-d0768c******   20Gi       RWX            Retain           Bound    ns1/nas-csi-pvc       alicloud-nas-sharepath   <unset>                          74s
   nas-bcd21c93-8219-4a11-986b-fd934a******   20Gi       RWX            Retain           Bound    ns2/nas-csi-pvc       alicloud-nas-sharepath   <unset>                          74s

Console

1. Create the ns1 and ns2 namespaces. For more information, see Create a namespace.

2. In the left-side navigation pane of the details page, choose Volumes > Persistent Volume Claims.

3. Create a persistent volume claim (PVC) in the ns namespace.

   1. On the Persistent Volume Claims page, set Namespace to ns1 and click Create.

   2. In the Create PVC dialog box, configure the parameters and click Create.

      Configuration item	Description	Example value
      PVC Type	Select NAS.	NAS
      Name	The name of the PVC. The name must be unique within the namespace.	pvc-nas
      Allocation Mode	In this example, select Use StorageClass.	Dynamic provisioning with a StorageClass
      Existing StorageClass	Click Select StorageClass and select the StorageClass that you created.	alicloud-nas-sharepath
      Capacity	The capacity of the volume.	20Gi
      Access Mode	The default value is ReadWriteMany. You can also select ReadWriteOnce or ReadOnlyMany.	ReadWriteMany

4. Repeat the preceding step to create another PVC in the ns2 namespace.

5. Return to the Persistent Volume Claims page. In the ns1 and ns2 namespaces, make sure that the two PVCs are bound to the automatically created PVs.

kubectl

1. Modify the following YAML content and save the files as nginx-ns1.yaml and nginx-ns2.yaml.

   The following YAML templates show that the configurations in nginx-ns1.yaml and nginx-ns2.yaml are the same, except for the metadata.namespace value. The two applications are bound to the PVC in their respective namespaces.

   nginx-ns1.yaml

   apiVersion: apps/v1
   kind: Deployment
   metadata:
     name: nas-test
     namespace: ns1   
   spec:
     selector:
       matchLabels:
         app: nginx
     template:
       metadata:
         labels:
           app: nginx
       spec:
         containers:
         - name: nginx
           image: anolis-registry.cn-zhangjiakou.cr.aliyuncs.com/openanolis/nginx:1.14.1-8.6
           ports:
           - containerPort: 80
           volumeMounts:
             - name: nas-pvc
               mountPath: "/data"
         volumes:
           - name: nas-pvc
             persistentVolumeClaim:
               claimName: nas-csi-pvc

   nginx-ns2.yaml

   apiVersion: apps/v1
   kind: Deployment
   metadata:
     name: nas-test
     namespace: ns2   
   spec:
     selector:
       matchLabels:
         app: nginx
     template:
       metadata:
         labels:
           app: nginx
       spec:
         containers:
         - name: nginx
           image: anolis-registry.cn-zhangjiakou.cr.aliyuncs.com/openanolis/nginx:1.14.1-8.6
           ports:
           - containerPort: 80
           volumeMounts:
             - name: nas-pvc
               mountPath: "/data"
         volumes:
           - name: nas-pvc
             persistentVolumeClaim:
               claimName: nas-csi-pvc

2. Create the two deployments.

   kubectl create -f nginx-ns1.yaml -f nginx-ns2.yaml

3. View pod information.

   kubectl get pod -A -l app=nginx

   The output indicates that the same subdirectory of the same NAS file system is mounted to pods in different namespaces.

   NAMESPACE   NAME                         READY   STATUS    RESTARTS   AGE
   ns1         nas-test-b75d5b6bc-ljvfd     1/1     Running   0          2m19s
   ns2         nas-test-b75d5b6bc-666hn     1/1     Running   0          2m11s

Console

1. In the navigation pane on the left of the cluster details page, go to Workloads > Deployments.

2. Create a deployment in the ns1 namespace and mount the corresponding PVC.

   1. Set Namespace to ns1 and click Create from Image.

   2. Configure the parameters to create the application.

      The following table describes the key parameters. You can keep the default settings for other parameters. For more information, see Create a stateless workload (Deployment).

      Configuration item	Parameter	Description	Example
      Basic Information	Name	Enter a custom name for the deployment. The name must meet the format requirements displayed in the console.	nginx
      	Replicas	The number of deployment replicas.	2
      Container Configuration	Image Name	The address of the image used to deploy the application.	anolis-registry.cn-zhangjiakou.cr.aliyuncs.com/openanolis/nginx:1.14.1-8.6
      	Required Resources	The required vCPU and memory resources.	0.25 vCPU, 512 MiB
      	Volume	Click Add PVC and configure the parameters. Mount Source: Select the PVC that you created. Container Path: Specify the container path to which you want to mount the NAS file system.	Mount Source: pvc-nas Container Path: /data

3. Repeat the preceding step to create another deployment in the ns2 namespace and mount the corresponding PVC.

4. Return to the Stateless page and check the status of the two Deployments in the ns1 and ns2 namespaces to confirm that the Pods are running and have the corresponding PVCs attached.