Skip to content

DOC-1651 update AWS VPC endpoints security group ports#407

Merged
micheleRP merged 4 commits intomainfrom
DOC-1651-AWS-VPC-endpoints-security-group-ports-are-out-of-date
Sep 3, 2025
Merged

DOC-1651 update AWS VPC endpoints security group ports#407
micheleRP merged 4 commits intomainfrom
DOC-1651-AWS-VPC-endpoints-security-group-ports-are-out-of-date

Conversation

@micheleRP
Copy link
Contributor

@micheleRP micheleRP commented Sep 3, 2025

Description

This PR updates the AWS PrivateLink networking doc for adding security group rules.

  • Updated instructions to recommend opening the full port ranges (32000-32500 for Kafka API and 35000-35500 for HTTP Proxy) instead of specifying ports based on broker count, improving reliability for all cluster sizes.
  • Added a note explaining why opening only a subset of ports can break producers/consumers, with a reference to doc on network ports.
  • Updated example aws ec2 authorize-security-group-ingress commands to match the new guidance, including more descriptive comments and grouping for bootstrap, Schema Registry, HTTP Proxy, and per-broker port pools.

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

Page previews

Add security group rules

Checks

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

@micheleRP micheleRP requested a review from a team as a code owner September 3, 2025 20:31
@coderabbitai
Copy link
Contributor

coderabbitai bot commented Sep 3, 2025

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.

📝 Walkthrough

Walkthrough

Updates aws-privatelink.adoc to replace broker-count-based port listings with fixed port ranges for PrivateLink security group rules. Retains single-port rules for bootstrap and services (Kafka seed 30292, Schema Registry 30081, Panda Proxy 30282, Console 443). Sets Kafka API broker ports to 32000–32500 and HTTP Proxy broker ports to 35000–35500. Adds a note clarifying per-broker port pools and that rules work for any broker count, and adds a cross-reference to private service connectivity network ports documentation.

Estimated code review effort

🎯 2 (Simple) | ⏱️ ~8 minutes

Assessment against linked issues

Objective Addressed Explanation
Update AWS VPC endpoints security group ports to current documented ranges to prevent partition-related produce issues (DOC-1651)

Out-of-scope changes

(No out-of-scope functional code changes detected.)

Suggested reviewers

  • c4milo
  • paulzhang97
  • Feediver1
✨ Finishing Touches
🧪 Generate unit tests
  • Create PR with unit tests
  • Post copyable unit tests in a comment
  • Commit unit tests in branch DOC-1651-AWS-VPC-endpoints-security-group-ports-are-out-of-date

🪧 Tips

Chat

There are 3 ways to chat with CodeRabbit:

  • Review comments: Directly reply to a review comment made by CodeRabbit. Example:
    • I pushed a fix in commit <commit_id>, please review it.
    • Open a follow-up GitHub issue for this discussion.
  • Files and specific lines of code (under the "Files changed" tab): Tag @coderabbitai in a new review comment at the desired location with your query.
  • PR comments: Tag @coderabbitai in a new PR comment to ask questions about the PR branch. For the best results, please provide a very specific query, as very limited context is provided in this mode. Examples:
    • @coderabbitai gather interesting stats about this repository and render them as a table. Additionally, render a pie chart showing the language distribution in the codebase.
    • @coderabbitai read the files in the src/scheduler package and generate a class diagram using mermaid and a README in the markdown format.

Support

Need help? Create a ticket on our support page for assistance with any issues or questions.

CodeRabbit Commands (Invoked using PR/Issue comments)

Type @coderabbitai help to get the list of available commands.

Other keywords and placeholders

  • Add @coderabbitai ignore or @coderabbit ignore anywhere in the PR description to prevent this PR from being reviewed.
  • Add @coderabbitai summary to generate the high-level summary at a specific location in the PR description.
  • Add @coderabbitai anywhere in the PR title to generate the title automatically.

CodeRabbit Configuration File (.coderabbit.yaml)

  • You can programmatically configure CodeRabbit by adding a .coderabbit.yaml file to the root of your repository.
  • Please see the configuration documentation for more information.
  • If your editor has YAML language server enabled, you can add the path at the top of this file to enable auto-completion and validation: # yaml-language-server: $schema=https://coderabbit.ai/integrations/schema.v2.json

Status, Documentation and Community

  • Visit our Status Page to check the current availability of CodeRabbit.
  • Visit our Documentation for detailed information on how to use CodeRabbit.
  • Join our Discord Community to get help, request features, and share feedback.
  • Follow us on X/Twitter for updates and announcements.

@netlify
Copy link

netlify bot commented Sep 3, 2025

Deploy Preview for rp-cloud ready!

Name Link
🔨 Latest commit 83fb852
🔍 Latest deploy log https://app.netlify.com/projects/rp-cloud/deploys/68b8b1ea0fd00c00081abf38
😎 Deploy Preview https://deploy-preview-407--rp-cloud.netlify.app
📱 Preview on mobile
Toggle QR Code...

QR Code

Use your smartphone camera to open QR code link.

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

@micheleRP micheleRP requested a review from c4milo September 3, 2025 20:32
Copy link
Contributor

@coderabbitai coderabbitai bot left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Actionable comments posted: 1

🧹 Nitpick comments (3)
modules/networking/pages/aws-privatelink.adoc (3)

275-289: Tighten security group sources; avoid 0.0.0.0/0 in examples.

Use client VPC CIDR or, preferably, the client instances’ security group as the source to prevent overly broad access.

Example (security group source):

-  --group-id $SECURITY_GROUP_ID --protocol tcp --port 30292 --cidr 0.0.0.0/0
+  --group-id $SECURITY_GROUP_ID --protocol tcp --port 30292 --source-group $APP_SG

And for ranges (combine with the previous comment’s fix):

-  --group-id $SECURITY_GROUP_ID \
-  --ip-permissions 'IpProtocol=tcp,FromPort=32000,ToPort=32500,IpRanges=[{CidrIp=0.0.0.0/0}]'
+  --group-id $SECURITY_GROUP_ID \
+  --ip-permissions 'IpProtocol=tcp,FromPort=32000,ToPort=32500,UserIdGroupPairs=[{GroupId='$APP_SG'}]'

You can define APP_SG earlier to point to the SG attached to your client instances or load balancers.

Also applies to: 293-299


287-290: Clarify when port 443 is required.

Briefly specify scenarios (for example, Console over PrivateLink, Data Plane API, Prometheus scraping) to avoid users opening 443 unnecessarily.


283-286: Name consistency: consider “HTTP Proxy (Panda Proxy)” once for discoverability.

Some users still search for “Panda Proxy.” Adding the alias in one place helps them map the service.

Also applies to: 296-298

📜 Review details

Configuration used: CodeRabbit UI

Review profile: CHILL

Plan: Pro

💡 Knowledge Base configuration:

  • MCP integration is disabled by default for public repositories
  • Jira integration is disabled by default for public repositories
  • Linear integration is disabled by default for public repositories

You can enable these sources in your CodeRabbit configuration.

📥 Commits

Reviewing files that changed from the base of the PR and between f203ed8 and 9ca9781.

📒 Files selected for processing (1)
  • modules/networking/pages/aws-privatelink.adoc (1 hunks)
🔇 Additional comments (1)
modules/networking/pages/aws-privatelink.adoc (1)

271-271: Good clarification on per-broker port pools.

Clear, actionable note that prevents common misconfigurations. Please verify the xref anchor resolves in the built docs.

micheleRP and others added 2 commits September 3, 2025 14:35
@coderabbitai
Copy link
Contributor

coderabbitai bot commented Sep 3, 2025

✅ Actions performed

Review triggered.

Note: CodeRabbit is an incremental review system and does not re-review already reviewed commits. This command is applicable only when automatic reviews are paused.

Copy link
Member

@c4milo c4milo left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

LGTM, assuming the AWS CLI commands work. I didn't test them myself.

@micheleRP micheleRP merged commit a99723a into main Sep 3, 2025
5 checks passed
@micheleRP micheleRP deleted the DOC-1651-AWS-VPC-endpoints-security-group-ports-are-out-of-date branch September 3, 2025 21:30
@coderabbitai coderabbitai bot mentioned this pull request Feb 3, 2026
4 tasks
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

4 participants

Comments