Skip to content

Conversation

@micheleRP
Copy link
Contributor

@micheleRP micheleRP commented Dec 9, 2025

Description

This pull request adds support for SASL/PLAIN authentication alongside existing methods for Self-Managed.

  • Explicitly add SASL/PLAIN as a supported authentication method for the shadow link connection, updating instructions to mention SASL/SCRAM, SASL/PLAIN, TLS, and mTLS.
  • Add configuration examples for SASL/PLAIN authentication (plain_configuration) in the client_options sections, alongside existing SASL/SCRAM examples, and ensure these are documented for non-cloud environments. [1] [2]
  • Temporarily changed the referenced branch for cloud-docs in local-antora-playbook.yml from main to DOC-1621-Document-Cloud-Feature-Shadowing-Disaster-Recovery-Enterprise to show preview docs in Cloud don't contain this.

Resolves https://redpandadata.atlassian.net/browse/DOC-1855
Review deadline:

Page previews

Configure Shadowing: SM (search for PLAIN)
Configure Shadowing: Cloud (search for PLAIN)

Checks

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

@micheleRP micheleRP requested a review from a team as a code owner December 9, 2025 23:24
@netlify
Copy link

netlify bot commented Dec 9, 2025

Deploy Preview for redpanda-docs-preview ready!

Name Link
🔨 Latest commit 43f9518
🔍 Latest deploy log https://app.netlify.com/projects/redpanda-docs-preview/deploys/6938fa0bfaefb50008db21c7
😎 Deploy Preview https://deploy-preview-1510--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
Copy link
Contributor

coderabbitai bot commented Dec 9, 2025

Important

Review skipped

Auto incremental reviews are disabled on this repository.

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.

You can disable this status message by setting the reviews.review_status to false in the CodeRabbit configuration file.

📝 Walkthrough

Walkthrough

This PR updates the local Antora playbook to source cloud documentation from a feature branch dedicated to documenting the shadowing disaster recovery feature. It also introduces SASL/PLAIN authentication configuration to the disaster recovery setup documentation, with conditional blocks ensuring this configuration only appears in non-cloud environments while preserving existing SASL/SCRAM, TLS, and mTLS options across multiple authentication sections.

Estimated code review effort

🎯 2 (Simple) | ⏱️ ~8 minutes

  • local-antora-playbook.yml: Single branch reference update is straightforward
  • setup.adoc: Repetitive pattern of identical SASL/PLAIN blocks added across multiple authentication sections with consistent conditional gating
  • Primary focus should be verifying consistency of SASL/PLAIN additions across all authenticationConfiguration sections and confirming the ifndef/endif conditional syntax is correct in each location

Possibly related PRs

Suggested reviewers

  • Feediver1
  • paulohtb6

Pre-merge checks and finishing touches

✅ Passed checks (5 passed)
Check name Status Explanation
Title check ✅ Passed The title clearly and specifically summarizes the main change: adding SASL/PLAIN authentication support for Shadowing/Replication in Self-Managed.
Linked Issues check ✅ Passed The PR changes align with both linked issues: DOC-1855 (adds SASL/PLAIN support for SM) and DOC-1621 (coordinates Cloud documentation via branch reference change).
Out of Scope Changes check ✅ Passed All changes are in scope: SASL/PLAIN authentication additions to setup.adoc and temporary cloud-docs branch reference change are directly aligned with DOC-1855 and DOC-1621 objectives.
Docstring Coverage ✅ Passed No functions found in the changed files to evaluate docstring coverage. Skipping docstring coverage check.
Description check ✅ Passed The pull request description is well-structured and comprehensive, following the template with all required sections filled out: a clear description of changes, JIRA reference (DOC-1855), page previews with direct links, and relevant checkboxes marked.

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

Copy link

@rpdevmp rpdevmp left a comment

Choose a reason for hiding this comment

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

LGTM

@micheleRP micheleRP merged commit f3157a0 into main Dec 10, 2025
6 of 7 checks passed
@micheleRP micheleRP deleted the DOC-1855-SR-support-for-SASL-PLAIN-in-SM branch December 10, 2025 04:47
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.

4 participants