Distinguish between the two ways to enable SASL #1562
Conversation
❌ Deploy Preview for redpanda-docs-preview failed. Why did it fail? →Built without sensitive environment variables
|
|
Important Review skippedAuto incremental reviews are disabled on this repository. Please check the settings in the CodeRabbit UI or the You can disable this status message by setting the
📝 WalkthroughWalkthroughThis change updates the authentication documentation in Estimated code review effort🎯 2 (Simple) | ⏱️ ~12 minutes Suggested reviewers
🚥 Pre-merge checks | ✅ 2 | ❌ 1❌ Failed checks (1 inconclusive)
✅ Passed checks (2 passed)
✏️ Tip: You can configure your own custom pre-merge checks in the settings. ✨ Finishing touches🧪 Generate unit tests (beta)
Warning Review ran into problems🔥 ProblemsErrors were encountered while retrieving linked issues. Errors (1)
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. Comment |
![coderabbitai[bot]](https://avatars.githubusercontent.com/in/347564?s=60&v=4){kind=small}
There was a problem hiding this comment.
Actionable comments posted: 1
🤖 Fix all issues with AI agents
In `@modules/manage/partials/authentication.adoc`:
- Around line 548-554: The cross-reference to enable-sasl-authentication is
broken because that anchor isn’t present; fix it by either adding the missing
anchor id "enable-sasl-authentication" immediately above the relevant heading
(so the xref resolves) or update the xref to point to an existing anchor/ID used
in this document (for example the actual heading ID for SASL enablement or the
authentication section); ensure the xref text remains
"enable-sasl-authentication" or change it to the correct existing ID and verify
the xref renders.
vuldin
force-pushed
the
distinguish-two-sasl-enable-routes
branch
from
2a62d06 to
08de78d
Compare
|
|
||
| *Why two methods?* | ||
|
|
||
| * *Method 1* (`enable_sasl`) is the original approach, maintained for backwards compatibility. It applies SASL globally to all Kafka listeners with a single command. |
There was a problem hiding this comment.
| * *Method 1* (`enable_sasl`) is the original approach, maintained for backwards compatibility. It applies SASL globally to all Kafka listeners with a single command. | |
| * *`enable_sasl`* - is the original approach, which is maintained for backwards compatibility. It applies SASL globally to all Kafka listeners with a single command. |
There was a problem hiding this comment.
@vuldin
I'm not sure "the original approach" will resonate so much with users. Original from when? Is there any other distinguishing quality other than it is an "original approach"? Legacy approach?
There was a problem hiding this comment.
The problem with legacy approach seems to be that it isn't actually deprecated. I guess "legacy" doesn't actually mean "deprecated" though. Maybe instead of "original" but "first implemented approach"?
There was a problem hiding this comment.
mulling it over--i'll come up with something.
|
Hi @vuldin, |
Feediver1
force-pushed
the
distinguish-two-sasl-enable-routes
branch
from
08de78d to
04bbe3f
Compare
|
Hi @Feediver1 , I think I've handled all feedback up to this point (with one minor question in a comment above). |
2 participants
Description
This PR makes it clear there are two ways to enable SASL, explains what they are, when to choose one or the other, and why we even have two ways to begin with (why not just one?), and which is the recommended path for new clusters.
Page previews
https://deploy-preview-1562--redpanda-docs-preview.netlify.app/current/manage/security/authentication/
Checks