Skip to content

Commit 1566c82

Browse files
authored
Merge pull request #3831 from ClickHouse/byoc-edit
Update byoc.md
2 parents 5997fda + 57b49c5 commit 1566c82

File tree

3 files changed

+37
-26
lines changed

3 files changed

+37
-26
lines changed

docs/cloud/reference/byoc.md

Lines changed: 37 additions & 26 deletions
Original file line numberDiff line numberDiff line change
@@ -17,6 +17,8 @@ import byoc_vpcpeering4 from '@site/static/images/cloud/reference/byoc-vpcpeerin
1717
import byoc_plb from '@site/static/images/cloud/reference/byoc-plb.png';
1818
import byoc_security from '@site/static/images/cloud/reference/byoc-securitygroup.png';
1919
import byoc_inbound from '@site/static/images/cloud/reference/byoc-inbound-rule.png';
20+
import byoc_subnet_1 from '@site/static/images/cloud/reference/byoc-subnet-1.png';
21+
import byoc_subnet_2 from '@site/static/images/cloud/reference/byoc-subnet-2.png';
2022

2123
## Overview {#overview}
2224

@@ -50,9 +52,11 @@ Metrics and logs are stored within the customer's BYOC VPC. Logs are currently s
5052

5153
Customers can initiate the onboarding process by reaching out to [us](https://clickhouse.com/cloud/bring-your-own-cloud). Customers need to have a dedicated AWS account and know the region they will use. At this time, we are allowing users to launch BYOC services only in the regions that we support for ClickHouse Cloud.
5254

53-
### Prepare a Dedicated AWS Account {#prepare-a-dedicated-aws-account}
55+
### Prepare an AWS Account {#prepare-an-aws-account}
5456

55-
Customers must prepare a dedicated AWS account for hosting the ClickHouse BYOC deployment to ensure better isolation. With this and the initial organization admin email, you can contact ClickHouse support.
57+
Customers are recommended to prepare a dedicated AWS account for hosting the ClickHouse BYOC deployment to ensure better isolation. However, using a shared account and an existing VPC is also possible. See the details in *Setup BYOC Infrastructure* below.
58+
59+
With this account and the initial organization admin email, you can contact ClickHouse support.
5660

5761
### Apply CloudFormation Template {#apply-cloudformation-template}
5862

@@ -68,6 +72,36 @@ After creating the CloudFormation stack, you will be prompted to set up the infr
6872
- **The VPC CIDR range for BYOC**: By default, we use `10.0.0.0/16` for the BYOC VPC CIDR range. If you plan to use VPC peering with another account, ensure the CIDR ranges do not overlap. Allocate a proper CIDR range for BYOC, with a minimum size of `/22` to accommodate necessary workloads.
6973
- **Availability Zones for BYOC VPC**: If you plan to use VPC peering, aligning availability zones between the source and BYOC accounts can help reduce cross-AZ traffic costs. In AWS, availability zone suffixes (`a, b, c`) may represent different physical zone IDs across accounts. See the [AWS guide](https://docs.aws.amazon.com/prescriptive-guidance/latest/patterns/use-consistent-availability-zones-in-vpcs-across-different-aws-accounts.html) for details.
7074

75+
#### Customer-managed VPC {#customer-managed-vpc}
76+
By default, ClickHouse Cloud will provision a dedicated VPC for better isolation in your BYOC deployment. However, you can also use an existing VPC in your account. This requires specific configuration and must be coordinated through ClickHouse Support.
77+
78+
**Configure Your Existing VPC**
79+
1. Allocate at least 3 private subnets across 3 different availability zones for ClickHouse Cloud to use.
80+
2. Ensure each subnet has a minimum CIDR range of `/23` (e.g., 10.0.0.0/23) to provide sufficient IP addresses for the ClickHouse deployment.
81+
3. Add the tag `kubernetes.io/role/internal-elb=1` to each subnet to enable proper load balancer configuration.
82+
83+
<br />
84+
85+
<Image img={byoc_subnet_1} size="lg" alt="BYOC VPC Subnet" background='black'/>
86+
87+
<br />
88+
89+
<br />
90+
91+
<Image img={byoc_subnet_2} size="lg" alt="BYOC VPC Subnet Tags" background='black'/>
92+
93+
<br />
94+
95+
**Contact ClickHouse Support**
96+
Create a support ticket with the following information:
97+
98+
* Your AWS account ID
99+
* The AWS region where you want to deploy the service
100+
* Your VPC ID
101+
* The Private Subnet IDs you've allocated for ClickHouse
102+
* The availability zones these subnets are in
103+
104+
71105
### Optional: Setup VPC Peering {#optional-setup-vpc-peering}
72106

73107
To create or delete VPC peering for ClickHouse BYOC, follow the steps:
@@ -129,30 +163,7 @@ In the peering AWS account,
129163
<br />
130164

131165
#### Step 6 Edit Security Group to allow Peered VPC access {#step-6-edit-security-group-to-allow-peered-vpc-access}
132-
In ClickHouse BYOC account,
133-
1. In the ClickHouse BYOC account, navigate to EC2 and locate the Private Load Balancer named like infra-xx-xxx-ingress-private.
134-
135-
<br />
136-
137-
<Image img={byoc_plb} size="lg" alt="BYOC Private Load Balancer" border />
138-
139-
<br />
140-
141-
2. Under the Security tab on the Details page, find the associated Security Group, which follows a naming pattern like `k8s-istioing-istioing-xxxxxxxxx`.
142-
143-
<br />
144-
145-
<Image img={byoc_security} size="lg" alt="BYOC Private Load Balancer Security Group" border />
146-
147-
<br />
148-
149-
3. Edit the Inbound Rules of this Security Group and add the Peered VPC CIDR range (or specify the required CIDR range as needed).
150-
151-
<br />
152-
153-
<Image img={byoc_inbound} size="lg" alt="BYOC Security Group Inbound Rule" border />
154-
155-
<br />
166+
In the ClickHouse BYOC account, you need to update the Security Group settings to allow traffic from your peered VPC. Please contact ClickHouse Support to request the addition of inbound rules that include the CIDR ranges of your peered VPC.
156167

157168
---
158169
The ClickHouse service should now be accessible from the peered VPC.
214 KB
Loading
97.4 KB
Loading

0 commit comments

Comments
 (0)