BYOC GCP private networking setup

In this example, we are setting up peering between the BYOC VPC network and another existing VPC network.

1. Navigate to the “VPC Network” in ClickHouse BYOC Google Cloud Project.
2. Select “VPC network peering”.
3. Click “Create connection”.
4. Input the necessary fields as per your requirements. Below is a screenshot for creating a peering within same GCP project.

GCP VPC peering requires 2 connections between the 2 networks to work (i.e. a connection from BYOC network to the existing VPC network and a connection from the existing VPC network to the BYOC network). So you need to similarly create 1 more connection in reverse direction, below is a screenshot for the second peering connection creation:

After both connections are created, the status of the 2 connections should become “Active” after refreshing the Google Cloud Console webpage:

The ClickHouse service should now be accessible from the peered VPC.

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:

• Public endpoint: h5ju65kv87.mhp0y4dmph.us-east1.gcp.clickhouse-byoc.com
• Private endpoint: h5ju65kv87-private.mhp0y4dmph.us-east1.gcp.clickhouse-byoc.com

1. In the ClickHouse Cloud console, navigate to the service’s Settings page that you would like to connect to via PSC.
2. Click “Set up private endpoint”.
3. In the opened flyout, copy the Service name and DNS name value — you’ll use them in the next step. (It may take a while for the value to be generated after enabling private link.)

   

1. Open your own GCP console (i.e. the GCP account where your client application is) → Network Services → Private Service Connect → Connected Endpoints.

2. Open the Private Service Connect creation dialog by clicking the “Connect Endpoint” button.

   

3. Input the following fields:

   • Target: use Published service
   • Target service: use Service name obtained from the last step
   • Endpoint name: input a valid endpoint name
   • Network/Subnetwork: choose the network you want to use for the connection; this is the network where your client application will be connecting from
   • IP address: 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
   • (optional) Enable global access: enable it if you want to make the endpoint available from any region

     

   • Click “ADD ENDPOINT” button to create the endpoint.

4. The Status column will change from Pending to Accepted once the connection is approved.

5. After creating the endpoint, copy the PSC Connection ID value — you’ll use it in the next step.

   

1. In the ClickHouse Cloud console, navigate to the service’s Settings page that you would like to connect to via PSC.
2. Click “Set up private endpoint”.
3. In the opened flyout, enter the PSC Connection ID obtained from the last step into the Endpoint ID field with an optional description.
4. Click “Create endpoint”.

You need to point all subdomains (wildcard) of the “DNS name” to GCP PSC endpoint IP address. This ensures that services/components within your VPC/Network can resolve it properly.

1. In the ClickHouse Cloud console, navigate to service’s Settings page.
2. Click “Set up private endpoint”.
3. In the opened flyout, copy the DNS name.