Cloud Parallel File Storage:Mount a file system via CPFS-NFS client (Recommended)

Usage

Step 1: Download and install the CPFS-NFS client

This client is open source. For the source code or to compile it manually, visit the GitHub repository.

1. Log on to the ECS instance where you will mount the CPFS file system. For more information about how to connect to an ECS instance, see Connection methods.

2. Download and install the CPFS-NFS client.

   Alibaba Cloud Linux

   1. Download the CPFS-NFS client.

      wget https://cpfs-hangzhou-nfs-client.oss-cn-hangzhou.aliyuncs.com/aliyun-alinas-utils-latest.al.noarch.rpm

   2. Install the CPFS-NFS client.

      sudo yum install aliyun-alinas-utils-*.rpm

   CentOS

   1. Download the CPFS-NFS client.

      wget https://cpfs-hangzhou-nfs-client.oss-cn-hangzhou.aliyuncs.com/aliyun-alinas-utils-latest.el.noarch.rpm

   2. Install the CPFS-NFS client.

      sudo yum install aliyun-alinas-utils-*.rpm

   Ubuntu

   1. Download the CPFS-NFS client.

      sudo wget https://cpfs-hangzhou-nfs-client.oss-cn-hangzhou.aliyuncs.com/aliyun-alinas-utils-latest.deb -O /tmp/aliyun-alinas-utils-latest.deb

   2. Install the CPFS-NFS client.

      sudo apt-get update
      sudo apt-get install /tmp/aliyun-alinas-utils-latest.deb

   Debian

   1. Download the CPFS-NFS client.

      sudo wget https://cpfs-hangzhou-nfs-client.oss-cn-hangzhou.aliyuncs.com/aliyun-alinas-utils-latest.deb -O /tmp/aliyun-alinas-utils-latest.deb

   2. Install the CPFS-NFS client.

      sudo apt-get update
      sudo apt-get install /tmp/aliyun-alinas-utils-latest.deb

   SUSE

   1. Download the CPFS-NFS client.

      wget https://cpfs-hangzhou-nfs-client.oss-cn-hangzhou.aliyuncs.com/aliyun-alinas-utils-latest.lp15.x86_64.rpm

   2. Install the CPFS-NFS client.

      sudo zypper --no-gpg-checks install -y aliyun-alinas-utils-*.rpm

3. Verify the installation.

   which mount.cpfs-nfs

   A successful installation returns the following output:

   /usr/sbin/mount.cpfs-nfs

Step 2: Mount the file system with the client

1. Mount the CPFS file system.

   1. Scenario 1: General mount (default path)

      This scenario applies to most environments that do not have AppArmor, SELinux, or other special path access restrictions enabled.

      sudo mount -t cpfs-nfs -o vers=3,rsize=1048576,wsize=1048576,hard,timeo=600,retrans=2,noresvport file-system-id.region.cpfs.aliyuncs.com:/share/path /mnt

   2. Scenario 2: Mount in a high-security environment (for example, on systems with SELinux or AppArmor enabled)

      If security hardening policies, such as AppArmor or SELinux, are enabled on your operating system, the default mount might cause access errors. In this case, specify a path using the hp_config_dir option. When you run the command, replace <custom_directory> with a path that your system's security policy allows.

      sudo mount -t cpfs-nfs -o vers=3,rsize=1048576,wsize=1048576,hard,timeo=600,retrans=2,noresvport,hp_config_dir=<custom_directory> file-system-id.region.cpfs.aliyuncs.com:/share/path /mnt

2. Mount command parameters

   Parameter	Description
   file-system-id.region.cpfs.aliyuncs.com:/share/path /mnt	Specifies the mount path and the local path. Replace them with your actual values. Mount path: The mount path of the export directory. In the File Storage NAS console, on the file system list page, click Manage for the target file system to go to the Protocol Service page. In the Actions column, click Export Directory to open the Export Directory panel and obtain the mount path. Example: cpfs-196f91a8e58b****-195ceeac7b6ac****.cn-chengdu.cpfs.aliyuncs.com:/share/fileset Local path: The path on the ECS instance where you want to mount the file system. This can be the root directory (/) or any subdirectory, such as /mnt. If you specify a subdirectory, ensure that it already exists.
   vers	The NFS version. CPFS supports only NFSv3.
   Mount options	You can specify multiple mount options separated by commas (,). The following options are available: rsize: The size of the data block (in bytes) used for reading data between the client and the file system. Recommended value: 1048576. wsize: The size of the data block (in bytes) used for writing data between the client and the file system. Recommended value: 1048576. Note If you need to change the I/O size parameters (rsize and wsize), we recommend that you use the maximum value (1048576) to avoid performance degradation. hard: If the CPFS file system becomes temporarily unavailable, a local application that uses a file on the file system stops and waits until the file system is back online. This option is recommended. timeo: The duration, in tenths of a second, that the CPFS-NFS client waits for a response before it retries a request to the file system. Recommended value: 600 (60 seconds). Note If you must change the timeout parameter (timeo), we recommend that you use a value of 150 or greater. This value is in tenths of a second, so 150 corresponds to 15 seconds. retrans: The number of times the CPFS-NFS client retries a request. Recommended value: 2. noresvport: Uses a new TCP port upon network reconnection to ensure that the connection is not interrupted during network fault recovery. This option is recommended. Important The soft option is not recommended because it poses a risk to data consistency. If you use the soft option, you assume all associated risks. Avoid setting any other mount options to values that are different from the recommended values. For example, changing the read or write buffer sizes or disabling attribute caching can degrade performance. hp_config_dir: (Optional) Specifies the directory that contains the haproxy configuration file. Set this parameter if your operating system has security enforcement policies (such as AppArmor or SELinux) or other high-security policies that restrict processes to reading configurations or running only in specific paths. Path selection recommendation: Select a suitable directory from your system's security policy allowlist and make sure that the path is authorized by the security module. Logic: The CPFS client first tries to use the directory specified by this parameter. If you do not specify this parameter, the client attempts to automatically parse the security policy allowlist. If parsing fails, the client falls back to the default path /var/run/cpfs.

3. Run the mount -l command to view the mount information.

   After the file system is mounted, you can run the df -h command to view the capacity information of the file system.

4. (Optional) Configure automatic mount on startup.

   To prevent mount information from being lost after the ECS instance restarts, you need to configure the /etc/fstab file. If you used the hp_config_dir parameter during manual mounting, you must also configure it here.

   1. Open the /etc/fstab configuration file and add the mount configuration.

      • Configuration for a general environment:

        file-system-id.region.cpfs.aliyuncs.com:/share/path /mnt cpfs-nfs vers=3,rsize=1048576,wsize=1048576,hard,timeo=600,retrans=2,_netdev,noresvport 0 0

      • Example configuration for a high-security environment:

        Replace <custom_directory> with a path that your system's security policy allows.

        file-system-id.region.cpfs.aliyuncs.com:/share/path /mnt cpfs-nfs vers=3,rsize=1048576,wsize=1048576,hard,timeo=600,retrans=2,_netdev,noresvport,hp_config_dir=<custom_directory> 0 0

      • The following table describes the other parameters.

        Parameter	Description
        _netdev	Prevents the client from attempting to mount the file system before the network is ready.
        0 (the first item after noresvport)	A non-zero value indicates that the dump command should back up the file system. For CPFS file systems, this value is 0.
        0 (the second item after noresvport)	Indicates the order in which the fsck command checks the file system at startup. For CPFS file systems, this value is 0, which prevents fsck from running at startup.

   2. Run the reboot command to restart the ECS instance.

      Before you restart the ECS instance, confirm that the manual mount was successful to prevent the instance from failing to restart. If the automatic mount is configured successfully, you can run the df -h command to view the mounted CPFS file system after the ECS instance restarts.

Client configuration

Configuration file

[DEFAULT]
logging_level = INFO
logging_max_bytes = 1048576
logging_file_count = 10

[mount]
stunnel_debug_enabled = false

# Validate the certificate hostname on mount. This option is not supported by certain stunnel versions.
stunnel_check_cert_hostname = false

# Use OCSP to check certificate validity. This option is not supported by certain stunnel versions.
stunnel_check_cert_validity = false
proxy_port = 12049

cpfs_proxy_addr = 127.0.1.255
cpfs_proxy_port_min = 30000
cpfs_proxy_port_max = 60000

[mount-watchdog]
poll_interval_sec = 1
unmount_grace_period_sec = 30
dns_refresh_interval = 60

[client-tool]

Haproxy configuration

global
    maxconn 4096

defaults
    mode    tcp
    balance leastconn
    timeout client      60s
    timeout server      60s
    timeout connect     3s
    retries 3

frontend cpfs2049
    bind 127.0.1.255:30000
    default_backend bk2049

backend bk2049
    server cpfs_primary 172.27.1.189:2049 maxconn 2048 check port 2049 inter 2s fall 5 rise 30 on-marked-up shutdown-backup-sessions
    server cpfs_backup  172.27.0.214:2049 maxconn 2048 check port 2049 inter 2s fall 5 rise 30 backup

FAQ

• What do I do if a "Failed to resolve domain: file-system-id.region.cpfs.aliyuncs.com" error is reported when I mount a CPFS file system?

• What are the differences between a CPFS-POSIX client and a CPFS-NFS client?

• How do I remove residual client configurations from an ECS instance?

• What do I do if a "[FATAL] B: Could not connect to B via ssh" error is reported when I mount a CPFS file system?

Related topics

• CPFS data flow

• Data monitoring

• Access control

• Unmount a file system