Configure a share

Updated at:

This topic describes how to configure share settings in the Cloud Storage Gateway (CSG) console.

Prerequisites

A share is created. For more information, see Create a share.

Share settings

  1. Navigate to the Gateways page in the Cloud Storage Gateway console, and then click the target gateway.

  2. On the Shares page, find the target share and click Settings in the Actions column.

  3. On the Settings page, configure the following parameters.

    Parameter

    Description

    User mapping

    Specifies the user mapping between an NFS client and the NFS server.

    • none: NFS client users are not mapped to the nobody user on the NFS server.

    • root_squash: Maps the root user on an NFS client to the nobody user on the NFS server.

    • all_squash: Maps all NFS client users to the nobody user on the NFS server, regardless of their original identity.

    • all_anonymous: Maps all NFS client users to the anonymous user on the NFS server, regardless of their original identity.

    Note

    This parameter applies only to NFS shares.

    Browsable

    Makes the share discoverable by clients on the network.

    Note

    This parameter applies only to SMB shares.

    Read/write clients

    The IP addresses or CIDR blocks that are allowed read/write access to the NFS share.

    You can enter multiple IP addresses or CIDR blocks. Example: 192.168.10.10 or 192.168.0.0/24.

    Note

    This parameter applies only to NFS shares.

    Read-only clients

    The IP addresses or CIDR blocks that are allowed read-only access to the NFS share.

    You can enter multiple IP addresses or CIDR blocks. Example: 192.168.10.10 or 192.168.0.0/24.

    Note

    This parameter applies only to NFS shares.

    Read/write Users

    The list of users who have read/write access to the SMB share.

    Note

    This parameter applies only to SMB shares.

    Read-only Users

    The list of users who have read-only access to the SMB share.

    Note
    • This parameter applies only to SMB shares.

    • If a user is in both the read-only and read/write lists, the read-only permission takes precedence.

    Write speed limit

    The maximum write speed in MB/s. The valid range is 0 to 1,280. A value of 0 indicates an unlimited speed.

    Upload speed limit

    The maximum upload speed in MB/s. The valid range is 0 to 1,280. A value of 0 indicates an unlimited speed.

Advanced settings

  1. Navigate to the Gateways page in the Cloud Storage Gateway console, and then click the target gateway.

  2. On the Shares page, find the target share and click Advanced Settings in the Actions column.

  3. On the Advanced Settings page, you can configure the following parameters.

    Parameter

    Description

    Transfer Acceleration

    Improves data transfer speed for cross-region scenarios by using the public bandwidth of the gateway. Before you enable this feature, make sure that Transfer Acceleration is also enabled for the associated OSS bucket.

    Bypass Cache Read

    By default, when a gateway receives a read request and a cache miss occurs, the gateway downloads the requested data from the OSS bucket to its cache disk. This process also includes some data prefetching. If your workload involves highly random read requests and the cache disk is much smaller than the dataset in the OSS bucket, prefetching may be ineffective. In this scenario, you can enable this option to bypass the cache and read directly from OSS. Enable this option only when necessary.

    Upload Optimization

    Enables real-time cache reclamation. This feature is suitable for use cases where the share is used only for cloud backups.

    Reverse Sync

    Synchronizes metadata from the OSS bucket back to the gateway. This is useful for disaster recovery, data restoration, and data sharing scenarios.

    Note
    • Reverse Sync scans all objects in the bucket. If the bucket contains a large number of objects, this process can incur significant costs from OSS API requests. For more information about request fees, see the page.

    • This option is unavailable if you selected Add to Sync Group on the Basic Information tab.

    Reverse Sync Interval

    If you set Reverse Sync to Yes, you can set the Reverse Sync Interval. The minimum value is 15s, and the maximum value is 36000s.

    Note
    • If the bucket contains a large number of objects, we recommend that you set the interval to a value greater than 3,600 seconds to avoid high costs from frequent OSS API calls caused by repeated scans.

    • If the share uses replication mode and has Data Download enabled, the minimum interval is 3,600 seconds and the maximum is 36,000 seconds.

    • Reverse Sync is triggered only when a directory is accessed. To ensure that data in unaccessed directories and newly added data are downloaded promptly, we recommend using Express Sync.

    Ignore Deletions

    Prevents file deletions on the gateway from being synchronized to OSS. This helps protect against accidental data loss by keeping a full copy of the data in OSS.

    NFSv4 Optimization

    Improves upload performance for shares mounted using NFSv4. After you enable this option, the share cannot be mounted by using NFSv3.

    Note

    This parameter is available only when the protocol is set to NFS in the Basic Information settings.

    Sync Latency

    Setting the Sync Latency delays file uploads for a period of time after a file is closed to prevent frequent local modifications from causing OSS fragmentation. The default value is 5 s, and the maximum value is 120 s.

    Configure Directory in Replication Mode

    This setting controls which directories operate in replication mode.

    • If this option is not selected, all data in the share operates in replication mode by default.

    • If this option is selected, you can click Add Directory and enter the paths of specific directories to operate in replication mode. Data in unspecified directories operates in cache mode.

    Note
    • This parameter is available only when the working mode is replication mode.

    • When a directory is switched from cache mode to replication mode, its files are synchronized only if Data Download is enabled. We recommend enabling Data Download for replication mode.

    • Specify directory paths relative to the share's root directory. For example, if the full path of the directory is /mnt/myshare/mydir/ and the mount point is /mnt/myshare, enter /mydir/.

    Data Download

    When enabled, Reverse Sync or Express Sync downloads both metadata and file data. If this option is disabled, only metadata is synchronized.

    Note
    • This parameter is available only when the working mode is replication mode.

    • To download file data in replication mode, the cache disk capacity must be at least 1.1 times the total size of the files to be replicated. Plan your cache disk capacity based on the expected growth in bucket usage.

    • The first time you enable this feature, it triggers a full scan, which may affect performance. Ensure that the gateway is idle when you enable Data Download and wait until all data is downloaded.

    • Data Download supports only single-writer, multiple-reader scenarios. If the associated bucket is accessed by multiple clients (including gateways and direct OSS access), only one client should be allowed to upload files. All other clients must be read-only. A multiple-writer scenario will lead to data loss. Use this feature with caution.

    Download speed limit

    When Data Download is enabled, this parameter limits the download speed. The valid range is 0 to 1,280 MB/s, where 0 indicates an unlimited speed.

Next steps

Access shares