manage/rpk: document OAUTHBEARER (OIDC) for Admin API + Schema Registry, add validation step#1762
Conversation
…ry, add validation step redpanda-data/redpanda#30169 added the OAUTHBEARER SASL mechanism to rpk's Kafka, Admin API, and Schema Registry clients. The OIDC docs covered only the Kafka API, and two notes still claimed rpk can use only HTTP basic auth for the Admin API. - authentication partial: note OAUTHBEARER also authenticates Admin API and Schema Registry requests; correct the two stale "rpk supports only basic auth for the Admin API" claims; add a "Validate OIDC authentication" step (rpk cluster info + success criteria, with the existing troubleshooting as the failure branch). - rpk -X reference: broaden the sasl.mechanism note to all three clients; cross-reference OAUTHBEARER token handling from the user and pass options. Co-Authored-By: Claude Opus 4.8 (1M context) <noreply@anthropic.com>
|
Important Review skippedAuto incremental reviews are disabled on this repository. 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:
📝 WalkthroughWalkthroughDocumentation in Estimated code review effort🎯 2 (Simple) | ⏱️ ~10 minutes Possibly related PRs
Suggested reviewers
🚥 Pre-merge checks | ✅ 4 | ❌ 1❌ Failed checks (1 warning)
✅ Passed checks (4 passed)
✏️ Tip: You can configure your own custom pre-merge checks in the settings. ✨ Finishing Touches🧪 Generate unit tests (beta)
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 |
✅ Deploy Preview for redpanda-docs-preview ready!
To edit notification comments on pull requests, go to your Netlify project configuration. |
micheleRP
left a comment
There was a problem hiding this comment.
Review — LGTM with one follow-up
Content is accurate and well-scoped. It correctly covers the rest of redpanda-data/redpanda#30169 (OAUTHBEARER for the Kafka, Admin API, and Schema Registry clients) and fixes the two now-stale "rpk supports only basic authentication for the Admin API" claims. The new validation step and `-X` option cross-references read cleanly, `#oidc-rpk` resolves on `main`, and the changed content passes a docs-team-standards check (xref syntax, terminology, active voice, heading case all clean).
Follow-up (not blocking): this PR's own text notes OAUTHBEARER "was added in rpk v26.1.7 (also backported to v25.3.x and v25.2.x)." Since the feature ships on `v/25.3` and `v/25.2`, this Admin API + Schema Registry coverage should be backported to both branches too (same as #1761 → #1763). Worth opening those backport PRs so older-version users get the corrected guidance.
What
Builds on the recently-added OIDC + rpk OAUTHBEARER docs to cover the rest of redpanda-data/redpanda#30169, and adds an explicit validation step on the OIDC page.
#30169 added the
OAUTHBEARERSASL mechanism to rpk's Kafka, Admin API, and Schema Registry clients (token passed via--password/-X pass, astoken:<TOKEN>or a raw token). The existing OIDC docs described only the Kafka API, and two notes still claimed rpk can use only HTTP basic auth for the Admin API.Changes
modules/manage/partials/authentication.adoc(shared partial — renders on both the standard and Kubernetes authentication pages):-X sasl.mechanism=OAUTHBEARER/-X passtoken also authenticates Admin API and Schema Registry requests when those listeners have OIDC enabled.[[oidc-rpk-validate]]): runrpk cluster infoagainst the OIDC listener, what a successful response confirms, with the existing token-rejection checklist reframed as the failure branch.rpadmin.BearerToken), and the Admin API supports OIDC server-side (per the "Authentication for the HTTP APIs" section).modules/reference/pages/rpk/rpk-x-options.adoc:sasl.mechanismOAUTHBEARER note to state rpk uses the mechanism and token for its Kafka, Admin API, and Schema Registry clients.user(leave unset) andpass(holds the OIDC token) options.Validation
<<sasl-mechanism>>and<<pass>>xrefs are already used in the page's-Xoptions table.adminapi/admin.go,kafka/client_franz.go,schemaregistry/client.go).Preview pages
🤖 Generated with Claude Code