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 on the international site (alibabacloud.com).
If you use a RAM user to create an ApsaraDB for ClickHouse cluster, you must grant the AliyunClickHouseFullAccess permission to the RAM user. For more information, see Grant permissions to a RAM user.
You have activated Application Real-Time Monitoring Service (ARMS). For more information, see Activate ARMS.

Usage notes

By default, a Classic Load Balancer (CLB) instance is attached to an ApsaraDB for ClickHouse cluster created after December 1, 2021, and you are charged for the instance. For more information about billing, see Billing of dependent services. If you do not need the CLB instance, release it promptly. For more information, see Release and attach a CLB instance.

Procedure

Create a Community-compatible Edition cluster

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

Create 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

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

The pay-as-you-go billing method allows you to use resources before you pay for them. The system generates a bill per hour for the resources. This billing method is cost-effective for business scenarios that require access to resources for short periods of time, such as testing. You can release an ApsaraDB for ClickHouse cluster based on your business requirements to save costs. When you can accurately estimate the amount of resources that you need each month or each year, you can change the billing method from pay-as-you-go to subscription. For more information, see Change the billing method.

Configure the parameters as prompted.

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.

Parameter	Description	Example
Region and Zone	Select the region and zone where the cluster is located. The region is the geographical location of the cluster. You cannot change the region after the purchase. Select a region close to your business to improve access speed.	Asia Pacific, Singapore, Singapore Zone C
Cluster Type	The cluster types that ApsaraDB for ClickHouse supports. This is fixed to Community-compatible Edition.	Community-compatible Edition
Deployment Method	Single-zone: Disaster recovery across data centers is not supported. Multi-zone: Zone-disaster recovery is supported for high availability. Note The Community-compatible Edition integrates storage and computing. Multi-zone deployment requires dual replicas. The computing and storage costs are twice those of a single replica. The Enterprise Edition is based on a cloud-native architecture that decouples computing and storage. Multi-zone deployment does not incur additional computing costs or storage resource dependencies.	Single-zone
Network Type	Currently, only virtual private cloud (VPC) is supported. A VPC is an isolated network environment that provides high security.	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 scheme, you must also specify Zone 2 and Zone 3. These zones must be different from Zone 1.	Hangzhou Zone H
VPC	The VPC. If no VPC is available, go to the VPC console to create one. Note If you are a RAM user, you need the AliyunVPCFullAccess permission to create a VPC. For more information about how to grant permissions, see Grant permissions to a RAM user.	vpc-bp175iuvg8nxqraf2****
VSwitch 1	Select a vSwitch in the VPC. If no vSwitch is available, go to the VPC console to create one.	vsw-bp1gzt31twhlo0sa5****
Engine Version of Current Cluster	The corresponding open source community version number.	23.8
Edition	Double-replica Edition: Each shard contains two replica nodes. If a replica becomes unavailable, the other replica in the same shard can continue to provide services. When set to dual-replica, each piece of data is copied to two different replicas, ensuring the data between them is identical. Important When you create a table in a dual-replica cluster, you must use a ReplicatedMergeTree series engine. If you create a table with a non-ReplicatedMergeTree series engine in a dual-replica cluster, data synchronization between replicas will fail, which may 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 ensure the cluster continues to provide stable services, you must wait for the node to fully recover. Note* The resources and corresponding purchase costs for the dual-replica edition are twice those of the single-replica edition. Because the underlying disks provide high reliability, even the single-replica edition ensures that no data is lost.	Dual-replica edition
Server Specifications	The number of CPU cores and memory size of a single node.	8 Cores 32 GB
Server Nodes	The number of nodes.	1
Storage Type	The type of storage disk. The following list describes common scenarios. For more information, see Block storage performance. ESSD Large online transactional processing (OLTP) databases, such as relational databases like MySQL, PostgreSQL, Oracle, and SQL Server. NoSQL databases, such as non-relational databases like MongoDB, HBase, and Cassandra. Elasticsearch distributed logs, such as ELK (Elasticsearch, Logstash, and Kibana) log analysis. Ultra Disk Development and testing services. System disks.	PL1 ESSD (Recommended)
Encryption Type	Specifies whether to enable disk encryption. If enabled, the entire data disk is encrypted based on block storage. 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 cloud services.	Created
Encryption Key	If you set Encryption Type to Disk Encryption, you must configure an encryption key. If you have not created a KMS key in the current region, go to the Key Management Service console to create one.	0d2470df-da7b-4786-b981-9a164dae****
Storage Capacity	The storage space of a single node. Total storage space = Number of nodes × Storage space of a single node. If the storage type is 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 Period	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 select whether to enable auto-renewal as needed. If you do not select Auto-renewal when creating 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 in categories. You can manage permissions, deploy resources, and monitor resources by group, without needing to handle each resource individually.	Default Resource Group

