Configuring OBS Mount Options

Prerequisites

The everest add-on version must be 1.2.8 or later. The add-on identifies the mount options and transfers them to the underlying storage resources, which determine whether the specified options are valid.

OBS Mount Options

When mounting an OBS volume, the everest add-on presets the options described in Table 1 and Table 2 by default. The options in Table 1 are mandatory.

Configuring Mount Options in a PV

You can use the mountOptions field to configure mount options in a PV. The options you can configure in mountOptions are listed in OBS Mount Options.

1. Use kubectl to connect to the cluster. For details, see Connecting to a Cluster Using kubectl.
2. Configure mount options in a PV. Example:

   apiVersion: v1
   kind: PersistentVolume
   metadata:
     annotations:
       pv.kubernetes.io/provisioned-by: everest-csi-provisioner
       everest.io/reclaim-policy: retain-volume-only      # (Optional) The PV is deleted while the underlying volume is retained.
     name: pv-obs       # PV name.
   spec:
     accessModes:
     - ReadWriteMany    # Access mode. The value must be ReadWriteMany for OBS.
     capacity:
       storage: 1Gi     # OBS volume capacity.
     csi:
       driver: obs.csi.everest.io        # Dependent storage driver for the mounting.
       fsType: obsfs                     # Instance type.
       volumeHandle: <your_volume_id>    # Name of the OBS volume.
       volumeAttributes:
         storage.kubernetes.io/csiProvisionerIdentity: everest-csi-provisioner
         everest.io/obs-volume-type: STANDARD
         everest.io/region: <your_region>                        # Region where the OBS volume is.
         everest.io/enterprise-project-id: <your_project_id>     # (Optional) Enterprise project ID. If an enterprise project is specified, use the same enterprise project when creating a PVC. Otherwise, the PVC cannot be bound to a PV.
       nodePublishSecretRef:            # Custom secret of the OBS volume.
         name: <your_secret_name>       # Custom secret name.
         namespace: <your_namespace>    # Namespace of the custom secret.
     persistentVolumeReclaimPolicy: Retain    # Reclaim policy.
     storageClassName: csi-obs               # Storage class name.
     mountOptions:                            # Mount options.
     - umask=0027

3. After a PV is created, you can create a PVC and bind it to the PV, and then mount the PV to the container in the workload. For details, see Using an Existing OBS Bucket Through a Static PV.
4. Check whether the mount options take effect.

   In this example, the PVC is mounted to the workload that uses the nginx:latest image. You can log in to the node where the pod to which the OBS volume is mounted resides and view the progress details.

   Run the following command:

   • Object bucket: ps -ef | grep s3fs

     root     22142     1  0 Jun03 ?        00:00:00 /usr/bin/s3fs {your_obs_name} /mnt/paas/kubernetes/kubelet/pods/{pod_uid}/volumes/kubernetes.io~csi/{your_pv_name}/mount -o url=https://{endpoint}:443 -o endpoint={region} -o passwd_file=/opt/everest-host-connector/***_obstmpcred/{your_obs_name} -o nonempty -o big_writes -o sigv2 -o allow_other -o no_check_certificate -o ssl_verify_hostname=0 -o umask=0027 -o max_write=131072 -o multipart_size=20

   • Parallel file system: ps -ef | grep obsfs

     root      1355     1  0 Jun03 ?        00:03:16 /usr/bin/obsfs {your_obs_name} /mnt/paas/kubernetes/kubelet/pods/{pod_uid}/volumes/kubernetes.io~csi/{your_pv_name}/mount -o url=https://{endpoint}:443 -o endpoint={region} -o passwd_file=/opt/everest-host-connector/***_obstmpcred/{your_obs_name} -o allow_other -o nonempty -o big_writes -o use_ino -o no_check_certificate -o ssl_verify_hostname=0 -o max_background=100 -o umask=0027 -o max_write=131072

Configuring Mount Options in a StorageClass

You can use the mountOptions field to configure mount options in a StorageClass. The options you can configure in mountOptions are listed in OBS Mount Options.

1. Use kubectl to connect to the cluster. For details, see Connecting to a Cluster Using kubectl.
2. Create a customized StorageClass. Example:

   kind: StorageClass
   apiVersion: storage.k8s.io/v1
   metadata:
     name: csi-obs-mount-option
   provisioner: everest-csi-provisioner
   parameters:
     csi.storage.k8s.io/csi-driver-name: obs.csi.everest.io
     csi.storage.k8s.io/fstype: s3fs
     everest.io/obs-volume-type: STANDARD
   reclaimPolicy: Delete
   volumeBindingMode: Immediate
   mountOptions:                            # Mount options.
   - umask=0027

3. After the StorageClass is configured, you can use it to create a PVC. By default, the dynamically created PVs inherit the mount options configured in the StorageClass. For details, see Using an OBS Bucket Through a Dynamic PV.
4. Check whether the mount options take effect.

   In this example, the PVC is mounted to the workload that uses the nginx:latest image. You can log in to the node where the pod to which the OBS volume is mounted resides and view the progress details.

   Run the following command:

   • Object bucket: ps -ef | grep s3fs

     root     22142     1  0 Jun03 ?        00:00:00 /usr/bin/s3fs {your_obs_name} /mnt/paas/kubernetes/kubelet/pods/{pod_uid}/volumes/kubernetes.io~csi/{your_pv_name}/mount -o url=https://{endpoint}:443 -o endpoint={region} -o passwd_file=/opt/everest-host-connector/***_obstmpcred/{your_obs_name} -o nonempty -o big_writes -o sigv2 -o allow_other -o no_check_certificate -o ssl_verify_hostname=0 -o umask=0027 -o max_write=131072 -o multipart_size=20

   • Parallel file system: ps -ef | grep obsfs

     root      1355     1  0 Jun03 ?        00:03:16 /usr/bin/obsfs {your_obs_name} /mnt/paas/kubernetes/kubelet/pods/{pod_uid}/volumes/kubernetes.io~csi/{your_pv_name}/mount -o url=https://{endpoint}:443 -o endpoint={region} -o passwd_file=/opt/everest-host-connector/***_obstmpcred/{your_obs_name} -o allow_other -o nonempty -o big_writes -o use_ino -o no_check_certificate -o ssl_verify_hostname=0 -o max_background=100 -o umask=0027 -o max_write=131072