How to create an ApsaraDB for ClickHouse cluster-ApsaraDB for ClickHouse-阿里云帮助中心

This topic describes how to create an ApsaraDB for ClickHouse cluster.

Prerequisites

You have created an Alibaba Cloud account. For more information, see Create an Alibaba Cloud Account.
If you use a RAM user to create an ApsaraDB for ClickHouse cluster, the RAM user must have the AliyunClickHouseFullAccess permission. For instructions on how to grant permissions, see Manage RAM user permissions.
You must enable Application Real-Time Monitoring Service (ARMS) when you create a cluster. For more information, see Enable ARMS.
If you want to create a pay-as-you-go cluster, make sure that your Alibaba Cloud account has a balance of at least CNY 100.

Usage notes

By default, an ApsaraDB for ClickHouse cluster created after December 1, 2021 has a CLB instance attached, which incurs fees. For billing details, see Billing of dependent services. If you do not need the CLB instance, release it promptly. For instructions, see Release and attach a CLB instance.

Procedure

Community-compatible edition

Log on to the ApsaraDB for ClickHouse console.
On the Clusters page, select the Clusters of Community-compatible Edition tab, and then click Create Cluster.

On the buy page, select a Product Type.

Product Type

Scenario

Community-compatible Edition Subscription

Creates a Community-compatible Edition cluster that uses the subscription billing method.

The subscription billing method is a prepaid method where you pay when you purchase the cluster. This method is suitable for long-term needs and is more cost-effective than the pay-as-you-go method. The longer the subscription duration, the greater the discount.

Enterprise Edition Serverless & Community-compatible Edition Pay-as-you-go

Creates a Community-compatible Edition cluster that uses the pay-as-you-go billing method or an Enterprise Edition cluster.

The pay-as-you-go billing method is a postpaid method. You are charged on an hourly basis, and a bill is generated every hour.

This method is suitable for short-term needs, such as testing. You can delete the cluster immediately after use to save costs. After your resource usage stabilizes, you can change the billing method of a pay-as-you-go cluster to subscription. To learn how, see Change the billing method.

Configure the following parameters.

Note

When you create an ApsaraDB for ClickHouse Community-compatible Edition cluster, you do not need to configure ZooKeeper specifications. After the cluster is created, a ZooKeeper instance with 4 CPU cores and 8 GB of memory is provided by default at no charge. If the default specifications do not meet your business requirements, upgrade the specifications promptly. For instructions, see Vertical scaling and horizontal scaling for a Community-compatible Edition cluster.

