DOC-1457 separate Dedicate PSC docs #334
Conversation
✅ Deploy Preview for rp-cloud ready!
To edit notification comments on pull requests, go to your Netlify project configuration. |
|
Important Review skippedAuto incremental reviews are disabled on this repository. Please check the settings in the CodeRabbit UI or the You can disable this status message by setting the 📝 WalkthroughWalkthroughThis set of changes restructures and updates the documentation for configuring Google Cloud Platform (GCP) Private Service Connect (PSC) within Redpanda Cloud, specifically for dedicated environments. It introduces new modular documentation pages and partials for both UI-based and API-based PSC configuration, updates navigation links to point to these new resources, and removes or simplifies older, monolithic guides. Minor clarifications and formatting updates are also included in related networking documentation, while no changes are made to exported or public code entities. Sequence Diagram(s)sequenceDiagram
participant User
participant Redpanda Cloud UI
participant Redpanda Cloud API
participant GCP (gcloud CLI)
User->>Redpanda Cloud UI: Select resource group, export ID
User->>GCP (gcloud CLI): Create VPC firewall rules for PSC
User->>Redpanda Cloud API: POST /v1/networks (create network resource)
Redpanda Cloud API-->>User: Return network ID
User->>Redpanda Cloud API: POST /v1/clusters (enable PSC, provide accept list)
Redpanda Cloud API-->>User: Return cluster info
User->>GCP (gcloud CLI): Monitor service attachment creation
User->>Redpanda Cloud UI: (Alternative) Enable PSC via UI, follow guided steps
User->>GCP (gcloud CLI): (Alternative) Create consumer-side resources, DNS, etc.
Assessment against linked issues
Assessment against linked issues: Out-of-scope changesNo out-of-scope changes found. Possibly related PRs
Suggested reviewers
Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out. 🪧 TipsChatThere are 3 ways to chat with CodeRabbit:
SupportNeed help? Create a ticket on our support page for assistance with any issues or questions. Note: Be mindful of the bot's finite context window. It's strongly recommended to break down tasks such as reading entire modules into smaller chunks. For a focused discussion, use review comments to chat about specific files and their changes, instead of using the PR comments. CodeRabbit Commands (Invoked using PR comments)
Other keywords and placeholders
CodeRabbit Configuration File (
|
![coderabbitai[bot]](https://avatars.githubusercontent.com/in/347564?s=60&v=4){kind=small}
There was a problem hiding this comment.
Actionable comments posted: 2
🔭 Outside diff range comments (1)
modules/networking/pages/gcp-private-service-connect.adoc (1)
11-14: Fix Asciidoc step formatting
The step to copy the Resource Group ID is missing the leading list marker, which breaks the ordered list. It should start with a dot (.).
Apply this diff:- Copy and store the resource group ID (UUID) from the URL in the browser. + . Copy and store the resource group ID (UUID) from the URL in the browser.
🧹 Nitpick comments (10)
modules/networking/partials/psc-api.adoc (1)
11-11: Fix grammatical error in note block.The sentence at line 11 is missing a verb and comma; suggest rephrasing for clarity.
-As of February 2025 ability to allow requests from Private Service Connect endpoints to stay within the same AZ, avoiding additional networking costs. To upgrade, contact https://support.redpanda.com/hc/en-us/requests/new[Redpanda Support^]. +As of February 2025, you can allow requests from Private Service Connect endpoints to stay within the same AZ, avoiding additional networking costs. To upgrade, contact https://support.redpanda.com/hc/en-us/requests/new[Redpanda Support^].modules/ROOT/nav.adoc (1)
49-51: Ensure link text matches page title.The dedicated GCP UI page title includes “GCP Private Service Connect”, but the nav link omits “GCP”. For consistency, align the link text with the page title:
- **** xref:networking:dedicated/gcp/configure-psc-in-ui.adoc[Configure Private Service Connect in the Cloud UI] + **** xref:networking:dedicated/gcp/configure-psc-in-ui.adoc[Configure GCP Private Service Connect in the Cloud UI] - **** xref:networking:dedicated/gcp/configure-psc-in-api.adoc[Configure Private Service Connect with the Cloud API] + **** xref:networking:dedicated/gcp/configure-psc-in-api.adoc[Configure GCP Private Service Connect with the Cloud API]modules/networking/pages/gcp-private-service-connect.adoc (2)
22-39: Consistent code block syntax
You’re using[,bash]to annotate the GCP CLI examples. For better syntax highlighting, switch to the standard Asciidoctor syntax:-[,bash] + [source,bash] ---- gcloud compute networks subnets create ... ----
85-87: Clarify placeholder section styling
The “Replace the following placeholder variables for the request body:” line is introduced correctly, but the removed--markers may leave an orphaned horizontal rule. Ensure you fully remove or replace them with proper list delimiters so the list renders as intended.modules/networking/partials/psc-ui.adoc (4)
2-8: Clarify terminology in NOTE block
The first bullet references “Private Service” but should explicitly say “Private Service Connect” for clarity. Also verify the cross-reference path (xref:networking:gcp-private-service-connect.adoc) resolves correctly.
37-45: Break up long commands for readability
The NAT subnet creation snippet is valid but dense. Splitting flags onto separate lines improves scannability:[source,bash] ---- gcloud compute networks subnets create <subnet-name> \ --project <host-project-id> \ --network <shared-vpc-name> \ --region <region> \ --range <subnet-range> \ --purpose PRIVATE_SERVICE_CONNECT ----
47-57: Improve firewall rule formatting
The firewall CLI packs many ports into one--allowflag. For maintainability, break out ports or use an inline list:[source,bash] ---- gcloud compute firewall-rules create redpanda-psc \ --description "Allow access to Redpanda PSC endpoints" \ --allow tcp:30181,tcp:30282,... \ --source-ranges 10.0.0.0/8,172.16.0.0/12,... ----
59-66: Ensure placeholder list renders correctly
The placeholder section uses hyphens for bullets, which is acceptable, but confirm there's a blank line before it so Asciidoctor treats it as a list. Optionally switch to*bullets for consistency with other docs.modules/networking/pages/dedicated/gcp/configure-psc-in-api.adoc (2)
18-30: Use standard Asciidoctor code block syntax
For the GCP firewall example, replace[,bash]with[source,bash]to enable proper syntax highlighting:-[,bash] + [source,bash] ---- gcloud compute firewall-rules create redpanda-psc \ ... ----
60-68: Ensure placeholder list renders correctly
The "Replace the following placeholder variables" section should have a blank line before the list and could use*bullets for consistency:Replace the following placeholder variables for the request body: * `<shared-vpc-name>`: ... * `<region>`: ...
📜 Review details
Configuration used: CodeRabbit UI
Review profile: CHILL
Plan: Pro
📒 Files selected for processing (10)
modules/ROOT/nav.adoc(1 hunks)modules/networking/pages/azure-private-link.adoc(1 hunks)modules/networking/pages/configure-private-service-connect-in-cloud-ui.adoc(1 hunks)modules/networking/pages/dedicated/gcp/configure-psc-in-api.adoc(1 hunks)modules/networking/pages/dedicated/gcp/configure-psc-in-ui.adoc(1 hunks)modules/networking/pages/dedicated/gcp/vpc-peering-gcp.adoc(0 hunks)modules/networking/pages/gcp-private-service-connect.adoc(2 hunks)modules/networking/partials/psc-api.adoc(1 hunks)modules/networking/partials/psc-api2.adoc(1 hunks)modules/networking/partials/psc-ui.adoc(1 hunks)
💤 Files with no reviewable changes (1)
- modules/networking/pages/dedicated/gcp/vpc-peering-gcp.adoc
⏰ Context from checks skipped due to timeout of 90000ms (3)
- GitHub Check: Redirect rules - rp-cloud
- GitHub Check: Header rules - rp-cloud
- GitHub Check: Pages changed - rp-cloud
🔇 Additional comments (9)
modules/networking/pages/azure-private-link.adoc (1)
22-22: External link syntax standardized forjq.The AsciiDoc external link for
jqhas been reformatted to match our style. Ensure this renders correctly in the published docs.modules/networking/pages/dedicated/gcp/configure-psc-in-ui.adoc (1)
1-5: Well-structured UI configuration page.The page correctly delegates content to the
psc-ui.adocpartial and sets theenv-dedicatedattribute. No issues found.modules/networking/pages/configure-private-service-connect-in-cloud-ui.adoc (1)
1-6: Streamlined BYOC UI page looks good.Switching to include the
psc-ui.adocpartial and settingenv-byocis correct; the page is concise and maintains its original aliases.modules/networking/pages/gcp-private-service-connect.adoc (2)
4-6: Verify environment conditional for BYOVPC content
The:env-byoc: trueattribute enables the BYOVPC-specific instructions underifdef::env-byoc[]. Confirm this flag is set consistently in related pages (e.g., the UI partial) and remove it if the content should apply universally.
260-260: Approve inclusion ofpsc-api2.adocpartial
Ending the page withinclude::networking:partial$psc-api2.adoc[]cleanly injects the remaining API instructions (testing & disabling). This keeps the documentation modular.modules/networking/partials/psc-ui.adoc (2)
32-34: Verify the BYOVPC conditional block
Theifdef::env-byoc[]guard is used correctly for BYOVPC instructions. Ensure a matchingendif::[]is present below and consider adding a brief comment above the guard to explain its purpose.
67-68: Close conditional block and check link syntax
The link to GCP docs and the closingendif::[]are in place. Verify the caret notation in[creating a subnet for Private Service Connect^]renders as expected.modules/networking/pages/dedicated/gcp/configure-psc-in-api.adoc (2)
1-6: Verify dedicated environment conditional
The:env-dedicated: trueattribute correctly scopes this page to dedicated cluster workflows. Confirm alignment with other dedicated docs and remove it if the content also applies to non-dedicated scenarios.
157-157: Approve inclusion ofpsc-api2.adocpartial
Appendinginclude::networking:partial$psc-api2.adoc[]integrates the final API steps for testing and teardown, keeping the guide modular.
Co-authored-by: Paul Zhang <[email protected]>
|
@micheleRP I just noticed we have the same issue in AWS. |
david-yu
left a comment
david-yu
left a comment
There was a problem hiding this comment.
LGTM did a quick scan and I agree with the changes
micheleRP
deleted the
DOC-1457-Dedicated-private-service-connect-docs-say-create-a-BYOVPC-cluster-instead-of-a-dedicated-cluster
branch
Description
This pull request introduces significant updates to the documentation for configuring GCP Private Service Connect (PSC) in Redpanda Cloud. The changes focus on restructuring content, improving clarity, and consolidating redundant information into reusable partials. Additionally, new files were added to provide dedicated guides for PSC configuration in both the Cloud UI and API.
Key Changes
Separate pages for GCP Private Service Connect on Dedicated:
modules/networking/pages/dedicated/gcp/configure-psc-in-ui.adocto provide a focused guide on setting up PSC using the Redpanda Cloud UI.modules/networking/pages/dedicated/gcp/configure-psc-in-api.adocto document how to configure PSC using the Cloud API, including detailed steps for creating clusters and enabling PSC.modules/networking/pages/configure-private-service-connect-in-cloud-ui.adocandmodules/networking/pages/gcp-private-service-connect.adoc. These files were replaced with references to the new partials. [1] [2] [3]Minor Improvements:
jqinstallation link syntax inmodules/networking/pages/azure-private-link.adoc.modules/networking/pages/dedicated/gcp/vpc-peering-gcp.adoc.Documentation Restructuring and Consolidation:
modules/ROOT/nav.adocto reflect the new file structure for PSC-related documentation. Old links were replaced with new, more descriptive paths (configure-psc-in-ui.adocandconfigure-psc-in-api.adoc).psc-api.adocandpsc-api2.adoc), which now centralize shared information about requirements, notes, and testing steps. [1] [2]Resolves https://redpandadata.atlassian.net/browse/DOC-1457
Review deadline:
Page previews
BYOC PSC in UI
BYOC PSC in API
Dedicated PSC in UI
Dedicated PSC in API
AWS PrivateLink in API
Checks