Creating an SFS Subdirectory Using a Dynamic PV
When an SFS volume is mounted to a workload container, the root directory is mounted to the container by default. To properly use the storage capacity, CCE allows you to dynamically create an SFS subdirectory when creating a PVC so that different workloads can share one SFS volume.
Only general purpose file systems (SFS 3.0 Capacity-Oriented) support dynamic creation of subdirectories.
Prerequisites
- You have created a cluster and installed the CCE Container Storage (Everest) add-on of v2.4.41 or later in the cluster.
- To create a cluster using commands, ensure kubectl is used. For details, see Accessing a Cluster Using kubectl.
- You have created an available SFS file system, and the SFS file system and the cluster are in the same VPC. Before using a general purpose file system (SFS 3.0 Capacity-Oriented) for storage, ensure a VPC endpoint has been created in the VPC where the cluster is located for the cluster to access the file system. For details, see Creating a VPC Endpoint.
Dynamically Creating an SFS Subdirectory
CCE allows you to create SFS subdirectory PVCs via the console or kubectl based on the configured StorageClasses. After PVC creation, CCE dynamically allocates storage resources and mounts the PVCs to the specified workloads. To do so, perform the following operations.
- Log in to the CCE console and click the cluster name to access the cluster console.
- 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 SFS.
PVC Name
Enter the PVC name, which must be unique in a namespace.
Creation Method
Select New subdirectory.
Storage Classes
Select csi-sfs for SFS.
You can customize a StorageClass and configure its reclaim policy and binding mode. For details, see Basic StorageClass Settings.
Access Mode
SFS volumes support only ReadWriteMany, indicating that a storage volume can be mounted to multiple nodes in read/write mode. For details, see Volume Access Modes.
File Storage
Click Select SFS. On the displayed page, select the SFS file system that meets your requirements and click OK.
Subdirectory
Enter the absolute path of a subdirectory, for example, /a/b.
Subdirectory Reclaim Policy
Determine whether to retain subdirectories when a PVC is deleted.
- Retain: When a PVC is deleted, the PV is deleted, but its associated subdirectories are retained.
- Delete: When a PVC is deleted, the PV and its associated subdirectories are also deleted. NOTE:
When a subdirectory is deleted, only the absolute path of the subdirectory specified in the PVC is deleted. The parent directory is retained.
- Click Create to create a PVC and a PV.
You can choose Storage in the navigation pane and view the created PVC and PV on the PVCs and PVs tabs, respectively.
- Use kubectl to access the cluster.
- Create the pvc-sfs-subpath.yaml file.
apiVersion: v1 kind: PersistentVolumeClaim metadata: name: pvc-sfs-subpath # PVC name namespace: default annotations: everest.io/csi.volume-as: absolute-path # An SFS subdirectory is used. everest.io/csi.sfs30-name: <sfs_name> # Name of the SFS instance everest.io/csi.path: /a # Subdirectory that is automatically created, which must be an absolute path everest.io/csi.reclaim-policy: retain-volume-only # When a PVC is deleted, the PV is deleted, but its associated subdirectories are retained. spec: accessModes: - ReadWriteMany # ReadWriteMany must be selected for SFS. resources: requests: storage: 1Gi # For SFS subdirectory PVCs, this configuration is only used for verification and must not be empty or 0. storageClassName: csi-sfs # StorageClass name of a general purpose file system (SFS 3.0 Capacity-Oriented)
Table 1 Key parameters Parameter
Mandatory
Description
everest.io/csi.volume-as
Yes
When a dynamically created SFS subdirectory is used, the value of this parameter is consistently absolute-path.
everest.io/csi.sfs30-name
Yes
An SFS instance name.
everest.io/csi.path
Yes
Subdirectory that is automatically created, which must be an absolute path.
everest.io/csi.reclaim-policy
Yes
Whether to retain subdirectories when deleting a PVC. This parameter must be used with PV Reclaim Policy. This parameter is available only when the PV reclaim policy is Delete. Options:
- retain-volume-only: When a PVC is deleted, the PV is deleted, but its associated subdirectories are retained.
- delete: When a PVC is deleted, the PV and its associated subdirectories are also deleted. NOTE:
When a subdirectory is deleted, only the absolute path of the subdirectory specified in the PVC is deleted. The parent directory is retained.
storage
Yes
Requested capacity in the PVC, in Gi.
This parameter is only used for verifying SFS subdirectory PVCs. The value cannot be empty or 0, and can be fixed at 1 because any value you set does not take effect.
- Run the following command to create a PVC:
kubectl apply -f pvc-sfs-subpath.yaml
Verify that the PVC is created successfully.
kubectl get pvc pvc-sfs-subpath
Information similar to the following is displayed:
NAME STATUS VOLUME CAPACITY ACCESS MODES STORAGECLASS AGE pvc-sfs-subpath Bound pvc-xxxx-xxxx-xxxx-xxxx 1Gi RWX csi-sfs 10s
The STATUS must be Bound, indicating that the PVC has been successfully bound to the PV.
Verifying Subpath Mounting and Read/Write Operations
After a PVC is created, mount the bound PV to an application. This section describes how to create two Deployments that reference the same PVC, enabling multiple pods to share the same NAS subpath.
- Create a workload YAML file.
Create deployment-sfs-demo.yaml with the following content:
apiVersion: apps/v1 kind: Deployment metadata: name: sfs-demo namespace: default spec: replicas: 1 selector: matchLabels: app: sfs-demo template: metadata: labels: app: sfs-demo spec: containers: - name: container-0 image: nginx:latest imagePullPolicy: IfNotPresent volumeMounts: - name: sfs-storage mountPath: /usr/share/nginx/html/data # Mount path in a container volumes: - name: sfs-storage persistentVolumeClaim: claimName: pvc-sfs-subpath # Reference the PVC created in the previous step. imagePullSecrets: - name: default-secret - Create workloads.
kubectl apply -f deployment-sfs-demo.yaml
- Verify that the subpath is mounted correctly.
# Obtain the pod name. POD_NAME=$(kubectl get pods -l app=sfs-demo -o jsonpath='{.items[0].metadata.name}') # Access the container and check the mount point. kubectl exec -it $POD_NAME -- /bin/sh -c "ls -ld /usr/share/nginx/html/data"Expected output:
drwxr-xr-x 2 root root 0 ... /usr/share/nginx/html/data
The directory exists and the permissions are correct.
- Test file read/write operations.
# Write test files in the container. kubectl exec -it $POD_NAME -- /bin/sh -c "echo 'Hello SFS Subpath - End to End Test' > /usr/share/nginx/html/data/test.txt" # Read the test file to verify that the write operation is successful. kubectl exec -it $POD_NAME -- /bin/sh -c "cat /usr/share/nginx/html/data/test.txt"
Expected output:
Hello SFS Subpath - End to End Test
If the file can be written and read successfully, the storage volume's read/write functions are working correctly.
Helpful Links
If a storage volume fails to mount to a workload, rectify the fault by referring to What Should I Do If a Storage Volume Cannot Be Mounted or the Mounting Times Out?
What is your overall rating for this page?
Thank you very much for your feedback. We will continue working to improve the documentation.See the reply and handling status in My Cloud VOC.
For any further questions, feel free to contact us through the chatbot.
Chatbot