DOC-1871: Add client VPC and security group setup to dedicated Privat… by micheleRP · Pull Request #504 · redpanda-data/cloud-docs

micheleRP · 2026-02-17T22:56:48Z

The BYOC/Dedicated AWS PrivateLink Cloud UI doc was missing the entire client-side VPC and security group setup section, including the critical per-broker port ranges (32000-32500 for Kafka API, 35000-35500 for HTTP Proxy).

Create shared partial for VPC setup steps used by both UI and API docs
Add "Configure PrivateLink connection" section to the BYOC/dedicated UI doc (similar but not identical to our Serverless private networking docs)
Replace inline VPC setup in the API doc with the shared partial

Description

Resolves https://redpandadata.atlassian.net/browse/DOC-1871
Review deadline:

Page previews

Configure AWS PrivateLink in the Cloud Console
Configure AWS PrivateLink with the Cloud API

Checks

New feature
Content gap
Support Follow-up
Small fix (typos, links, copyedits, etc)

netlify · 2026-02-17T22:56:53Z

✅ Deploy Preview for rp-cloud ready!

Name	Link
🔨 Latest commit	`62a3d03`
🔍 Latest deploy log	https://app.netlify.com/projects/rp-cloud/deploys/69a5c02ae6e0f200095c17fe
😎 Deploy Preview	https://deploy-preview-504--rp-cloud.netlify.app
📱 Preview on mobile	Toggle QR Code... Use your smartphone camera to open QR code link.

To edit notification comments on pull requests, go to your Netlify project configuration.

coderabbitai · 2026-02-17T22:57:20Z

Important

Review skipped

Auto incremental reviews are disabled on this repository.

Please check the settings in the CodeRabbit UI or the .coderabbit.yaml file in this repository. To trigger a single review, invoke the @coderabbitai review command.

You can disable this status message by setting the reviews.review_status to false in the CodeRabbit configuration file.

Use the checkbox below for a quick retry:

🔍 Trigger review

📝 Walkthrough

Walkthrough

This pull request consolidates AWS PrivateLink documentation by extracting common VPC setup procedures into a reusable shared partial file (private-links-aws-client-vpc-setup.adoc), which is then referenced across multiple documentation pages. The changes reorganize the aws-privatelink page to replace inline VPC creation steps with includes, expand guidance for both new and existing cluster PrivateLink enablement workflows, and introduce cross-region PrivateLink support. The configure-privatelink-in-cloud-ui page is enhanced with a new subsection that derives cluster domain from bootstrap URLs and includes the shared VPC setup partial, addressing missing security group configuration details previously absent from the Cloud UI flow.

Estimated code review effort

🎯 3 (Moderate) | ⏱️ ~20 minutes

Possibly related PRs

#480: Both PRs add and expand cross-region AWS PrivateLink support with region-specific guidance and configuration updates.
#407: Both PRs modify AWS PrivateLink VPC setup documentation to include security group rule configuration details.
#425: Both PRs enhance PrivateLink documentation with DNS domain guidance and introduce shared DNS-related documentation partials.

Suggested reviewers

c4milo
paulzhang97
paulohtb6
Feediver1

🚥 Pre-merge checks | ✅ 5

✅ Passed checks (5 passed)

Check name	Status	Explanation
Title check	✅ Passed	The title clearly describes the main change: adding client VPC and security group setup guidance to the dedicated PrivateLink documentation.
Linked Issues check	✅ Passed	The PR fulfills all DOC-1871 objectives: adds security group and VPC setup details to the UI doc, includes per-broker port ranges, and ensures consistent documentation between UI and API flows.
Out of Scope Changes check	✅ Passed	All changes directly address DOC-1871 requirements: the new partial, UI doc updates, and API doc refactoring are all within the scope of adding PrivateLink setup guidance.
Docstring Coverage	✅ Passed	No functions found in the changed files to evaluate docstring coverage. Skipping docstring coverage check.
Description check	✅ Passed	The pull request description provides clear context, links the related Jira issue (DOC-1871), includes page preview links, and explicitly details the changes made (creating a shared partial, adding configuration section to UI docs, replacing inline setup in API docs).

_{✏️ Tip: You can configure your own custom pre-merge checks in the settings.}

✨ Finishing Touches

🧪 Generate unit tests (beta)

Create PR with unit tests
Post copyable unit tests in a comment
Commit unit tests in branch DOC-1871-AWS-Private-Link-Cloud-UI-flow-docs-missing-security-group-setup-details

Tip

Try Coding Plans. Let us write the prompt for your AI agent so you can ship faster (with fewer bugs).
Share your feedback on Discord.

_{Comment @coderabbitai help to get the list of available commands and usage tips.}

coderabbitai

Actionable comments posted: 1

🤖 Prompt for all review comments with AI agents

Verify each finding against the current code and only fix it if needed.

Inline comments:
In `@modules/networking/partials/private-links-aws-client-vpc-setup.adoc`:
- Around line 98-104: The example for creating a subnet uses an AZ ID value
("usw2-az1") with the --availability-zone parameter which expects an AZ name
(e.g., "us-west-2a"); update the snippet around the aws ec2 create-subnet
example so the AZ format and flag match: either replace the example AZ value
with an AZ name (us-west-2a) when using --availability-zone, or change the flag
to --availability-zone-id when keeping the AZ ID example (usw2-az1); ensure the
surrounding text clarifies which format is required and keep references to
REGION, PROFILE, CLIENT_VPC_ID and the resulting subnet_id/create-subnet command
consistent.

modules/networking/partials/private-links-aws-client-vpc-setup.adoc

