-
Notifications
You must be signed in to change notification settings - Fork 454
Add GCP BYO-VPC documentation and split customized setup into per-cloud pages #5739
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Merged
Merged
Changes from 2 commits
Commits
Show all changes
3 commits
Select commit
Hold shift + click to select a range
File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
43 changes: 43 additions & 0 deletions
43
...rastructure/01_deployment_options/byoc/03_onboarding/02_customization/02_gcp.md
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,43 @@ | ||
| --- | ||
| title: 'GCP Customized Setup' | ||
| slug: /cloud/reference/byoc/onboarding/customization-gcp | ||
| sidebar_label: 'GCP Customized Setup' | ||
| keywords: ['BYOC', 'cloud', 'bring your own cloud', 'onboarding', 'GCP', 'VPC'] | ||
| description: 'Deploy ClickHouse BYOC into your existing GCP VPC' | ||
| doc_type: 'reference' | ||
| --- | ||
|
|
||
| import Image from '@theme/IdealImage'; | ||
| import byoc_gcp_subnet from '@site/static/images/cloud/reference/byoc-gcp-subnet.png'; | ||
|
|
||
| ## Customer-managed VPC (BYO-VPC) for GCP {#customer-managed-vpc-gcp} | ||
|
|
||
| If you prefer to use an existing VPC to deploy ClickHouse BYOC instead of having ClickHouse Cloud provision a new VPC, follow the steps below. This approach provides greater control over your network configuration and allows you to integrate ClickHouse BYOC into your existing network infrastructure. | ||
|
|
||
| ### Configure Your Existing VPC {#configure-existing-vpc} | ||
|
|
||
| 1. Allocate at least 1 private subnet in a [region supported by ClickHouse BYOC](/cloud/reference/byoc/supported-regions) for the ClickHouse Kubernetes (GKE) cluster. Ensure the subnet has a minimum CIDR range of `/24` (e.g., 10.0.0.0/24) to provide sufficient IP addresses for GKE cluster nodes. | ||
| 2. Within the private subnet, allocate at least 1 secondary IPv4 range that will be used for GKE cluster pods. The secondary range should be at least `/23` to provide sufficient IP addresses for GKE cluster pods. | ||
| 3. Enable **Private Google Access** on the subnet. This allows GKE nodes to reach Google APIs and services without requiring external IP addresses. | ||
|
|
||
| <Image img={byoc_gcp_subnet} size="lg" alt="BYOC GCP Subnet details showing primary and secondary IPv4 ranges with Private Google Access enabled" /> | ||
|
|
||
| ### Ensure Network Connectivity {#ensure-network-connectivity} | ||
Blargian marked this conversation as resolved.
Outdated
Show resolved
Hide resolved
|
||
|
|
||
| **Cloud NAT Gateway** | ||
| Ensure a [Cloud NAT gateway](https://cloud.google.com/nat/docs/overview) is deployed for the VPC. ClickHouse BYOC components require outbound internet access to communicate with the Tailscale control plane. Tailscale is used to provide secure, zero-trust networking for private management operations. The Cloud NAT gateway provides this outbound connectivity for instances without external IP addresses. | ||
|
|
||
| **DNS Resolution** | ||
| Ensure your VPC has working DNS resolution and doesn't block, interfere with, or overwrite standard DNS names. ClickHouse BYOC relies on DNS to resolve Tailscale control servers as well as ClickHouse service endpoints. If DNS is unavailable or misconfigured, BYOC services may fail to connect or operate properly. | ||
|
|
||
| ### Contact ClickHouse Support {#contact-clickhouse-support} | ||
Blargian marked this conversation as resolved.
Outdated
Show resolved
Hide resolved
|
||
|
|
||
| After completing the above configuration steps, create a support ticket with the following information: | ||
|
|
||
| * Your GCP project ID | ||
| * The GCP region where you want to deploy the service | ||
| * Your VPC network name | ||
| * The subnet name you've allocated for ClickHouse | ||
| * (Optional) The secondary IPv4 range names dedicated for ClickHouse. This is only required if the private subnet has multiple secondary IPv4 ranges and not all of them are intended for ClickHouse use | ||
|
|
||
| Our team will review your configuration and complete the provisioning from our side. | ||
5 changes: 5 additions & 0 deletions
5
.../infrastructure/01_deployment_options/byoc/03_onboarding/02_customization/_category_.json
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,5 @@ | ||
| { | ||
| "label": "Customized Setup", | ||
| "collapsible": true, | ||
| "collapsed": true | ||
| } |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Oops, something went wrong.
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Uh oh!
There was an error while loading. Please reload this page.