Parameter	Description	Example
Region	Select the region and zone for your cluster. The region is the geographical location of the cluster. You cannot change the region after the cluster is created. We recommend that you select a region that is close to your business to reduce access latency.	Asia Pacific SE 1 (Singapore), Singapore Zone C
Cluster Type	The cluster types supported by ApsaraDB for ClickHouse. This parameter is fixed to Community-compatible Edition.	Community-compatible Edition
Deployment method	Single-zone: Does not support cross-data center disaster recovery. Multi-zone: Supports high availability with disaster recovery across zones. Note Community-compatible Edition clusters use a coupled compute and storage architecture. A multi-zone deployment requires dual replicas, which doubles the compute and storage costs compared to a single-replica deployment. Enterprise Edition clusters use a cloud-native architecture that decouples compute and storage. A multi-zone deployment does not incur additional compute costs or storage resource dependencies.	Single-zone
Network Type	Only Virtual Private Cloud (VPC) is supported. A VPC provides an isolated and secure network environment.	VPC
Zone 1	A zone is a physical area within a region that has independent power and network infrastructure. There is no substantial difference between zones in the same region. Note If you select the multi-zone deployment method, you must also specify Zone 2 and Zone 3. These zones must be different from Zone 1.	Hangzhou Zone H
VPC	The VPC to which the cluster belongs. If no VPC is available, go to the VPC console to create one. Note If you are a RAM user, you must have the AliyunVPCFullAccess permission to create a VPC. For more information about how to grant permissions, see Manage RAM user permissions.	vpc-bp175iuvg8nxqraf2****
vSwitch 1	Select a vSwitch within the selected VPC. If no vSwitch is available, go to the VPC console to create one.	vsw-bp1gzt31twhlo0sa5****
Engine version of current cluster	The version number of the corresponding open source community edition.	23.8
edition	Dual-replica Edition: Each shard contains two replica nodes. If one replica becomes unavailable, the other replica in the same shard continues to provide service. Each piece of data is copied to two different replicas, which ensures data consistency between them. Important When you create a table in a dual-replica cluster, you must use a ReplicatedMergeTree series engine. If you use a non-ReplicatedMergeTree series engine, data is not synchronized between replicas, which can lead to data inconsistency. For more information about how to create a table with a ReplicatedMergeTree series engine, see Create a table. Single-replica Edition: Each shard has only one node. If a node in the cluster becomes unavailable, the entire cluster becomes unavailable. To restore service, you must wait for the node to fully recover. Note The resource and purchase costs for the dual-replica edition are double those of the single-replica edition. The underlying cloud disks provide high reliability, which ensures no data loss even with a single-replica edition.	Dual-replica Edition
Server specification type	The specification type of the cluster. Valid values: Standard Large Storage Important Clusters with large storage specifications are more expensive. Release the cluster promptly after your business testing is complete. For more information, see Delete a cluster.	Standard
Server specifications	The number of CPU cores and memory size of a single node.	8 Cores 32 GB
Server Nodes	The number of nodes in the cluster.	1
Storage Type	The type of disk for data storage. The following list describes common use cases. For more information, see Block Storage performance. ESSD Large online transaction processing (OLTP) databases, such as MySQL, PostgreSQL, Oracle, and SQL Server. NoSQL databases, such as MongoDB, HBase, and Cassandra. Distributed log analysis, such as Elasticsearch, Logstash, and Kibana (ELK). Ultra Disk Development and testing workloads. System disks.	PL1 ESSD (Recommended)
Encryption type	Specifies whether to enable disk encryption. If enabled, the entire data disk is encrypted at the block storage level. Even if backup data is leaked, it cannot be decrypted. For more information, see Disk Encryption.	Disk Encryption
Service-linked role	If you set Encryption Type to Disk Encryption, you must associate a service-linked role to allow access to other Alibaba Cloud services.	Created
Encryption key	When the encryption type is set to Cloud Disk Encryption, you must configure an encryption key. If you have not created a KMS encryption key in the current region, go to the Key Management Service console to create one.	0d2470df-da7b-4786-b981-9a164dae****
Storage space	The storage space of a single node. The total storage space is the single-node storage space multiplied by the number of nodes. If the storage type is cloud disk and the storage space is greater than 2,000 GB, the disk is partitioned into four disks (cdisk 0 to cdisk 3).	100 GB
Subscription duration	If you select the Subscription billing method, you must configure the subscription duration.	1 Month
Auto-renewal	If you select the Subscription billing method, you can enable or disable auto-renewal. If you do not select Auto-renewal when you create the cluster, you can enable automatic or manual renewal in the Renewal console. For more information, see Renewal policy.	Select Auto-renewal
Resource group	Resource groups help you manage resources under your Alibaba Cloud account by category. This allows you to manage permissions, deployment, and monitoring for multiple resources as a group instead of individually.	Default Resource Group
Service Agreement	If you select the Subscription billing method, you must read and agree to the Service Agreement before you can click Buy Now.	Select the Terms of Service

After configuring the parameters, click Buy Now and complete the payment.

Note
It takes 1 to 10 minutes to create a cluster. You can refresh the page to check the status. The cluster is created when its status changes to Running.

Enterprise edition

Log on to the ApsaraDB for ClickHouse console.
On the Clusters page, select the Enterprise Edition Clusters tab, and then click Create Cluster.
On the buy page, set Product Type to Enterprise Edition Serverless & Community-compatible Edition Pay-as-you-go.

Configure the following parameters.