…eLink UI doc The dedicated-cluster AWS PrivateLink Cloud UI doc was missing the entire client-side VPC and security group setup section, including the critical per-broker port ranges (32000-32500 for Kafka API, 35000-35500 for HTTP Proxy). - Create shared partial for VPC setup steps used by both UI and API docs - Add "Configure PrivateLink connection" section to the dedicated UI doc - Replace inline VPC setup in the API doc with the shared partial Co-Authored-By: Claude Opus 4.6 <noreply@anthropic.com>

…zone flag The create-subnet examples showed an AZ ID (usw2-az1) but used the --availability-zone flag, which expects an AZ name (us-west-2a). Co-Authored-By: Claude Opus 4.6 <noreply@anthropic.com>

Address review feedback: remove redundant partial intro, add transition sentence in UI page, fix heading consistency, rename partial section to "Set up the client VPC", update anchor references, standardize on "Redpanda Cloud Console" and "client VPC" terminology, add (350000 ms) to TIP admonitions, promote CIDR warning to CAUTION, integrate port range NOTE into prose, differentiate broker port comments in serverless files, fix missing ^ on external link, and fix AZ example format. Co-Authored-By: Claude Opus 4.6 <noreply@anthropic.com>

simonlord

Refactor looks good to me.

simonlord · 2026-03-02T11:48:37Z

modules/networking/partials/private-links-aws-client-vpc-setup.adoc

+    --availability-zone <zone> \
+    --cidr-block 10.0.1.0/24
+SUBNET_ID=<subnet_id>
+----


"You can also use an existing subnet from your existing VPC"

thanks, added!

paulohtb6 · 2026-03-02T16:18:43Z

modules/networking/pages/serverless/aws/privatelink-api.adoc

 === Create VPC subnet

-You need the subnet ID `subnet_id` from the command output to <<create-vpc-endpoint,create a VPC endpoint>>. Run the following command, specifying the subnet availability zone (for example, `usw2-az1`):
+You need the subnet ID `subnet_id` from the command output to <<create-vpc-endpoint,create a VPC endpoint>>. Run the following command, specifying the subnet Availability Zone name (for example, `us-west-2a`):


glossterm for az?

added glossterm

micheleRP requested a review from a team as a code owner February 17, 2026 22:56

coderabbitai bot reviewed Feb 17, 2026

View reviewed changes

modules/networking/partials/private-links-aws-client-vpc-setup.adoc Outdated Show resolved Hide resolved

micheleRP requested a review from simonlord February 17, 2026 23:01

micheleRP force-pushed the DOC-1871-AWS-Private-Link-Cloud-UI-flow-docs-missing-security-group-setup-details branch from 6166b0f to f733bb1 Compare February 26, 2026 01:56

micheleRP and others added 2 commits February 25, 2026 19:00

DOC-1871: Fix AZ ID example to use AZ name format for --availability-…

9da9c85

…zone flag The create-subnet examples showed an AZ ID (usw2-az1) but used the --availability-zone flag, which expects an AZ name (us-west-2a). Co-Authored-By: Claude Opus 4.6 <noreply@anthropic.com>

simonlord approved these changes Mar 2, 2026

View reviewed changes

paulohtb6 reviewed Mar 2, 2026

View reviewed changes

paulohtb6 approved these changes Mar 2, 2026

View reviewed changes

incorporate review feedback

62a3d03

micheleRP merged commit 745a0cb into main Mar 2, 2026
5 checks passed

micheleRP deleted the DOC-1871-AWS-Private-Link-Cloud-UI-flow-docs-missing-security-group-setup-details branch March 2, 2026 17:01

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

DOC-1871: Add client VPC and security group setup to dedicated Privat…#504

DOC-1871: Add client VPC and security group setup to dedicated Privat…#504
micheleRP merged 4 commits intomainfrom
DOC-1871-AWS-Private-Link-Cloud-UI-flow-docs-missing-security-group-setup-details

micheleRP commented Feb 17, 2026 •

edited

Loading

Uh oh!

netlify bot commented Feb 17, 2026 •

edited

Loading

Uh oh!

coderabbitai bot commented Feb 17, 2026 •

edited

Loading

Review skipped

Walkthrough

Estimated code review effort

Possibly related PRs

Suggested reviewers

Uh oh!

coderabbitai bot left a comment

Uh oh!

Uh oh!

simonlord left a comment

Uh oh!

simonlord Mar 2, 2026

Uh oh!

micheleRP Mar 2, 2026

Uh oh!

paulohtb6 Mar 2, 2026

Uh oh!

micheleRP Mar 2, 2026

Uh oh!

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

3 participants

Conversation

micheleRP commented Feb 17, 2026 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Description

Page previews

Checks

Uh oh!

netlify bot commented Feb 17, 2026 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

✅ Deploy Preview for rp-cloud ready!

Uh oh!

coderabbitai bot commented Feb 17, 2026 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Review skipped

Walkthrough

Estimated code review effort

Possibly related PRs

Suggested reviewers

Uh oh!

coderabbitai bot left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

simonlord left a comment

Choose a reason for hiding this comment

Uh oh!

simonlord Mar 2, 2026

Choose a reason for hiding this comment

Uh oh!

micheleRP Mar 2, 2026

Choose a reason for hiding this comment

Uh oh!

paulohtb6 Mar 2, 2026

Choose a reason for hiding this comment

Uh oh!

micheleRP Mar 2, 2026

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

3 participants

micheleRP commented Feb 17, 2026 •

edited

Loading

netlify bot commented Feb 17, 2026 •

edited

Loading

coderabbitai bot commented Feb 17, 2026 •

edited

Loading