chore(byoc): Refactor BYOC private networking setup docs by duanshiqiang · Pull Request #5780 · ClickHouse/clickhouse-docs

duanshiqiang · 2026-03-19T04:24:10Z

Summary

This PR mainly adds GCP private networking setup besides AWS to current BYOC docs.

Checklist

Delete items not relevant to your PR
URL changes should add a redirect to the old URL via https://github.com/ClickHouse/clickhouse-docs/blob/main/docusaurus.config.js
If adding a new integration page, also add an entry to the integrations list here: https://github.com/ClickHouse/clickhouse-docs/blob/main/docs/integrations/index.mdx

vercel · 2026-03-19T04:24:15Z

The latest updates on your projects. Learn more about Vercel for GitHub.

Project	Deployment	Actions	Updated (UTC)
clickhouse-docs	Ready	Preview	Mar 26, 2026 1:16am
clickhouse-docs-ko	Ready	Preview, Comment	Mar 26, 2026 1:16am
clickhouse-docs-ru	Ready	Preview, Comment	Mar 26, 2026 1:16am
clickhouse-docs-zh	Ready	Preview, Comment	Mar 26, 2026 1:16am

1 Skipped Deployment

Project	Deployment	Actions	Updated (UTC)
clickhouse-docs-jp	Ignored		Mar 26, 2026 1:16am

dhtclk

Great work, just a few comments!

dhtclk · 2026-03-26T16:34:15Z

...ud/guides/infrastructure/01_deployment_options/byoc/03_onboarding/03_network_setup/02_gcp.md

+import byoc_vpcpeering3 from '@site/static/images/cloud/reference/byoc-vpcpeering-gcp-3.png';
+import byoc_privatelink_1 from '@site/static/images/cloud/reference/byoc-privatelink-gcp-1.png';
+import byoc_privatelink_2 from '@site/static/images/cloud/reference/byoc-privatelink-gcp-2.png';
+import byoc_privatelink_3 from '@site/static/images/cloud/reference/byoc-privatelink-gcp-2.png';


Suggested change

import byoc_privatelink_3 from '@site/static/images/cloud/reference/byoc-privatelink-gcp-2.png';

import byoc_privatelink_3 from '@site/static/images/cloud/reference/byoc-privatelink-gcp-3.png';

Want to make sure we're linking to the proper screenshot here?

dhtclk · 2026-03-26T16:36:50Z

...ud/guides/infrastructure/01_deployment_options/byoc/03_onboarding/03_network_setup/02_gcp.md

+The PSC endpoint format is similar to the public endpoint, but includes a `p` subdomain. For example:
+
+- **Public endpoint**: `h5ju65kv87.mhp0y4dmph.us-east1.gcp.clickhouse-byoc.com`
+- **PrivateLink endpoint**: `h5ju65kv87.p.mhp0y4dmph.us-east1.gcp.clickhouse-byoc.com`


Isn't PrivateLink AWS specific terminology? Should we change this?

dhtclk · 2026-03-26T16:37:22Z

...ud/guides/infrastructure/01_deployment_options/byoc/03_onboarding/03_network_setup/02_gcp.md

+
+### Obtain GCP PSC service name and DNS name {#step-2-obtain-gcp-service-attachment-and-dns-name-for-private-service-connect}
+
+ClickHouse Support will provide you with the PSC Service name. You can also obtain it in the ClickHouse Cloud console, under "Orgainzation" -> "Infrastructure", click into the infra name to see the details.


Suggested change

ClickHouse Support will provide you with the PSC Service name. You can also obtain it in the ClickHouse Cloud console, under "Orgainzation" -> "Infrastructure", click into the infra name to see the details.

ClickHouse Support will provide you with the PSC Service name. You can also obtain it in the ClickHouse Cloud console, under "Organization" -> "Infrastructure", click into the infra name to see the details.

dhtclk · 2026-03-26T16:37:45Z

...ud/guides/infrastructure/01_deployment_options/byoc/03_onboarding/03_network_setup/02_gcp.md

+<Image img={byoc_privatelink_3} size="lg" alt="BYOC PSC Endpoint" border />
+<Image img={byoc_privatelink_4} size="lg" alt="BYOC PSC Endpoint" border />
+
+### Create an PSC endpoint in your Network {#step-3-create-endpoint}


Suggested change

### Create an PSC endpoint in your Network {#step-3-create-endpoint}

### Create a PSC endpoint in your network {#step-3-create-endpoint}

dhtclk · 2026-03-26T16:38:05Z

...ud/guides/infrastructure/01_deployment_options/byoc/03_onboarding/03_network_setup/02_gcp.md

+- Input a valid endpoint name
+- Choose your network and select subnets (This is the network where your client application will be connecting from)
+- Choose or create a new IP address for the endpoint, the IP address needs to be used by step [Set private DNS name for endpoint](#step-4-set-private-dns-name-for-endpoint)
+- Click "Add Endpoint", wait a momemt for the endpoint to be created.


Suggested change

- Click "Add Endpoint", wait a momemt for the endpoint to be created.

- Click "Add Endpoint", wait a moment for the endpoint to be created.

dhtclk · 2026-03-26T16:39:30Z

...ud/guides/infrastructure/01_deployment_options/byoc/03_onboarding/03_network_setup/02_gcp.md

+
+To create or delete VPC peering for ClickHouse BYOC, follow the steps:
+
+> The example steps are for a simple scenario, for advanced scenarios such as peering with on-premises connectivity, some adjustments may required.


Suggested change

> The example steps are for a simple scenario, for advanced scenarios such as peering with on-premises connectivity, some adjustments may required.

> The example steps are for a simple scenario, for advanced scenarios such as peering with on-premises connectivity, some adjustments may be required.

dhtclk · 2026-03-26T16:40:42Z

...oud/guides/infrastructure/01_deployment_options/byoc/03_onboarding/03_network_setup/index.md

+---
+title: 'Private networking setup'
+slug: /cloud/reference/byoc/onboarding/network
+hide_title: true


Suggested change

hide_title: true

sidebar_label: 'Private networking setup'

hide_title: true

dhtclk · 2026-03-26T16:42:16Z

docs/cloud/guides/index.md

 | [AWS PrivateLink](/manage/security/aws-privatelink) | This document describes how to connect to ClickHouse Cloud using AWS PrivateLink. |
 | [Azure Private Link](/cloud/security/azure-privatelink) | How to set up Azure Private Link |
 | [Azure Private Preview](/cloud/reference/byoc/onboarding/azure-private-preview) | Onboard ClickHouse BYOC on Azure using the Terraform module and cross-tenant authentication |
+| [BYOC AWS private networking setup](/cloud/reference/byoc/onboarding/network-aws) | Deploy ClickHouse on your own cloud infrastructure |


Suggested change

| [BYOC AWS private networking setup](/cloud/reference/byoc/onboarding/network-aws) | Deploy ClickHouse on your own cloud infrastructure |

| [BYOC AWS private networking setup](/cloud/reference/byoc/onboarding/network-aws) | Set up VPC Peering or PrivateLink for BYOC on AWS |

More specific descriptions may help users can the table.

dhtclk · 2026-03-26T16:42:39Z

docs/cloud/guides/index.md

 | [Azure Private Preview](/cloud/reference/byoc/onboarding/azure-private-preview) | Onboard ClickHouse BYOC on Azure using the Terraform module and cross-tenant authentication |
+| [BYOC AWS private networking setup](/cloud/reference/byoc/onboarding/network-aws) | Deploy ClickHouse on your own cloud infrastructure |
 | [BYOC FAQ](/cloud/reference/byoc/reference/faq) | Deploy ClickHouse on your own cloud infrastructure |
+| [BYOC GCP private networking setup](/cloud/reference/byoc/onboarding/network-gcp) | Deploy ClickHouse on your own cloud infrastructure |


Suggested change

| [BYOC GCP private networking setup](/cloud/reference/byoc/onboarding/network-gcp) | Deploy ClickHouse on your own cloud infrastructure |

| [BYOC GCP private networking setup](/cloud/reference/byoc/onboarding/network-gcp) | Set up VPC Peering or Private Service Connect for BYOC on GCP |

dhtclk · 2026-03-26T16:44:21Z

...ud/guides/infrastructure/01_deployment_options/byoc/03_onboarding/03_network_setup/02_gcp.md

+### Enable private load balancer for ClickHouse BYOC {#step-enable-private-load-balancer-for-clickhouse-byoc}
+Contact ClickHouse Support to enable Private Load Balancer.
+
+## Setup VPC peering {#gcp-vpc-peering}


Consider wrapping steps in <VerticalStepper headerLevel="h3"> like in the aws page for consistency.

duanshiqiang force-pushed the feature-gcp-private-connect branch from 9f1ab77 to 7545b46 Compare March 19, 2026 05:03

vercel bot deployed to Preview – clickhouse-docs March 19, 2026 05:14 View deployment

duanshiqiang force-pushed the feature-gcp-private-connect branch from 7545b46 to 762f499 Compare March 20, 2026 09:21

vercel bot had a problem deploying to Preview – clickhouse-docs March 20, 2026 09:22 Failure

duanshiqiang force-pushed the feature-gcp-private-connect branch from 762f499 to 0295fb4 Compare March 20, 2026 09:23

vercel bot deployed to Preview – clickhouse-docs March 20, 2026 09:37 View deployment

duanshiqiang force-pushed the feature-gcp-private-connect branch from 0295fb4 to 4e960f2 Compare March 22, 2026 01:50

vercel bot deployed to Preview – clickhouse-docs March 22, 2026 02:00 View deployment

duanshiqiang force-pushed the feature-gcp-private-connect branch from 4e960f2 to ec9ef4a Compare March 22, 2026 02:10

vercel bot had a problem deploying to Preview – clickhouse-docs March 22, 2026 02:11 Failure

duanshiqiang force-pushed the feature-gcp-private-connect branch from ec9ef4a to b801267 Compare March 22, 2026 03:01

vercel bot had a problem deploying to Preview – clickhouse-docs March 22, 2026 03:10 Failure

duanshiqiang force-pushed the feature-gcp-private-connect branch from b801267 to 9c81118 Compare March 24, 2026 04:27

vercel bot had a problem deploying to Preview – clickhouse-docs March 24, 2026 04:36 Failure

duanshiqiang force-pushed the feature-gcp-private-connect branch 2 times, most recently from 631984b to 8a9092c Compare March 24, 2026 04:48

vercel bot deployed to Preview – clickhouse-docs March 24, 2026 05:06 View deployment

duanshiqiang force-pushed the feature-gcp-private-connect branch from 8a9092c to 56eb099 Compare March 24, 2026 06:05

vercel bot had a problem deploying to Preview – clickhouse-docs March 24, 2026 06:14 Failure

duanshiqiang force-pushed the feature-gcp-private-connect branch from 56eb099 to cf5b585 Compare March 24, 2026 06:29

vercel bot deployed to Preview – clickhouse-docs March 24, 2026 06:39 View deployment

duanshiqiang force-pushed the feature-gcp-private-connect branch 3 times, most recently from e0f83c0 to cfc6ce2 Compare March 24, 2026 06:44

vercel bot deployed to Preview – clickhouse-docs March 24, 2026 07:02 View deployment

duanshiqiang force-pushed the feature-gcp-private-connect branch from cfc6ce2 to 6feaabc Compare March 25, 2026 01:27

vercel bot had a problem deploying to Preview – clickhouse-docs March 25, 2026 01:28 Failure

duanshiqiang force-pushed the feature-gcp-private-connect branch from 6feaabc to aea5aa2 Compare March 25, 2026 04:14

vercel bot had a problem deploying to Preview – clickhouse-docs March 25, 2026 04:15 Failure

duanshiqiang force-pushed the feature-gcp-private-connect branch 3 times, most recently from c980035 to f14bf55 Compare March 25, 2026 04:19

vercel bot had a problem deploying to Preview – clickhouse-docs March 25, 2026 04:29 Failure

duanshiqiang force-pushed the feature-gcp-private-connect branch 4 times, most recently from 610d07f to e66d826 Compare March 25, 2026 05:55

duanshiqiang marked this pull request as ready for review March 25, 2026 05:55

duanshiqiang requested a review from a team as a code owner March 25, 2026 05:55

chore(byoc): Refactor BYOC private networking setup docs

cf3310a

duanshiqiang force-pushed the feature-gcp-private-connect branch from e66d826 to cf3310a Compare March 25, 2026 06:04

vercel bot deployed to Preview – clickhouse-docs March 25, 2026 06:17 View deployment

Merge branch 'main' into feature-gcp-private-connect

e0c889b

vercel bot deployed to Preview – clickhouse-docs-ko March 26, 2026 01:14 View deployment

vercel bot deployed to Preview – clickhouse-docs-zh March 26, 2026 01:14 View deployment

vercel bot deployed to Preview – clickhouse-docs-jp March 26, 2026 01:14 View deployment

vercel bot deployed to Preview – clickhouse-docs-ru March 26, 2026 01:15 View deployment

vercel bot deployed to Preview – clickhouse-docs March 26, 2026 01:16 View deployment

dhtclk requested changes Mar 26, 2026

View reviewed changes

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

chore(byoc): Refactor BYOC private networking setup docs#5780

chore(byoc): Refactor BYOC private networking setup docs#5780
duanshiqiang wants to merge 2 commits intomainfrom
feature-gcp-private-connect

duanshiqiang commented Mar 19, 2026 •

edited

Loading

Uh oh!

vercel bot commented Mar 19, 2026 •

edited

Loading

Uh oh!

dhtclk left a comment

Uh oh!

dhtclk Mar 26, 2026

Uh oh!

dhtclk Mar 26, 2026

Uh oh!

dhtclk Mar 26, 2026

Uh oh!

dhtclk Mar 26, 2026

Uh oh!

dhtclk Mar 26, 2026

Uh oh!

dhtclk Mar 26, 2026

Uh oh!

dhtclk Mar 26, 2026

Uh oh!

dhtclk Mar 26, 2026

Uh oh!

dhtclk Mar 26, 2026

Uh oh!

dhtclk Mar 26, 2026

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

2 participants

	import byoc_privatelink_3 from '@site/static/images/cloud/reference/byoc-privatelink-gcp-2.png';
	import byoc_privatelink_3 from '@site/static/images/cloud/reference/byoc-privatelink-gcp-3.png';


		### Obtain GCP PSC service name and DNS name {#step-2-obtain-gcp-service-attachment-and-dns-name-for-private-service-connect}

		ClickHouse Support will provide you with the PSC Service name. You can also obtain it in the ClickHouse Cloud console, under "Orgainzation" -> "Infrastructure", click into the infra name to see the details.

	### Create an PSC endpoint in your Network {#step-3-create-endpoint}
	### Create a PSC endpoint in your network {#step-3-create-endpoint}

	- Click "Add Endpoint", wait a momemt for the endpoint to be created.
	- Click "Add Endpoint", wait a moment for the endpoint to be created.


		To create or delete VPC peering for ClickHouse BYOC, follow the steps:

		> The example steps are for a simple scenario, for advanced scenarios such as peering with on-premises connectivity, some adjustments may required.

	hide_title: true
	sidebar_label: 'Private networking setup'
	hide_title: true

	\| [BYOC AWS private networking setup](/cloud/reference/byoc/onboarding/network-aws) \| Deploy ClickHouse on your own cloud infrastructure \|
	\| [BYOC AWS private networking setup](/cloud/reference/byoc/onboarding/network-aws) \| Set up VPC Peering or PrivateLink for BYOC on AWS \|

	\| [BYOC GCP private networking setup](/cloud/reference/byoc/onboarding/network-gcp) \| Deploy ClickHouse on your own cloud infrastructure \|
	\| [BYOC GCP private networking setup](/cloud/reference/byoc/onboarding/network-gcp) \| Set up VPC Peering or Private Service Connect for BYOC on GCP \|

Conversation

duanshiqiang commented Mar 19, 2026 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Summary

Checklist

Uh oh!

vercel bot commented Mar 19, 2026 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

dhtclk left a comment

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

2 participants

duanshiqiang commented Mar 19, 2026 •

edited

Loading

vercel bot commented Mar 19, 2026 •

edited

Loading