Parameter	Description	Example
Region and zone	The region is the geographical location of the cluster. You cannot change the region after the cluster is created. We recommend that you select a region that is close to your business to reduce access latency. For information about the specific regions that support the Enterprise Edition, see Pay-as-you-go for Enterprise Edition.	China (Hangzhou)
Cluster Type	The cluster types supported by ApsaraDB for ClickHouse. This parameter is fixed to Enterprise Edition.	Enterprise Edition
Deployment method	Single-zone: Does not support cross-data center disaster recovery. Multi-zone: Supports high availability with disaster recovery across zones. Note Community-compatible Edition clusters use a coupled compute and storage architecture. A multi-zone deployment requires dual replicas, which doubles the compute and storage costs compared to a single-replica deployment. Enterprise Edition clusters use a cloud-native architecture that decouples compute and storage. A multi-zone deployment does not incur additional compute costs or storage resource dependencies.	Single-zone
Network Type	Only Virtual Private Cloud (VPC) is supported. A VPC provides an isolated and secure network environment.	VPC
VPC	The VPC to which the cluster belongs. If no VPC is available, go to the VPC console to create one. Note If you are a RAM user, you must have the AliyunVPCFullAccess permission to create a VPC. For more information about how to grant permissions, see Manage RAM user permissions.	vpc-bp175iuvg8nxqraf2****
Zone 1	A zone is a physical area within a region that has independent power and network infrastructure. There is no substantial difference between zones in the same region. Note If you select the multi-zone deployment method, you must also specify Zone 2 and Zone 3. These zones must be different from Zone 1.	Hangzhou Zone H
vSwitch 1	Select a vSwitch within the selected VPC. If no vSwitch is available, go to the VPC console to create one. Note If you select the multi-zone deployment method, you must also specify vSwitch 2 and vSwitch 3. These vSwitches must be different from vSwitch 1.	vsw-bp1gzt31twhlo0sa5****
Minimum Reserved Specs per Server	The minimum number of ClickHouse Compute Units (CCUs) for a node.	4
Maximum Specs per Server	The maximum number of ClickHouse Compute Units (CCUs) for a node. Computing resources scale elastically in increments of CCUs based on cluster load. After a scale-in, the resources cannot be less than the minimum CCU configuration. 1 CCU is approximately equal to 1 core and 4 GiB of memory.	8
Sample data	ApsaraDB for ClickHouse Enterprise Edition clusters can import sample datasets, such as Cell Towers, New York Taxi Data, and UK Property Price Paid. By default, Do Not Import Any Sample Data is selected.	Do Not Import Any Sample Data

After configuring the parameters, click Buy Now and complete the payment.

Note
It takes 1 to 10 minutes to create a cluster. You can refresh the page to check the status. The cluster is created when its status changes to Running.

Checkout

If you purchase a subscription cluster, you can click Add to List after you configure the cluster parameters to pay for multiple products at once. To pay for the orders in the shopping cart, perform the following steps:

On the ApsaraDB for ClickHouse Subscription page, click Cart.
On the Cart page, select the items that you want to purchase and click Buy Now.

Note
You can also change the Quantity and Subscription Duration for the ApsaraDB for ClickHouse cluster.
On the Confirm Order page, read and agree to the terms of service, and then click Pay.
On the Purchase page, click Subscribe.

FAQ

Q: Why can't I find my cluster after I create it?

A: The following table describes the possible causes and solutions.

Possible cause	Description	Solution
Incorrect region selected	The region you are viewing in the console is different from the region where you created the cluster.	In the upper-left corner of the ApsaraDB for ClickHouse console, select the region where the cluster is located.
Incorrect cluster list selected	The cluster list you are viewing does not match the type of cluster you created.	In the ApsaraDB for ClickHouse console, select the correct cluster list tab for your cluster.
Insufficient resources in the zone	Cluster creation might fail due to insufficient resources, resulting in a refund. You can view the refund details in Orders.	After you confirm the refund, try to purchase the cluster again in a different zone.

Next steps

Create an account