Use MinIO for shared-data

import SharedDataIntro from '../../_assets/commonMarkdown/sharedDataIntro.mdx' import SharedDataCNconf from '../../_assets/commonMarkdown/sharedDataCNconf.mdx' import SharedDataUseIntro from '../../_assets/commonMarkdown/sharedDataUseIntro.mdx' import SharedDataUse from '../../_assets/commonMarkdown/sharedDataUse.mdx'

Architecture

Deploy a shared-data StarRocks cluster

The deployment of a shared-data StarRocks cluster is similar to that of a shared-nothing StarRocks cluster. The only difference is that you need to deploy CNs instead of BEs in a shared-data cluster. This section only lists the extra FE and CN configuration items you need to add in the configuration files of FE and CN fe.conf and cn.conf when you deploy a shared-data StarRocks cluster. For detailed instructions on deploying a StarRocks cluster, see Deploy StarRocks.

NOTE

Do not start the cluster until after it is configured for shared-storage in the next section of this document.

Configure FE nodes for shared-data StarRocks

Before starting FEs, add the following configuration items in the FE configuration file fe.conf.

Example FE configurations for MinIO

These are example shared-data additions for your fe.conf file on each of your FE nodes. The parameters use the prefix aws_s3.

Properties

run_mode = shared_data
cloud_native_meta_port = <meta_port>
cloud_native_storage_type = S3

# Example: testbucket/subpath
aws_s3_path = <s3_path>

# Example: us-east1
aws_s3_region = <region>

# Example: http://172.26.xx.xxx:39000
aws_s3_endpoint = <endpoint_url>

aws_s3_access_key = <minio_access_key>
aws_s3_secret_key = <minio_secret_key>

run_mode

The running mode of the StarRocks cluster. Valid values:

shared_data
shared_nothing (Default)

NOTE

You cannot adopt the shared_data and shared_nothing modes simultaneously for a StarRocks cluster. Mixed deployment is not supported.

Do not change run_mode after the cluster is deployed. Otherwise, the cluster fails to restart. The transformation from a shared-nothing cluster to a shared-data cluster or vice versa is not supported.

cloud_native_meta_port

The cloud-native meta service RPC port.

Default: 6090

enable_load_volume_from_conf

Whether to allow StarRocks to create the default storage volume by using the object storage-related properties specified in the FE configuration file. Valid values:

true If you specify this item as true when creating a new shared-data cluster, StarRocks creates the built-in storage volume builtin_storage_volume using the object storage-related properties in the FE configuration file, and sets it as the default storage volume. However, if you have not specified the object storage-related properties, StarRocks fails to start.
false (Default) If you specify this item as false when creating a new shared-data cluster, StarRocks starts directly without creating the built-in storage volume. You must manually create a storage volume and set it as the default storage volume before creating any object in StarRocks. For more information, see Create the default storage volume.

Supported from v3.1.0.

cloud_native_storage_type

The type of object storage you use. In shared-data mode, StarRocks supports storing data in Azure Blob (supported from v3.1.1 onwards), and object storages that are compatible with the S3 protocol (such as AWS S3, Google GCP, and MinIO). Valid value:

S3 (Default)
AZBLOB
HDFS

NOTE

If you specify this parameter as S3, you must add the parameters prefixed by aws_s3.

If you specify this parameter as AZBLOB, you must add the parameters prefixed by azure_blob.

If you specify this parameter as HDFS, you must add the parameter cloud_native_hdfs_url.

aws_s3_path

The S3 path used to store data. It consists of the name of your S3 bucket and the sub-path (if any) under it, for example, testbucket/subpath.

aws_s3_endpoint

The endpoint used to access your S3 bucket, for example, https://s3.us-west-2.amazonaws.com.

aws_s3_region

The region in which your S3 bucket resides, for example, us-west-2.

aws_s3_use_aws_sdk_default_behavior

Whether to use the AWS SDK default credentials provider chain. Valid values:

true
false (Default)

aws_s3_use_instance_profile

Whether to use Instance Profile and Assumed Role as credential methods for accessing S3. Valid values:

true
false (Default)

If you use IAM user-based credential (Access Key and Secret Key) to access S3, you must specify this item as false, and specify aws_s3_access_key and aws_s3_secret_key.

If you use Instance Profile to access S3, you must specify this item as true.

If you use Assumed Role to access S3, you must specify this item as true, and specify aws_s3_iam_role_arn.

And if you use an external AWS account, you must also specify aws_s3_external_id.

aws_s3_access_key

The Access Key ID used to access your S3 bucket.

aws_s3_secret_key

The Secret Access Key used to access your S3 bucket.

aws_s3_iam_role_arn

The ARN of the IAM role that has privileges on your S3 bucket in which your data files are stored.

aws_s3_external_id

The external ID of the AWS account that is used for cross-account access to your S3 bucket.

NOTE

Only credential-related configuration items can be modified after your shared-data StarRocks cluster is created. If you changed the original storage path-related configuration items, the databases and tables you created before the change become read-only, and you cannot load data into them.

If you want to create the default storage volume manually after the cluster is created, you only need to add the following configuration items: