[v/25.3] manage: document rpk OAUTHBEARER (OIDC) for Kafka/Admin/SR APIs#1766
Conversation
….3 backport] Ports the rpk OAUTHBEARER docs from main (the OIDC work that #1762 refines) to v/25.3, since rpk OAUTHBEARER support (redpanda-data/redpanda#30169) was backported to the v25.3.x release line: - rpk -X reference: OAUTHBEARER sasl.mechanism note + user/pass guidance. - authentication partial: add the "Connect to Redpanda with OIDC using rpk" section (incl. a "Validate OIDC authentication" step) to the OAUTHBEARER (OIDC) section; correct three stale "rpk only supports basic auth for the Admin API" notes (rpk v26.1.7+ can use OAUTHBEARER for the Admin API). The GBAC xref is dropped since gbac.adoc does not exist on this branch. - netlify.toml: pin NODE_VERSION=20 so the new Netlify build image (which defaults to node 22 and fails npm install on this branch's deps) builds the preview. Co-Authored-By: Claude Opus 4.8 (1M context) <noreply@anthropic.com>
✅ Deploy Preview for redpanda-docs-preview ready!
To edit notification comments on pull requests, go to your Netlify project configuration. |
|
Important Review skippedAuto reviews are disabled on base/target branches other than the default branch. 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:
✨ 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 |
micheleRP
left a comment
There was a problem hiding this comment.
Backport review — LGTM
Verified this v/25.3 port of the rpk OAUTHBEARER docs (the work #1762 refines). Since the foundational OIDC content didn't exist on this branch, porting the self-contained feature docs rather than cherry-picking is the right call, and the result is correct and version-appropriate:
- Both anchors present (`[[oidc-rpk]]`, `[[oidc-rpk-validate]]`); delimited blocks balanced.
- All xref targets resolve on `v/25.3`: `cluster-properties.adoc#sasl_mechanisms{,_overrides}`, `security/authorization/index.adoc#acls`, `rpk/rpk-profile/rpk-profile-create.adoc`, `rpk-x-options.adoc#oidc-rpk`, and `<>` (same section title as main, so the auto-ID matches). ✓
- Correctly drops the GBAC xref since `gbac.adoc` doesn't exist on this branch. ✓
- All three stale "rpk only supports basic authentication for the Admin API" claims corrected; no stale claims remain. ✓
- `netlify.toml` node-20 pin matches the justified CI fix from #1763.
Content mirrors the main-branch equivalents and reads cleanly against docs-team-standards.
Backports the rpk OAUTHBEARER documentation to v/25.3. rpk OAUTHBEARER (redpanda-data/redpanda#30169) was backported to the v25.3.x release line, so it should be documented here.
A literal cherry-pick of #1762 wasn't possible — the foundational OAUTHBEARER content #1762 refines doesn't exist on this branch (authentication.adoc is ~490 lines behind main). This PR ports the self-contained OAUTHBEARER feature docs instead (the [scope chosen with the author]):
-Xreference (rpk-x-options.adoc):OAUTHBEARERadded tosasl.mechanismacceptable values + note (token viapass, leaveuserunset, applies to Kafka/Admin/SR clients), anduser/passcross-notes.[[oidc-rpk]]"Connect to Redpanda with OIDC using rpk" section (with a Validate OIDC authentication step) to the existing OAUTHBEARER (OIDC) section; corrects three stale "rpk only supports basic auth for the Admin API" notes. The GBAC xref from main is omitted (gbac.adocdoesn't exist on this branch).netlify.toml: pinsNODE_VERSION = "20"(matching.github/workflows/test-docs.yml) so the new Netlify image doesn't default to node 22 / npm 10.9.3 and failnpm install.Verified: delimited blocks balanced, both anchors present, all xref targets resolve on this branch (
#acls,sasl_mechanisms_overrides,oidc-credentials-flow…), no stale claims remain.🤖 Generated with Claude Code