After you configure the parameters, click Buy Now and complete the payment.
Note
The cluster creation process takes 1 to 10 minutes. You can refresh the page to check the status. The cluster is created when its status changes from Creating to Running.

Create an Enterprise Edition cluster

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 parameters as prompted.

Parameter	Description	Example
Region	The region is the geographical location of the cluster. You cannot change the region after the purchase. Select a region close to your business to improve access speed. For information about the specific regions that support the Enterprise Edition, see Pay-as-you-go billing for Enterprise Edition.	China, China (Hangzhou)
Cluster Type	The cluster types that ApsaraDB for ClickHouse supports. This is fixed to Enterprise Edition. Important If the Enterprise Edition option is not available in the console, submit a ticket to determine whether the location of your company is within the sales area of ApsaraDB for ClickHouse Enterprise Edition. If your company is located in the sales area: We will add you to a whitelist to enable this option. If your company is not located in the sales area: You cannot create an Enterprise Edition cluster.	Enterprise Edition
Deployment Method	Single-zone: Disaster recovery across data centers is not supported. Multi-zone: Zone-disaster recovery is supported for high availability. Note The Community-compatible Edition integrates storage and computing. Multi-zone deployment requires dual replicas. The computing and storage costs are twice those of a single replica. The Enterprise Edition is based on a cloud-native architecture that decouples computing and storage. Multi-zone deployment does not incur additional computing costs or storage resource dependencies.	Single-zone
Network Type	Currently, only virtual private cloud (VPC) is supported. A VPC is an isolated network environment that provides high security.	VPC
VPC	The VPC. If no VPC is available, go to the VPC console to create one. Note If you are a RAM user, you need the AliyunVPCFullAccess permission to create a VPC. For more information about how to grant permissions, see Grant permissions to a RAM user.	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 scheme, 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 in the VPC. If no vSwitch is available, go to the VPC console to create one. Note If you select the multi-zone deployment scheme, you must also specify VSwitch 2 and VSwitch 3. These vSwitches must be different from VSwitch 1.	vsw-bp1gzt31twhlo0sa5****
Sample Test Data	ApsaraDB for ClickHouse Enterprise Edition clusters support importing sample data, 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
Maximum Specs per Server	The maximum number of CCUs for the cluster. Computing resources are elastically scaled based on the cluster payload at the granularity of CCUs. The resources after a scale-in cannot be less than the minimum CCU configuration. 1 CCU is approximately equal to 1 CPU core and 4 GB of memory.	8
Minimum Reserved Specs per Server	The minimum number of CCUs for the cluster. Note If Maximum ClickHouse Compute Units (CCUs) is 8 CCU, Minimum ClickHouse Compute Units (CCUs) is fixed at 8 CCU. If Maximum ClickHouse Compute Units (CCUs) is greater than 8 CCU, the value range for Minimum ClickHouse Compute Units (CCUs) is 8 CCU to the maximum number of CCUs. You can slide to select a suitable number of CCUs as needed.	8

After you configure the parameters, click Buy Now and complete the payment.
Note
The cluster creation process takes 1 to 10 minutes. You can refresh the page to check the status. The cluster is created when its status changes from Creating to Running.

Shopping cart 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 right side of the page.
On the Default List page, select the products that you want to purchase and click Purchase/Create.
Note
You can also change the Quantity for the ApsaraDB for ClickHouse cluster.
On the Confirm Order page, read and select 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	A newly created cluster may fail to be created due to insufficient resources, which results in a refund. You can view the refund in Order Management.	After you confirm the refund, try to purchase the cluster again in a different zone.

What to do next

Create an account