update shadowing config

[paulohtb6]

Description

Resolves https://redpandadata.atlassian.net/browse/
Review deadline:

Page previews

Checks

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

[netlify]

✅ Deploy Preview for redpanda-docs-preview ready!

Name	Link
🔨 Latest commit	74739b9
🔍 Latest deploy log	https://app.netlify.com/projects/redpanda-docs-preview/deploys/6920be03adbced0008c7e0ad
😎 Deploy Preview	https://deploy-preview-1486--redpanda-docs-preview.netlify.app
📱 Preview on mobile	Toggle 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]

📝 Walkthrough

Walkthrough

This pull request updates the disaster recovery shadowing configuration documentation by restructuring and renaming configuration sections. Changes include nesting fields like auto_create_shadow_topic_filters under topic_metadata_sync_options, reorganizing consumer offset and security configurations under new parent structures, renaming filter pattern types (PREFIX to PREFIXED), updating topic/consumer group offset options (replacing start_offset variants), refactoring TLS settings to tls_file_settings, moving authentication to scram_configuration, updating RPK command syntax (--output to -o), and reorganizing Schema Registry shadowing into a dedicated schema_registry_sync_options block. All changes are confined to configuration examples and documentation content.

Estimated code review effort

🎯 3 (Moderate) | ⏱️ ~25 minutes

• Configuration structure accuracy: Verify all field renames and nesting levels are correct and consistently applied throughout examples
• Example completeness: Ensure all YAML examples reflect the new structure and are syntactically valid for the new configuration schema
• Cross-referencing: Confirm internal documentation references and anchor links align with reorganized sections
• Consistency: Verify consistent application of naming conventions across all filter types, offset options, and authentication configurations

Possibly related PRs

• Rpk update 25.3 #1465 — Directly overlaps with this PR's rework of the setup.adoc file with config field renames and structure changes
• Rpk shadow #1466 — Modifies the same shadowing documentation and updates rpk shadow configuration fields
• fix DR links #1481 — Updates the same disaster-recovery shadowing documentation with anchor/cross-reference and section structure changes

Suggested reviewers

• Feediver1
• r-vasquez
• kbatuigas

Pre-merge checks and finishing touches

❌ Failed checks (1 warning, 1 inconclusive)

Check name	Status	Explanation	Resolution
Description check	⚠️ Warning	The description lacks concrete details about the changes; it uses placeholder text () without an actual ticket reference and does not specify what was changed or why.	Fill in the actual Jira ticket, add a substantive description of configuration changes, specify the review deadline, and check the appropriate category from the checklist.
Title check	❓ Inconclusive	The title is vague and generic, using non-descriptive phrasing that doesn't convey the specific nature of the configuration changes.	Replace with a more specific title like 'Refactor shadowing configuration structure and update documentation' to better convey the scope of changes.

✅ Passed checks (1 passed)

Check name	Status	Explanation
Docstring Coverage	✅ Passed	No functions found in the changed files to evaluate docstring coverage. Skipping docstring coverage check.

✨ Finishing touches

🧪 Generate unit tests (beta)

• Create PR with unit tests
• Post copyable unit tests in a comment
• Commit unit tests in branch update-config

---

Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out.

❤️ Share

• X
• Mastodon
• Reddit
• LinkedIn

_{Comment @coderabbitai help to get the list of available commands and usage tips.}

[coderabbitai]

Actionable comments posted: 0

Caution

Some comments are outside the diff and can’t be posted inline due to platform limitations.

⚠️ Outside diff range comments (1)

modules/manage/pages/disaster-recovery/shadowing/setup.adoc (1)

199-206: Pattern type documentation is incomplete; examples use PREFIXED which isn't documented.

The "Filter types and patterns" section documents LITERAL and PREFIX, but examples at lines 298 and 578 use pattern_type: PREFIXED. According to the AI summary, pattern types were renamed from PREFIX to PREFIXED. The documentation needs to reflect this change to match the examples and avoid user confusion.

Update the documentation to include the renamed pattern type:

 * **Pattern type**: Determines how names are matched
   - `LITERAL`: Matches names exactly (including the special wildcard `*` to match all items)
-  - `PREFIX`: Matches names that start with the specified string
+  - `PREFIXED`: Matches names that start with the specified string

Then audit all examples to ensure consistency—replace pattern_type: PREFIX with pattern_type: PREFIXED in examples that use prefix matching.

🧹 Nitpick comments (1)

modules/manage/pages/disaster-recovery/shadowing/setup.adoc (1)

347-365: Clarify the structure for start_at_timestamp examples.

The timestamp example at line 364 lacks the nested block structure shown for start_at_earliest and start_at_latest. Consider adding a clarifying comment or reformatting for consistency:

 Or to start from a specific timestamp:
 [,yaml]
 ----
 topic_metadata_sync_options:
-  start_at_timestamp: 2024-01-01T00:00:00Z
+  start_at_timestamp:
+    timestamp: 2024-01-01T00:00:00Z
 ----

Verify the actual YAML schema to ensure the structure shown is correct. If start_at_timestamp is a direct string value (not nested), the current format is correct but should be clarified in a note.

📜 Review details

Configuration used: CodeRabbit UI

Review profile: CHILL

Plan: Pro

Disabled knowledge base sources:

• Jira 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 dc4cfcb and 74739b9.

📒 Files selected for processing (1)

• modules/manage/pages/disaster-recovery/shadowing/setup.adoc (10 hunks)

🧰 Additional context used

🧠 Learnings (1)

📚 Learning: 2025-09-16T13:51:26.524Z

Learnt from: JakeSCahill
Repo: redpanda-data/docs PR: 1358
File: modules/reference/partials/rpk-cloud/rpk-cloud-mcp-proxy.adoc:57-63
Timestamp: 2025-09-16T13:51:26.524Z
Learning: rpk config file search paths are platform-specific: macOS uses "~/Library/Application Support/rpk/rpk.yaml" while Linux uses "/var/lib/redpanda/.config/rpk/rpk.yaml". The documentation should account for platform differences rather than assuming Linux-only paths.

Applied to files:

• modules/manage/pages/disaster-recovery/shadowing/setup.adoc

🔇 Additional comments (1)

modules/manage/pages/disaster-recovery/shadowing/setup.adoc (1)

70-84: All commands verified as valid.

The --print-template flag exists and is properly documented in the official RPK reference. The commands shown in the TIP section match the documented examples exactly, and the descriptions accurately reflect the flag behavior. No changes needed.