Skip to content

DOC-2021: Point cross-region PrivateLink readers to Terraform support#637

Open
Feediver1 wants to merge 3 commits into
mainfrom
DOC-2021-crossregion-privatelink-terraform
Open

DOC-2021: Point cross-region PrivateLink readers to Terraform support#637
Feediver1 wants to merge 3 commits into
mainfrom
DOC-2021-crossregion-privatelink-terraform

Conversation

@Feediver1

@Feediver1 Feediver1 commented Jul 17, 2026

Copy link
Copy Markdown
Contributor

Description

Closes the remaining gap in DOC-2021 (ENG-1063, cross-region AWS PrivateLink via Terraform).

Scope note (2026-07-20): most of this ticket's gap was closed by #635, which merged today with a dedicated Configure cross-region AWS PrivateLink section on the provider page, a pointer from the platform page, and the What's New mention — all stating the correct provider version (v1.7.0+, SME-verified; this PR's original commit message said v1.8.0, which was wrong). This PR's aws-privatelink paragraph was superseded by #635's pointer and has been removed.

What remains in this PR:

  • manage/terraform-provider.adoc: the full Dedicated-cluster example's supported_regions comment now notes the multi-AZ requirement (documented in the Requirements lists, but absent at this example site — prevents a confusing failure for single-AZ clusters).

Resolves DOC-2021 (jointly with the substantive docs from #635).

Page previews

Checks

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

🤖 Generated with Claude Code

The supported_regions Terraform field has existed since provider v1.8.0
but the platform page only named the Cloud UI and Cloud API as
configuration methods. Add the cross-link and note the multi-AZ
requirement on the Terraform example.

Co-Authored-By: Claude Fable 5 <noreply@anthropic.com>
@netlify

netlify Bot commented Jul 17, 2026

Copy link
Copy Markdown

Deploy Preview for rp-cloud ready!

Name Link
🔨 Latest commit fb836fd
🔍 Latest deploy log https://app.netlify.com/projects/rp-cloud/deploys/6a5eb14fe34fa300083293b4
😎 Deploy Preview https://deploy-preview-637--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.

@coderabbitai

coderabbitai Bot commented Jul 17, 2026

Copy link
Copy Markdown
Contributor

Review Change Stack

📝 Walkthrough

Walkthrough

The documentation updates clarify cross-region AWS PrivateLink configuration for Terraform-managed clusters. The dedicated cluster example notes that supported_regions is optional, enables cross-region PrivateLink, and requires a multi-AZ cluster. The AWS PrivateLink guide instructs users to set the matching supported_regions value in the Terraform redpanda_cluster resource.

Estimated code review effort: 1 (Trivial) | ~3 minutes

Suggested reviewers: kbatuigas

🚥 Pre-merge checks | ✅ 5
✅ Passed checks (5 passed)
Check name Status Explanation
Docstring Coverage ✅ Passed No functions found in the changed files to evaluate docstring coverage. Skipping docstring coverage check.
Linked Issues check ✅ Passed Check skipped because no linked issues were found for this pull request.
Out of Scope Changes check ✅ Passed Check skipped because no linked issues were found for this pull request.
Title check ✅ Passed The title is concise and clearly summarizes the main documentation update for cross-region PrivateLink Terraform support.
Description check ✅ Passed The description covers the issue, scope, preview, and checklist; it is mostly complete despite omitting the review deadline field.
✨ Finishing Touches
📝 Generate docstrings
  • Create stacked PR
  • Commit on current branch
🧪 Generate unit tests (beta)
  • Create PR with unit tests
  • Commit unit tests in branch DOC-2021-crossregion-privatelink-terraform

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

@Feediver1
Feediver1 marked this pull request as ready for review July 17, 2026 00:36
@Feediver1
Feediver1 requested a review from a team as a code owner July 17, 2026 00:36
@Feediver1
Feediver1 requested a review from david-yu July 17, 2026 00:37
Feediver1 and others added 2 commits July 20, 2026 19:31
After merging main, the Configure cross-region PrivateLink section
carried two Terraform pointers: #635's intro sentence (targeting the
provider page's purpose-built cross-region section) and this PR's
paragraph (targeting the generic Dedicated-cluster example). Keep
#635's. Also for the record: supported_regions shipped in provider
v1.7.0, not v1.8.0 as this PR's original commit message said (verified
in #635 by SME review against the tag).

Co-Authored-By: Claude Fable 5 <noreply@anthropic.com>

@Feediver1 Feediver1 left a comment

Copy link
Copy Markdown
Contributor Author

Choose a reason for hiding this comment

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

PR Review: DOC-2021: multi-AZ note on the Terraform cross-region example (#637)

Files reviewed: 1 .adoc file (+1/−1 after the post-#635 trim)
Overall assessment: Now a clean, single-purpose change; the earlier overlap with #635 is fully resolved.

Review history on this PR

  • Original scope overlap (resolved in fb836fd): this PR predated #635's merge; its aws-privatelink paragraph became a redundant second Terraform pointer in the same section (aimed at the generic Dedicated-cluster anchor while #635's intro sentence points at the purpose-built Configure cross-region AWS PrivateLink section). Removed; the PR's net diff is now terraform-provider.adoc only.
  • Version correction (recorded): the original commit message's "since v1.8.0" contradicted #635's SME-verified v1.7.0 (tag-checked in schema_resource.go, released 2026-02-26). Corrected in the follow-up commit message, the PR body, and on DOC-2021.

What remains — and it's good

The multi-AZ note on the Dedicated example's supported_regions comment fills a real gap: the requirement is documented in the Requirements lists but was absent at the example a copy-pasting user actually touches — the exact spot where a single-AZ user would hit a confusing failure. Verified rendering in the deploy preview.

Verdict

Ready to merge; resolves DOC-2021 jointly with #635.

🤖 Generated with Claude Code

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.

1 participant