Skip to content

docs: Terraform shadow link management (DOC-2022)#1827

Open
Feediver1 wants to merge 1 commit into
betafrom
DOC-2022-terraform-shadow-link
Open

docs: Terraform shadow link management (DOC-2022)#1827
Feediver1 wants to merge 1 commit into
betafrom
DOC-2022-terraform-shadow-link

Conversation

@Feediver1

@Feediver1 Feediver1 commented Jul 25, 2026

Copy link
Copy Markdown
Contributor

Resolves https://redpandadata.atlassian.net/browse/DOC-2022

Adds Terraform as a management option on the Configure Shadowing page, covering the redpanda_shadow_link resource shipped in Redpanda Terraform provider v2.0.0 (PR #343; current release v2.1.2).

Changes

  • Create a shadow link: new Terraform tab in the cloud-gated tabs block (alongside Cloud UI / rpk / Control Plane API). Shows the redpanda_secret + redpanda_shadow_link pattern with TLS and SCRAM auth, the ${secrets.<name>} password reference (no plaintext in state), placeholder explanations in the page's existing style, and a NOTE covering the enable_shadow_linking prerequisite (settable via redpanda_cluster.cluster_configuration.custom_properties_json) and the allow_deletion = true destroy guard.
  • Update an existing shadow link: new Terraform tab noting that terraform apply sends only changed fields (the provider uses a sparse FieldMask), and that name and cluster IDs are immutable (changes plan a replacement).

Both edits are inside existing ifdef::env-cloud[] regions of the single-sourced page, so they render only in the cloud build; the Self-Managed build is unchanged. The cloud-docs stub picks the content up automatically.

Review notes

  • The HCL example is adapted from the provider's own examples/shadow_link/main.tf and trimmed to the minimal verified surface. Sync-option blocks are deliberately not shown inline; the tab links to the registry reference and the provider example for the full schema, to avoid drifting from generated docs.
  • The provider example's ACL blocks are not reproduced because they grant fewer permissions than this page's "Replication service permissions" prerequisites require (missing describe_configs); the tab points at the prerequisites instead. Flagged to the provider team separately.
  • The provider does no client-side check of enable_shadow_linking (verified in resource_shadowlink.go Create()), so the property is framed as a prerequisite, not a validated field.
  • No Private Link claims are made; PL/PSC validation for shadow links was still in flight per the engineering epic's last update.
  • Companion cloud-docs PR adds the shadow_link bullet to the Terraform provider resource list.

🤖 Generated with Claude Code

Preview pages

Note for reviewers: this preview renders the Self-Managed variant, which is intentionally unchanged (verified: zero Terraform mentions). The new Terraform tabs are inside ifdef::env-cloud[] regions and render only in the cloud build. Rendering was verified in a local cloud-docs build with the playbook pointed at this branch: both tabs appear in the create and update tab blocks, the HCL example and nested NOTE render cleanly, and no AsciiDoc directives leak.

Adds a Terraform tab to the cloud-gated create and update tab blocks
on the Configure Shadowing page, covering the redpanda_shadow_link
resource (provider 2.0.0+), the redpanda_secret password pattern,
the enable_shadow_linking prerequisite, and the allow_deletion guard.

Co-Authored-By: Claude Fable 5 <noreply@anthropic.com>
@Feediver1
Feediver1 requested a review from a team as a code owner July 25, 2026 18:49
@netlify

netlify Bot commented Jul 25, 2026

Copy link
Copy Markdown

Deploy Preview for redpanda-docs-preview ready!

Name Link
🔨 Latest commit 8f06043
🔍 Latest deploy log https://app.netlify.com/projects/redpanda-docs-preview/deploys/6a65053d5faee70008ce710d
😎 Deploy Preview https://deploy-preview-1827--redpanda-docs-preview.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 25, 2026

Copy link
Copy Markdown
Contributor

Important

Review skipped

Auto reviews are disabled on base/target branches other than the default branch.

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.

⚙️ Run configuration

Configuration used: Organization UI

Review profile: CHILL

Plan: Pro

Run ID: f5137609-d829-4b6f-b354-9ac741ac11ec

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
✨ Finishing Touches
🧪 Generate unit tests (beta)
  • Create PR with unit tests
  • Commit unit tests in branch DOC-2022-terraform-shadow-link

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

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