Skip to content

Commit 09c75af

Browse files
committed
update README
1 parent c796857 commit 09c75af

File tree

1 file changed

+87
-14
lines changed

1 file changed

+87
-14
lines changed

hologres/README.md

Lines changed: 87 additions & 14 deletions
Original file line numberDiff line numberDiff line change
@@ -2,22 +2,95 @@ Hologres is an all-in-one real-time data warehouse engine that is compatible wit
22

33
To evaluate the performance of Hologres, follow these guidelines to set up and execute the benchmark tests.
44

5-
1. **Instance Purchase**:
6-
Refer to the [Alibaba Cloud Hologres TPC-H Testing Documentation](https://www.alibabacloud.com/help/en/hologres/user-guide/test-plan?spm=a2c63.p38356.help-menu-113622.d_2_14_0_0.54e14f70oTAEXO) for details on purchasing Hologres and ECS instances. Both instances must be purchased within the same region and same zone.
5+
### 1. Create an Alibaba Cloud Account and Provide Your UID
6+
Please first create an Alibaba Cloud account. After registration, kindly provide us with your **UID** (Account ID), which you can find by:
7+
- Clicking on your profile icon in the top-right corner → **Account Center**
8+
We will issue you an **Alibaba Cloud coupon** to support your testing, so please share your UID with us.
79

8-
2. **Benchmark Execution**:
9-
Once the instances are set up, you need to prepare the following parameters:
10-
- `user`: user name for hologres, you can create users on Hologres web console
11-
- `password`: password for hologres, you can set this when create users
12-
- `host_name`: hostname of the Hologres instance, you can find this on Alibaba Cloud Console, you should select VPC network to achieve best performance
13-
- `port`: Port of the Hologres instance (usally '80')
10+
---
1411

15-
And then setup environments variables:
16-
```
17-
export PG_USER={user};export PG_PASSWORD={password};export PG_HOSTNAME={host_name};export PG_PORT={port}
18-
```
12+
### 2. Purchase an Alibaba Cloud Hologres and ECS Instance
13+
Refer to the [Alibaba Cloud Hologres TPC-H Testing Documentation](https://www.alibabacloud.com/help/en/hologres/user-guide/test-plan?spm=a2c63.p38356.help-menu-113622.d_2_14_0_0.54e14f70oTAEXO) for details on purchasing Hologres and ECS instances. Both instances must be purchased within the same region and same zone.
14+
15+
#### 2.1 When creating the Hologres instance, please use the following configuration:
16+
17+
- **Region**: `China (Beijing)`
18+
*(The new version is in gray-scale release in China (Beijing). Choosing this region ensures you can access the latest features)*
19+
- **Specifications**: ✅ **Compute Group Type**
20+
- **Zone**: `Zone L`
21+
- **Gateway Nodes**: `2 Pieces`
22+
- **Reserved Computing Resources of Virtual Warehouse**: `32 CU`
23+
*(This is the actual compute unit (CU) value used in the JSON result files.)*
24+
- **Allocate to Initial Virtual Warehouse**: `Yes`
25+
- **Enable Serverless Computing**: ✅ **True (Enabled)**
26+
- **Storage Redundancy Type**: `LRS `
27+
- **VPC & vSwitch**:
28+
- You need to **create a new VPC**.
29+
- Region: `China (Beijing)`
30+
- Name: Any name you prefer
31+
- IPv4 CIDR Block: Select "Manually enter" and use one of the recommended values
32+
- IPv6 CIDR Block: `Do Not Assign`
33+
- During VPC creation, you’ll also create a **vSwitch**:
34+
- Name: Any name
35+
- Zone: `Beijing Zone L`
36+
- IPv4 CIDR: Automatically filled based on VPC CIDR
37+
> 💡 A **VPC (Virtual Private Cloud)** is a private network in the cloud. The **vSwitch** is a subnet within the VPC. We need both Hologres and ECS instances in the same VPC for fast internal communication.
38+
- **Instance Name**: Choose any name
39+
- **Service-linked Role**: Click **Create**
40+
41+
Once everything is configured and you’ve received the coupon, click **Buy Now** to proceed.
42+
43+
#### 2.2 When creating the ECS instance, please use the following configuration:
44+
- **Billing Method**: `Pay-as-you-go` (you can release it after testing)
45+
- **Region**: `China (Beijing)`
46+
- **Network & Security Group**:
47+
- VPC: Select the one you just created
48+
- vSwitch: Automatically populated
49+
- **Instance Type**:
50+
- Series: `Compute Optimized c9i`
51+
- Instance: `ecs.c9i.4xlarge` (16 vCPUs, 32 GiB RAM)
52+
*(This is not performance-critical — it only runs the client script.)*
53+
- **Image**:
54+
- `Alibaba Cloud Linux``Alibaba Cloud Linux 3.2104 LTS 64-bit`
55+
- **System Disk**:
56+
- Size: `2048 GiB`
57+
- Performance: `PL3`
58+
*(Larger and faster disk improves import speed since we’re loading ~70GB of TSV data. IO on the ECS can be a bottleneck.)*
59+
- **Public IP Address**: ✅ Assign Public IPv4 Address
60+
- **Management Settings**:
61+
- Logon Credential: `Custom Password`
62+
- Username: `root`
63+
- Set a secure password
64+
65+
Click **Create Order** to launch the instance.
66+
67+
---
1968

20-
3. **Sample Execution**:
69+
### 3. Connect to the ECS and Run the Benchmark
70+
71+
After the ECS instance is ready:
72+
73+
1. SSH into the ECS instance.
74+
2. Install Git and clone the repo:
2175
```bash
22-
./main.sh 5 /root/bluesky
76+
yum -y install git
77+
git clone https://github.com/ClickHouse/JSONBench.git
78+
cd JSONBench/hologres
79+
```
80+
3. Run the benchmark script:
81+
```
82+
export PG_USER={AccessKeyID};export PG_PASSWORD={AccessKeySecret};export PG_HOSTNAME={Host};export PG_PORT={Port}
83+
./main.sh 5 {your_bluesky_data_dir}
2384
```
85+
86+
- **AccessKeyID & AccessKeySecret**:
87+
Go to the Alibaba Cloud Console → Profile Icon → **AccessKey** → Create one if needed.
88+
89+
You can also create a hologres user (Click your instance to enter instance detail page -> click "Account Management" -> "Create Custom User" -> Choose "Superuser") and use the username and password for PG_USER and PG_PASSWORD.
90+
- **Host & Port**:
91+
In the Hologres console, click your instance ID → Copy the **VPC Endpoint** (e.g., `hgxxx-cn-beijing-vpc.hologres.aliyuncs.com:xxxx`).
92+
- `Host` = domain without port (e.g., `hgxxx-cn-beijing-vpc.hologres.aliyuncs.com`)
93+
- `Port` = the number after `:`
94+
95+
---
96+

0 commit comments

Comments
 (0)