Conversation
…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>
✅ Deploy Preview for rp-cloud ready!
To edit notification comments on pull requests, go to your Netlify project configuration. |
📝 WalkthroughWalkthroughThis pull request consolidates AWS PrivateLink documentation by extracting common VPC setup procedures into a reusable shared partial file ( Estimated code review effort🎯 3 (Moderate) | ⏱️ ~20 minutes Possibly related PRs
Suggested reviewers
🚥 Pre-merge checks | ✅ 5✅ Passed checks (5 passed)
✏️ Tip: You can configure your own custom pre-merge checks in the settings. ✨ Finishing touches
🧪 Generate unit tests (beta)
Comment |
![coderabbitai[bot]](https://avatars.githubusercontent.com/in/347564?s=60&v=4){kind=small}
There was a problem hiding this comment.
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.
| 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`): | ||
|
|
||
| [,bash] | ||
| ---- | ||
| aws ec2 create-subnet --region $REGION --profile $PROFILE --vpc-id $CLIENT_VPC_ID \ | ||
| --availability-zone <zone> \ | ||
| --cidr-block 10.0.1.0/24 |
There was a problem hiding this comment.
🧩 Analysis chain
🌐 Web query:
AWS CLI ec2 create-subnet --availability-zone vs --availability-zone-id parameter documentation
💡 Result:
In aws ec2 create-subnet, the two parameters map to the same concept (which zone the subnet is created in), but use different identifiers:
--availability-zone(AZ name / zone code): “The Availability Zone or Local Zone for the subnet” (for exampleus-west-2a, or a Local Zone ID likeus-west-2-lax-1a). AWS can also choose one if you omit it. [1][2]--availability-zone-id(AZ ID / stable zone identifier): “The AZ ID or the Local Zone ID of the subnet” (for exampleuse1-az1). AZ IDs are consistent across AWS accounts, whereas AZ names likeus-east-1acan map to different physical locations in different accounts. [1][2][3][4]
To look up AZ names ↔ AZ IDs, use describe-availability-zones (it returns ZoneName and ZoneId). [5][4]
aws ec2 describe-availability-zones \
--query "AvailabilityZones[].{Name:ZoneName,ID:ZoneId}" --output tableSources: [1] AWS CLI create-subnet reference, [2] EC2 API CreateSubnet reference, [3] EC2 “AZ ID API support” announcement (Dec 18, 2025), [4] AWS “AZ IDs” documentation, [5] AWS CLI describe-availability-zones reference.
🌐 Web query:
AWS availability zone ID format usw2-az1 AZ name us-west-2a
💡 Result:
- AZ ID format: An AZ ID is a stable, account-independent identifier and is formatted as: first 3 letters of the Region code + the Region’s number +
-az+ a number (e.g.,usw2-az1,usw2-az2). [1] - AZ name vs AZ ID mapping:
us-west-2a(AZ name) is not guaranteed to correspond tousw2-az1(AZ ID)—AZ names likeus-west-2a/b/ccan be mapped differently per AWS account, while AZ IDs always refer to the same physical zone across accounts. [2][3] - How to confirm in your account (authoritative):
aws ec2 describe-availability-zones --region us-west-2 --query "AvailabilityZones[].{Name:ZoneName,ID:ZoneId}" --output table[2]
Sources
[1] AWS Docs – AWS Availability Zones (AZ ID format) (docs.aws.amazon.com)
[2] AWS Docs – AZ IDs (name/ID mapping + CLI) (docs.aws.amazon.com)
[3] AWS Prescriptive Guidance – cross-account AZ name randomization and mapping to AZ IDs (docs.aws.amazon.com)
Citations:
- 1: https://docs.aws.amazon.com/global-infrastructure/latest/regions/aws-availability-zones.html?utm_source=openai
- 2: https://docs.aws.amazon.com/global-infrastructure/latest/regions/az-ids.html?utm_source=openai
- 3: https://docs.aws.amazon.com/prescriptive-guidance/latest/patterns/use-consistent-availability-zones-in-vpcs-across-different-aws-accounts.html?utm_source=openai
Fix AZ example format or parameter to prevent CLI errors.
The example shows usw2-az1 (an Availability Zone ID format) with the --availability-zone parameter, which expects an AZ name like us-west-2a. This mismatch will cause the command to fail. Use one of these approaches:
- Change the example to an AZ name: Replace
usw2-az1withus-west-2a - Change the parameter to match the AZ ID format: Use
--availability-zone-idinstead of--availability-zone
The AZ ID format (usw2-az1) is account-independent and stable, whereas AZ names (us-west-2a) vary per account. Choose based on your use case and document clearly which format users should provide.
Suggested documentation fix (choose one)
Option 1: Update example to AZ name
-Run the following command, specifying the subnet availability zone (for example, `usw2-az1`):
+Run the following command, specifying the subnet availability zone (for example, `us-west-2a`):Option 2: Update parameter and description for AZ ID
-Run the following command, specifying the subnet availability zone (for example, `usw2-az1`):
+Run the following command, specifying the subnet availability zone ID (for example, `usw2-az1`):
...
- --availability-zone <zone> \
+ --availability-zone-id <zone_id> \🤖 Prompt for AI Agents
Verify each finding against the current code and only fix it if needed.
In `@modules/networking/partials/private-links-aws-client-vpc-setup.adoc` around
lines 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.
1 participant
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).
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