-
Notifications
You must be signed in to change notification settings - Fork 477
Docs for JWT/OIDC authorization in v25.4 #20921
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
base: main
Are you sure you want to change the base?
Conversation
✅ Deploy Preview for cockroachdb-api-docs canceled.
|
✅ Deploy Preview for cockroachdb-interactivetutorials-docs canceled.
|
✅ Netlify Preview
To edit notification comments on pull requests, go to your Netlify project configuration. |
This commit addresses critical documentation issues in sso-sql.md where JWT authentication was incorrectly presented as requiring OIDC/DB Console configuration. JWT authentication works independently with external IdPs. Changes to sso-sql.md: - Rewrite intro to clarify JWT tokens come from external IdPs (primary method) - Position DB Console JWT generation as optional convenience feature - Add v25.4 features introduction (JWT authorization, user provisioning) - Fix prerequisites: remove incorrect OIDC requirement, clarify user provisioning - Update "Authenticate to your cluster" section to distinguish two JWT methods - Remove product scope restrictions (Enterprise license no longer required) - Remove misplaced callout about DB Console availability Changes to sso-db-console.md: - Add callout clarifying Basic/Standard clusters lack DB Console access - Link to cloud-sso-sql.md for alternative authentication on those tiers Based on evidence from: - Engineering docs (jwtauthccl package architectural independence) - Release history (JWT auth v22.2, DB Console generation v23.1) - Cloud docs (cloud-sso-sql.md explicitly mentions "external IdP") - Code analysis (no OIDC dependencies in JWT authentication) Fixes confusion where users believed JWT authentication required DB Console or OIDC configuration, when it actually works with any external IdP.
src/current/v25.4/sso-sql.md
Outdated
| -- View all JWT-provisioned users | ||
| SELECT rolname, rolprovisionsrc | ||
| FROM pg_roles | ||
| WHERE rolprovisionsrc LIKE 'jwt_token:%'; |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Does this work? We haven't added any new columns to the pg_roles table. The existing role options table was changed to have a new option type 'PROVISIONSRC'. with value as mentioned.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
@souravcrl Thanks - confirmed incorrect. In a new commit, I've replaced this with using SHOW ROLES. Please take a look, and if everything else in the PR looks good, please approve and I'll merge it.
Fixes DOC-13052
NEW - v25.4/jwt-authorization.md
NEW - v25.4/oidc-authorization.md
REWRITE - v25.4/sso-sql.md
Minor updates: