Use a static OSS volume

Step 1: Create a PV

1. Save the following YAML content as oss-pv.yaml.

   apiVersion: v1
   kind: Secret
   metadata:
     name: oss-secret
     namespace: default
   stringData:
     akId: <your AccessKey ID>
     akSecret: <your AccessKey Secret>
   ---
   apiVersion: v1
   kind: PersistentVolume
   metadata:
     name: oss-pv
     labels:
       alicloud-pvname: oss-pv
   spec:
     storageClassName: test 
     capacity:
       storage: 20Gi
     accessModes:
       - ReadWriteMany
     persistentVolumeReclaimPolicy: Retain
     csi:
       driver: ossplugin.csi.alibabacloud.com
       volumeHandle: oss-pv
       nodePublishSecretRef:
         name: oss-secret
         namespace: default
       volumeAttributes:
         bucket: "<your OSS Bucket Name>"
         url: "<your OSS Bucket Endpoint>"
         otherOpts: "-o umask=022 -o allow_other"

   Note

   This YAML creates a Secret and a PV. The Secret stores your AccessKey pair, which the PV uses for secure access. Replace the values of akId and akSecret with your actual AccessKey ID and AccessKey Secret.

   The following table describes the PV parameters:

   Parameter	Description
   alicloud-pvname	The label of the PV, used to bind it to a PVC.
   storageClassName	This value is for PVC binding only and does not need to correspond to an existing StorageClass object.
   storage	The capacity of the OSS volume. The capacity specified for a static OSS volume is for declarative purposes only. The actual capacity is not limited, and the available capacity is based on the usage displayed in the OSS console.
   accessModes	The access mode. Valid values: ReadOnlyMany, which lets multiple pods mount the volume as read-only, and ReadWriteMany, which lets multiple pods mount the volume as read-write.
   persistentVolumeReclaimPolicy	The reclaim policy of the PV.
   driver	The driver type. Set this to ossplugin.csi.alibabacloud.com to use the Alibaba Cloud OSS Container Storage Interface (CSI) plugin.
   volumeHandle	The UID (unique identifier) of the PV. This must be the same as metadata.name.
   nodePublishSecretRef	References the Secret that contains the AccessKey pair for authorization.
   bucket	The name of the OSS bucket. Replace the value of bucket with your actual OSS bucket name.
   url	The endpoint of the OSS bucket. Replace the value of url with the actual endpoint of your OSS bucket. If the OSS bucket and the ACS cluster are in the same region, use the internal endpoint. For example, oss-cn-shanghai-internal.aliyuncs.com. If the OSS bucket is region-agnostic or is in a different region from the ACS cluster, use the public endpoint. For example, oss-cn-shanghai.aliyuncs.com.
   otherOpts	Specifies custom mount options for the OSS volume in the format -o *** -o ***. For example, -o umask=022 -o max_stat_cache_size=100000 -o allow_other. Expand to view details umask: changes the permissions that ossfs uses to read files. For example, umask=022 changes the permissions of ossfs files to 755. This resolves insufficient permissions inside the mount point for objects that were uploaded by other means, such as an SDK or the OSS console, which have default permissions of 640. (Recommended) Set this option for read/write separation or multi-user access. max_stat_cache_size: sets the maximum number of entries in the metadata cache, such as 100000. Caching object metadata in memory improves the performance of operations such as ls and stat. However, this cache does not immediately detect changes that are made through the OSS console, an SDK, or ossutil, so your application can read inconsistent data. If you have strict data consistency requirements, set it to 0 to disable the cache, or use the stat_cache_expire parameter to shorten the cache expiration time. Both settings reduce read performance. allow_other: allows users other than the mounting user to access the files and directories in the mount point. Use this option in multi-user shared environments where users other than the mounting user also need to access the data. For more configurations, see Mount options and Best practices.

2. Create the Secret and the PV.

   kubectl create -f oss-pv.yaml

3. View the PV.

   kubectl get pv

   Expected output:

   NAME     CAPACITY   ACCESS MODES   RECLAIM POLICY   STATUS      CLAIM   STORAGECLASS   VOLUMEATTRIBUTESCLASS   REASON   AGE
   oss-pv   20Gi       RWX            Retain           Available           test           <unset>                          9s

Step 2: Create a PVC

• Save the following YAML content as oss-pvc.yaml.

apiVersion: v1
kind: PersistentVolumeClaim
metadata:
  name: oss-pvc
spec:
  storageClassName: test
  accessModes:
    - ReadWriteMany
  resources:
    requests:
      storage: 20Gi
  selector:
    matchLabels:
      alicloud-pvname: oss-pv

The following table describes the parameters:

• Create the PVC.

kubectl create -f oss-pvc.yaml

• View the PVC.

kubectl get pvc

The expected output shows that the PVC is bound to the PV created in Step 1.

