Skip to content

Commit 98bfd58

Browse files
authored
Merge pull request #3212 from ClickHouse/byoc-vpc-peering
2 parents f7f7ea2 + be321aa commit 98bfd58

File tree

6 files changed

+62
-18
lines changed

6 files changed

+62
-18
lines changed

docs/en/cloud/reference/byoc.md

Lines changed: 62 additions & 18 deletions
Original file line numberDiff line numberDiff line change
@@ -62,37 +62,81 @@ After creating the CloudFormation stack, you will be prompted to set up the infr
6262

6363
### Optional: Setup VPC Peering
6464

65-
To create or delete VPC peering for ClickHouse BYOC, submit a ticket with the following details:
65+
To create or delete VPC peering for ClickHouse BYOC, follow the steps:
6666

67-
- ClickHouse BYOC name for the VPC peering request.
68-
- VPC ID (`vpc-xxxxxx`) to peer with the BYOC VPC.
69-
- CIDR range of the VPC.
70-
- AWS account owning the peering VPC.
71-
- AWS region of the VPC.
67+
#### Step 1 Create a peering connection
68+
1. Navigate to the VPC Dashboard in ClickHouse BYOC account.
69+
2. Select Peering Connections.
70+
3. Click Create Peering Connection
71+
4. Set the VPC Requester to the ClickHouse VPC ID.
72+
5. Set the VPC Acceptor to the target VPC ID. (Select another account if applicable)
73+
6. Click Create Peering Connection.
7274

73-
Once the support ticket is received and processed, you will need to complete a few steps in your AWS account to finalize the peering setup:
75+
<br />
76+
77+
<img src={require('./images/byoc-vpcpeering-1.png').default}
78+
alt='BYOC Create Peering Connection'
79+
class='image'
80+
style={{width: '800px'}}
81+
/>
82+
83+
<br />
84+
85+
#### Step 2 Accept the peering connection request
86+
Go to the peering account, in the (VPC -> Peering connections -> Actions -> Accept request) page customer can approve this VPC peering request.
87+
88+
<br />
89+
90+
<img src={require('./images/byoc-vpcpeering-2.png').default}
91+
alt='BYOC Accept Peering Connection'
92+
class='image'
93+
style={{width: '800px'}}
94+
/>
7495

75-
1. Accept the VPC peering request in the AWS account of the peered VPC.
76-
- Navigate to **VPC -> Peering connections -> Actions -> Accept request**.
96+
<br />
7797

78-
2. Adjust the route table for the peered VPC:
79-
- Locate the subnet in the peered VPC that needs to connect to the ClickHouse instance.
80-
- Edit the subnet's route table and add a route with the following configuration:
81-
- **Destination**: ClickHouse BYOC VPC CIDR (e.g., `10.0.0.0/16`)
82-
- **Target**: Peering Connection (`pcx-12345678`, the actual ID will appear in the dropdown list)
98+
#### Step 3 Add destination to ClickHouse VPC route tables
99+
In ClickHouse BYOC account,
100+
1. Select Route Tables in the VPC Dashboard.
101+
2. Search for the ClickHouse VPC ID. Edit each route table attached to the private subnets.
102+
3. Click the Edit button under the Routes tab.
103+
4. Click Add another route.
104+
5. Enter the CIDR range of the target VPC for the Destination.
105+
6. Select “Peering Connection” and the ID of the peering connection for the Target.
83106

84107
<br />
85108

86-
<img src={require('./images/byoc-2.png').default}
87-
alt='BYOC network configuration'
109+
<img src={require('./images/byoc-vpcpeering-3.png').default}
110+
alt='BYOC Add route table'
88111
class='image'
89-
style={{width: '600px'}}
112+
style={{width: '800px'}}
90113
/>
91114

92115
<br />
93116

94-
3. Check existing security groups and ensure no rules block access to the BYOC VPC.
117+
#### Step 4 Add destination to the target VPC route tables
118+
In the peering AWS account,
119+
1. Select Route Tables in the VPC Dashboard.
120+
2. Search for the target VPC ID.
121+
3. Click the Edit button under the Routes tab.
122+
4. Click Add another route.
123+
5. Enter the CIDR range of the ClickHouse VPC for the Destination.
124+
6. Select “Peering Connection” and the ID of the peering connection for the Target.
95125

126+
<br />
127+
128+
<img src={require('./images/byoc-vpcpeering-4.png').default}
129+
alt='BYOC Add route table'
130+
class='image'
131+
style={{width: '800px'}}
132+
/>
133+
134+
<br />
135+
136+
#### Step 5 Enable Private Load Balancer for ClickHouse BYOC
137+
Contact ClickHouse support to enable Private Load Balancer.
138+
139+
---
96140
The ClickHouse service should now be accessible from the peered VPC.
97141

98142
To access ClickHouse privately, a private load balancer and endpoint are provisioned for secure connectivity from the user's peered VPC. The private endpoint follows the public endpoint format with a `-private` suffix. For example:
-59.8 KB
Binary file not shown.
183 KB
Loading
50.3 KB
Loading
23.2 KB
Loading
18.1 KB
Loading

0 commit comments

Comments
 (0)