docs: Terraform shadow link management (DOC-2022)#1827
Open
Feediver1 wants to merge 1 commit into
Open
Conversation
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>
✅ Deploy Preview for redpanda-docs-preview ready!
To edit notification comments on pull requests, go to your Netlify project configuration. |
Contributor
|
Important Review skippedAuto reviews are disabled on base/target branches other than the default branch. Please check the settings in the CodeRabbit UI or the ⚙️ Run configurationConfiguration used: Organization UI Review profile: CHILL Plan: Pro Run ID: You can disable this status message by setting the Use the checkbox below for a quick retry:
✨ Finishing Touches🧪 Generate unit tests (beta)
Comment |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Resolves https://redpandadata.atlassian.net/browse/DOC-2022
Adds Terraform as a management option on the Configure Shadowing page, covering the
redpanda_shadow_linkresource shipped in Redpanda Terraform provider v2.0.0 (PR #343; current release v2.1.2).Changes
redpanda_secret+redpanda_shadow_linkpattern 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 theenable_shadow_linkingprerequisite (settable viaredpanda_cluster.cluster_configuration.custom_properties_json) and theallow_deletion = truedestroy guard.terraform applysends 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
describe_configs); the tab points at the prerequisites instead. Flagged to the provider team separately.enable_shadow_linking(verified inresource_shadowlink.goCreate()), so the property is framed as a prerequisite, not a validated field.shadow_linkbullet 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.