Ctrlk
Home

Volcengine TOS

This guide describes how to configure Tinder Object Storage Service (TOS) as Alluxio's under storage system. Tinder Object Storage Service (TOS) is a massive, secure, low-cost, easy-to-use, highly reliable, and highly available distributed cloud storage service provided by VolcEngine.

Prerequisites

Before using TOS with Alluxio, follow the TOS quick start guide to sign up for TOS and create a TOS bucket.

Before you get started, please ensure you have the required information listed below:

<TOS_BUCKET>

Create a new TOS bucket or use an existing bucket

<TOS_DIRECTORY>

The directory you want to use in the bucket, either by creating a new directory or using an existing one

<TOS_ACCESS_KEY_ID>

The Access Key ID for TOS, which are created and managed in the TOS AccessKey management console

<TOS_ACCESS_KEY_SECRET>

The Secret Access Key for TOS, which are created and managed in the TOS AccessKey management console

<TOS_ENDPOINT>

The internet endpoint of the bucket, which can be found in the bucket overview page with values like tos-cn-beijing.volces.com and tos-cn-guangzhou.volces.com. Available endpoints are listed in the TOS Internet Endpoints documentation.

<TOS_REGION>

The region where the bucket is located, such as cn-beijing or cn-guangzhou. Available regions are listed in the TOS Regions documentation.

Basic Setup

For the general mount mechanism and UnderFileSystem CR field reference, see Underlying Storage.

An example ufs.yaml to create a TOS mount point with the operator:

apiVersion: k8s-operator.alluxio.com/v1
kind: UnderFileSystem
metadata:
  name: alluxio-tos
  namespace: alx-ns
spec:
  alluxioCluster: alluxio-cluster
  path: tos://<TOS_BUCKET>/<TOS_DIRECTORY>
  mountPath: /tos
  mountOptions:
    fs.tos.accessKeyId: <TOS_ACCESS_KEY>
    fs.tos.accessKeySecret: <TOS_ACCESS_KEY_SECRET>
    fs.tos.endpoint: <TOS_ENDPOINT>
    fs.tos.region: <TOS_REGION>

Advanced Setup

Note that configuration options can be specified as mount options or as configuration properties in conf/alluxio-site.properties. The following sections will describe how to set configurations as properties, but they can also be set as mount options via --option <key>=<value>.

Enabling HTTPS

To enable the use of the HTTPS protocol for secure communication with TOS with an additional layer of security for data transfers, configure the following setting in conf/alluxio-site.properties:

TOS multipart upload

We use multipart-upload method to upload one file by multiple parts, every part will be uploaded in one thread. It won't generate any temporary files while uploading.

There are other parameters you can specify in conf/alluxio-site.properties to potentially speed up the upload.

Disable TOS multipart upload, the upload method uploads one file completely from start to end in one go. you need to modify conf/alluxio-site.properties to include:

Setting Request Retry Policy

For retry configuration that applies to all object store UFS types, see Request Retry Policy in the UFS overview.

High Concurrency Tuning

When integrating Alluxio with TOS, you can optimize performance by adjusting the following configurations:

  • alluxio.underfs.tos.retry.max: Controls the number of retries with TOS. Default value is 3.

  • alluxio.underfs.tos.read.timeout: Controls read timeout with TOS. Default value is 30000 milliseconds.

  • alluxio.underfs.tos.write.timeout: Controls write timeout with TOS. Default value is 30000 milliseconds.

  • alluxio.underfs.tos.streaming.upload.partition.size: Controls the partition size for TOS streaming upload. Default value is 64MB.

  • alluxio.underfs.tos.connect.timeout: Controls the connection timeout with TOS. Default value is 30000 milliseconds.

Last updated