Skip to content

docs(kubernetes): add RBAC reference page#1250

Open
mesutoezdil wants to merge 1 commit intoNVIDIA:mainfrom
mesutoezdil:docs/kubernetes-rbac-reference
Open

docs(kubernetes): add RBAC reference page#1250
mesutoezdil wants to merge 1 commit intoNVIDIA:mainfrom
mesutoezdil:docs/kubernetes-rbac-reference

Conversation

@mesutoezdil
Copy link
Copy Markdown
Contributor

@mesutoezdil mesutoezdil commented May 7, 2026

Summary

Documents the Kubernetes RBAC resources created by the OpenShell Helm chart. Operators deploying to existing clusters had no way to determine the required permissions without reading the chart templates directly.

Related Issue

Closes #1018

Changes

  • docs/kubernetes/rbac.mdx: new page covering the namespaced Role, ClusterRole, ServiceAccount, bring-your-own ServiceAccount configuration, namespace-only access guidance, and multi-tenant clusters.
  • docs/kubernetes/setup.mdx: added a link to the new RBAC page in the Next Steps section.

Testing

Documentation change only. No code changes.

Checklist

  • Follows Conventional Commits
  • Commits are signed off (DCO)
  • Follows the docs style guide
  • No duplicate H1
  • Active voice

@copy-pr-bot
Copy link
Copy Markdown

copy-pr-bot Bot commented May 7, 2026

This pull request requires additional validation before any workflows can run on NVIDIA's runners.

Pull request vetters can view their responsibilities here.

Contributors can view more details about this message here.

@mesutoezdil mesutoezdil force-pushed the docs/kubernetes-rbac-reference branch from 06916ce to 9d2bfe1 Compare May 7, 2026 20:52
@TaylorMutch
Copy link
Copy Markdown
Collaborator

This is somewhat deviating from the plan, but perhaps the RBAC details can be kept under the setup page? That way its all together in one place. WDYT?

Documents the ServiceAccount, Role, and ClusterRole created by the Helm
chart, including per-permission purpose annotations, bring-your-own
ServiceAccount instructions, and multi-tenant guidance. Links the new
page from the setup Next Steps section.

Closes NVIDIA#1018

Signed-off-by: mesutoezdil <mesudozdil@gmail.com>
@mesutoezdil mesutoezdil force-pushed the docs/kubernetes-rbac-reference branch from 9d2bfe1 to 1b2af8c Compare May 7, 2026 20:57
@mesutoezdil
Copy link
Copy Markdown
Contributor Author

@TaylorMutch The issue considered this in the Alternatives Considered section and opted for a dedicated page so the table can grow without cluttering the setup walkthrough and can be linked directly from error messages or external docs. That said, if the team prefers consolidation, happy to move it into setup.mdx instead.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

feat(docs): Add documentation for OpenShell Kubernetes RBAC requirements

2 participants