DOCS-71:Update authentication.adoc #1317
Conversation
Most updates from https://github.com/redpanda-data/docs/pull/1272/files (now Closed) were implemented in #1298. This PR captures the point about TLS, and the Note, which are still of value.
✅ Deploy Preview for redpanda-docs-preview ready!
To edit notification comments on pull requests, go to your Netlify project configuration. |
|
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 PR updates documentation in modules/manage/partials/authentication.adoc. It adds notes recommending TLS when enabling HTTP Basic authentication and clarifies that the http_authentication cluster property accepts BASIC and OIDC. It distinguishes BASIC from the broker listener setting http_basic and explains the separation between cluster-wide http_authentication and per-listener authentication_method. Clarifications are applied across sections covering Basic authentication, OIDC-enabled HTTP APIs, Admin/API sections, and HTTP API configuration examples. No code changes or behavioral modifications are introduced. Estimated code review effort🎯 2 (Simple) | ⏱️ ~7 minutes Assessment against linked issues
Possibly related PRs
Suggested reviewers
✨ Finishing Touches🧪 Generate unit tests
🪧 TipsChatThere are 3 ways to chat with CodeRabbit:
SupportNeed help? Create a ticket on our support page for assistance with any issues or questions. CodeRabbit Commands (Invoked using PR/Issue comments)Type Other keywords and placeholders
CodeRabbit Configuration File (
|
![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
🧹 Nitpick comments (3)
modules/manage/partials/authentication.adoc (3)
1382-1383: Strengthen TLS guidance for Basic Auth and link to TLS docsRecommend explicitly why TLS is needed and link to the TLS doc to make the guidance actionable.
Apply this diff:
-NOTE: Redpanda Data recommends that you use TLS when enabling HTTP Basic Auth. +NOTE: Redpanda recommends using TLS whenever HTTP Basic Auth is enabled. Basic authentication sends credentials in every request (Base64-encoded only), so use HTTPS on all non-local listeners. See xref:{tls-doc}[].
1595-1596: Repeat the clarified note here (or reference a shared partial) and add both xrefsSame clarification as above; either keep the note duplicated (fine for reader convenience) or replace both instances with a single reusable partial to enforce consistency over time. Also add the PandaProxy anchor.
Apply this diff to align the wording and links:
-NOTE: Valid values for the cluster configuration property xref:reference/properties/cluster-properties.adoc#http_authentication[`http_authentication`] are `BASIC` and `OIDC`. Note that the value `BASIC` is different from the `http_basic` value, which enables authentication for the listener using the broker configuration property `authentication_method`. +NOTE: Valid values for the cluster configuration property xref:reference/properties/cluster-properties.adoc#http_authentication[`http_authentication`] (cluster-wide) are `BASIC` and `OIDC`. The value `BASIC` here is different from the per-listener setting `http_basic`, which enables authentication on a listener via the broker property `authentication_method` (see xref:reference:properties/broker-properties.adoc#schema_registry_auth_method[] and xref:reference:properties/broker-properties.adoc#http_proxy_auth_method[]).Optional: If you prefer de-duplication, consider creating a short partial (for example,
modules/manage/partials/_http-auth-note.adoc) with this admonition and include it in both places.Use the same verification script from the previous comment to confirm anchor IDs.
1357-1357: Fix minor typo: duplicate “see”Small copyedit.
-For a complete list of all Admin API endpoints, see see xref:api:ROOT:admin-api.adoc[]. +For a complete list of all Admin API endpoints, see xref:api:ROOT:admin-api.adoc[].
📜 Review details
Configuration used: CodeRabbit UI
Review profile: CHILL
Plan: Pro
💡 Knowledge Base configuration:
- MCP integration is disabled by default for public repositories
- Jira integration is disabled by default for public repositories
- Linear integration is disabled by default for public repositories
You can enable these sources in your CodeRabbit configuration.
📒 Files selected for processing (1)
modules/manage/partials/authentication.adoc(3 hunks)
⏰ Context from checks skipped due to timeout of 90000ms. You can increase the timeout in your CodeRabbit configuration to a maximum of 15 minutes (900000ms). (3)
- GitHub Check: Redirect rules - redpanda-docs-preview
- GitHub Check: Header rules - redpanda-docs-preview
- GitHub Check: Pages changed - redpanda-docs-preview
fixed broken link
|
Fixed the links @BenPope |
Most updates from https://github.com/redpanda-data/docs/pull/1272/files (now Closed) were implemented in #1298. This PR captures the point about TLS, and the Note, which are still of value.
Description
Resolves DOC-71 and DOC-401
Review deadline:
Page previews
Basic authentication
Checks