NAME      STATUS   VOLUME   CAPACITY   ACCESS MODES   STORAGECLASS   VOLUMEATTRIBUTESCLASS   AGE
oss-pvc   Bound    oss-pv   20Gi       RWX            test           <unset>                 6s

Step 3: Create an application and mount the volume

• Create a file named oss-test.yaml with the following content.

  The following YAML example creates a Deployment with two pods. Both pods request storage by using the PVC named oss-pvc, and the mount path for both is /data.

apiVersion: apps/v1
kind: Deployment
metadata:
  name: oss-test
  labels:
    app: nginx
spec:
  replicas: 2
  selector:
    matchLabels:
      app: nginx
  template:
    metadata:
      labels:
        app: nginx
    spec:
      containers:
      - name: nginx
        image: registry.cn-hangzhou.aliyuncs.com/acs-sample/nginx:latest
        ports:
        - containerPort: 80
        volumeMounts:
          - name: pvc-oss
            mountPath: /data
      volumes:
        - name: pvc-oss
          persistentVolumeClaim:
            claimName: oss-pvc

• Create the Deployment and mount the OSS volume.

kubectl create -f oss-test.yaml

• Check the status of the pods in the Deployment.

kubectl get pod | grep oss-test

The example output indicates that two pods have been created.

oss-test-****-***a   1/1     Running   0          28s
oss-test-****-***b   1/1     Running   0          28s

• Check the mount path.

  The following command lists the data at the OSS bucket mount point. By default, the output is empty.

kubectl exec oss-test-****-***a -- ls /data

Step 1: Create a PV

1. Log on to the ACS console.

2. On the Clusters page, click the name of the cluster to go to the cluster management page.

3. In the left-side navigation pane of the cluster management page, choose Volumes > Persistent Volumes.

4. On the Persistent Volumes page, click Create.

5. In the Create dialog box, configure the parameters and click the Create button.

   Parameter	Description	Example
   PV Type	The volume type. Select OSS.	OSS
   Volume Name:	The name of the PV. Specify a custom name according to the format requirements displayed in the UI.	oss-pv
   Capacity	The capacity of the OSS volume. The capacity specified for a static OSS volume is for declarative purposes only. The actual capacity is not limited, and the available capacity is based on the usage displayed in the OSS console.	20Gi
   Access Mode	The access mode. Select an option based on your requirements: ReadOnlyMany: The volume can be mounted as read-only by multiple pods. ReadWriteMany: The volume can be mounted as read-write by multiple pods.	ReadWriteMany
   Access Certificate	For security, store the AccessKey information in a Secret. This example uses the Create Secret option.	Create Secret namespace: default Name: oss-secret AccessKey ID: ******** AccessKey Secret: ********
   Bucket ID:	Select an OSS bucket.	oss-acs-***
   OSS Path	The directory to mount. This defaults to the root directory (/). If you specify a subdirectory, such as /dir, ensure it exists.	/
   Endpoint:	The endpoint of the OSS bucket. If the OSS bucket and the ACS cluster are in the same region, select the Internal Endpoint option. If the OSS bucket is region-agnostic or is in a different region from the ACS cluster, select the Public Endpoint option.	Private Endpoint

   After the PV is created, you can view its information on the Persistent Volumes page. The PV is not yet bound to a PVC.

Step 2: Create a PVC

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

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

3. In the dialog box that appears, configure the parameters and click the Create button.

   Parameter	Description	Example
   PVC Type	The volume type. Select OSS.	OSS
   Name	The name of the PVC. Specify a custom name according to the format requirements displayed in the UI.	oss-pvc
   Allocation Mode	The allocation mode. Select the Existing Volumes option.	Existing PV
   Existing Volumes	Select the PV that you created.	oss-pv
   Capacity	The amount of storage to request. This value cannot exceed the PV's capacity.	20Gi

   After the PVC is created, you can view it on the Persistent Volume Claims page. The PVC is now bound to the PV (the OSS volume).

Step 3: Create an application and mount the volume

1. In the left-side navigation pane of the cluster management page, choose Workloads > Deployments.

2. On the Deployments page, click the Create from Image button.

3. Configure the parameters for the Deployment and click the Create button.

   The following table describes key parameters. Keep the default values for other parameters. For more information, see Create a Deployment.

   Section	Parameter	Description	Example
   Basic Information	Application Name	The name of the Deployment. Specify a custom name according to the format requirements displayed in the UI.	oss-test
   Basic Information	Replicas:	The number of replicas (pods) for the Deployment.	2
   Container	Image Name	The image address used to deploy the application.	registry.cn-hangzhou.aliyuncs.com/acs-sample/nginx:latest
   Container	Required Resources	Set the required vCPU and memory resources.	0.25 vCPU, 0.5 GiB
   Volume	Add PVC	Click the button and configure the parameters: Mount Source: Select the PVC that you created. Container Path: Enter the container path where you want to mount the OSS bucket.	Mount source: oss-pvc Container path: /data

4. Check the status of the application Deployment.

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

   2. On the Pods tab, make sure the pods are in the Running state.