You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: docs/cloud/reference/byoc.md
+37-26Lines changed: 37 additions & 26 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -17,6 +17,8 @@ import byoc_vpcpeering4 from '@site/static/images/cloud/reference/byoc-vpcpeerin
17
17
import byoc_plb from '@site/static/images/cloud/reference/byoc-plb.png';
18
18
import byoc_security from '@site/static/images/cloud/reference/byoc-securitygroup.png';
19
19
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';
20
22
21
23
## Overview {#overview}
22
24
@@ -50,9 +52,11 @@ Metrics and logs are stored within the customer's BYOC VPC. Logs are currently s
50
52
51
53
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.
52
54
53
-
### Prepare a Dedicated AWS Account {#prepare-a-dedicated-aws-account}
55
+
### Prepare an AWS Account {#prepare-an-aws-account}
54
56
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.
@@ -68,6 +72,36 @@ After creating the CloudFormation stack, you will be prompted to set up the infr
68
72
-**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.
69
73
-**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.
70
74
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.
2. Under the Security tab on the Details page, find the associated Security Group, which follows a naming pattern like `k8s-istioing-istioing-xxxxxxxxx`.
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
-
<Imageimg={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.
156
167
157
168
---
158
169
The ClickHouse service should now be accessible from the peered VPC.
0 commit comments