Skip to content

chore: add documentation for OIDC seed setup#402

Merged
mckornfield merged 1 commit into
mainfrom
address-auth-seed-docs-needs/mck
Jun 23, 2026
Merged

chore: add documentation for OIDC seed setup#402
mckornfield merged 1 commit into
mainfrom
address-auth-seed-docs-needs/mck

Conversation

@mckornfield

@mckornfield mckornfield commented Jun 23, 2026

Copy link
Copy Markdown
Contributor

Summary by CodeRabbit

Documentation

  • Enhanced OIDC authentication setup with new seeding section explaining role binding creation
  • Clarified how admin email configures platform seeding for PlatformAdmin role assignment
  • Added comprehensive auth setup guidance for source installations, including automatic and manual seeding options
  • Documented expected outcomes and troubleshooting for missing RBAC bindings

Signed-off-by: Matt Kornfield <mkornfield@nvidia.com>
@mckornfield
mckornfield requested review from a team as code owners June 23, 2026 14:32
@github-actions github-actions Bot added the chore label Jun 23, 2026
@github-actions

Copy link
Copy Markdown
Contributor

@coderabbitai

coderabbitai Bot commented Jun 23, 2026

Copy link
Copy Markdown
Contributor

Review Change Stack

No actionable comments were generated in the recent review. 🎉

ℹ️ Recent review info
⚙️ Run configuration

Configuration used: Path: .coderabbit.yaml

Review profile: CHILL

Plan: Enterprise

Run ID: 9de92141-85ec-4c4b-a88c-e07501554155

📥 Commits

Reviewing files that changed from the base of the PR and between 8111245 and 5967f38.

📒 Files selected for processing (3)
  • docs/auth/authentication/oidc.mdx
  • docs/auth/deployment/configuration.mdx
  • docs/get-started/setup.mdx

📝 Walkthrough

Walkthrough

Updates docs to state that platform-seed creates initial auth role bindings, adds source-install and manual seeding instructions, documents the missing-seed 403 Forbidden case, and inserts an OIDC setup step for seeding before verification.

Changes

Auth seeding documentation

Layer / File(s) Summary
Seeded auth bootstrap guidance
docs/auth/deployment/configuration.mdx, docs/get-started/setup.mdx
Clarifies that admin_email is applied through platform-seed, documents Helm and source-install seeding paths, includes manual seed commands and readiness checks, and describes the unseeded 403 Forbidden behavior.
OIDC setup step updates
docs/auth/authentication/oidc.mdx
Adds a “Seed Auth Role Bindings” step to the OIDC guide, explains the bindings created by seeding, and renumbers the later verify step accordingly.

Suggested labels

docs

Suggested reviewers

  • maxdubrinsky
🚥 Pre-merge checks | ✅ 5
✅ Passed checks (5 passed)
Check name Status Explanation
Description Check ✅ Passed Check skipped - CodeRabbit’s high-level summary is enabled.
Title check ✅ Passed The title accurately summarizes the main change: adding documentation for OIDC seed setup.
Docstring Coverage ✅ Passed No functions found in the changed files to evaluate docstring coverage. Skipping docstring coverage check.
Linked Issues check ✅ Passed Check skipped because no linked issues were found for this pull request.
Out of Scope Changes check ✅ Passed Check skipped because no linked issues were found for this pull request.

✏️ Tip: You can configure your own custom pre-merge checks in the settings.

✨ Finishing Touches
🧪 Generate unit tests (beta)
  • Create PR with unit tests
  • Commit unit tests in branch address-auth-seed-docs-needs/mck

Comment @coderabbitai help to get the list of available commands.

@github-actions

Copy link
Copy Markdown
Contributor
Suite Lines Covered Line Rate Branch Rate
Unit Tests 21176/27762 76.3% 61.2%
Integration Tests 12211/26531 46.0% 19.5%

@mckornfield
mckornfield added this pull request to the merge queue Jun 23, 2026
Merged via the queue into main with commit 38e3b89 Jun 23, 2026
55 checks passed
@mckornfield
mckornfield deleted the address-auth-seed-docs-needs/mck branch June 23, 2026 16:15
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants