Update BYOC PrivateLink setup docs and screenshots (AWS & GCP)#6452
Open
luisliuchao wants to merge 3 commits into
Open
Update BYOC PrivateLink setup docs and screenshots (AWS & GCP)#6452luisliuchao wants to merge 3 commits into
luisliuchao wants to merge 3 commits into
Conversation
|
|
|
The latest updates on your projects. Learn more about Vercel for GitHub.
4 Skipped Deployments
|
luisliuchao
force-pushed
the
6405-update-byoc-private-link-setup-screenshots
branch
from
eedbd5a to
51d8d5f
Compare
Contributor
There was a problem hiding this comment.
Pull request overview
Updates the BYOC private networking setup docs for AWS and GCP to reflect the new self-service PrivateLink / Private Service Connect flows driven from the ClickHouse Cloud console.
Changes:
- Rewrites AWS PrivateLink setup steps to be console-driven (service name discovery, endpoint creation/approval, allowlisting, DNS name usage).
- Rewrites GCP PSC setup steps similarly (published service lookup, connected endpoint creation, allowlisting, DNS name usage).
- Adds/updates supporting screenshots and adjusts frontmatter keywords formatting.
Reviewed changes
Copilot reviewed 2 out of 4 changed files in this pull request and generated 4 comments.
| File | Description |
|---|---|
| docs/cloud/guides/infrastructure/01_deployment_options/byoc/03_onboarding/03_network_setup/01_aws.md | Updates AWS BYOC networking guide with a self-service PrivateLink flow and new screenshots. |
| docs/cloud/guides/infrastructure/01_deployment_options/byoc/03_onboarding/03_network_setup/02_gcp.md | Updates GCP BYOC networking guide with a self-service PSC flow, new screenshots, and refreshed structure. |
Comments suppressed due to low confidence (2)
docs/cloud/guides/infrastructure/01_deployment_options/byoc/03_onboarding/03_network_setup/02_gcp.md:44
- The “Enable private load balancer…” prerequisite currently only shows a screenshot and doesn’t tell the reader what action to take in the ClickHouse Cloud console. Adding a short instruction here would make the prerequisite self-contained.
To create or delete VPC peering for ClickHouse BYOC, follow the steps:
:::note
docs/cloud/guides/infrastructure/01_deployment_options/byoc/03_onboarding/03_network_setup/02_gcp.md:157
- This section uses AWS terminology (“VPC Endpoint Security Group”). On GCP PSC there are no security groups on the endpoint; access from the consumer side is governed by your VPC/host firewall rules (in addition to ClickHouse Cloud authz).
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
![cursor[bot]](https://avatars.githubusercontent.com/in/1210556?s=60&v=4){kind=small}
There was a problem hiding this comment.
Cursor Bugbot has reviewed your changes using high effort and found 1 potential issue.
❌ Bugbot Autofix is OFF. To automatically fix reported issues with cloud agents, have a team admin enable autofix in the Cursor dashboard.
Reviewed by Cursor Bugbot for commit 51d8d5f. Configure here.
luisliuchao
changed the title
luisliuchao
changed the title
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
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
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.
Summary
Updates the BYOC private networking setup guides for AWS and GCP to reflect the new self-service PrivateLink / Private Service Connect flow driven from the ClickHouse Cloud console, replacing the older "contact ClickHouse Support" steps.
01_aws.md): Rewrites the PrivateLink section into a step-by-step, console-driven flow — enabling private link in the ClickHouse console, obtaining the endpoint service name, creating and approving the VPC endpoint, adding the Endpoint ID to the service allow list, and connecting via the DNS name. Adds screenshots for each step.02_gcp.md): Parallel updates for the Private Service Connect flow.byoc-private-load-balancer.pngandbyoc-privatelink.png.Test plan
🤖 Generated with Claude Code