Skip to content
Merged
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
docs(kubernetes): add RBAC section to setup page
Documents the ServiceAccount, Role, and ClusterRole created by the Helm
chart inline on the setup page, per reviewer feedback on #1250. Reflects
the current chart templates including pods/get for sandbox identity and
tokenreviews/create for projected token validation.

Closes #1018
  • Loading branch information
moezdil committed May 23, 2026
commit 2bda0aa48d6f6e114d506c7f8e07ea788493bcda
39 changes: 39 additions & 0 deletions docs/kubernetes/setup.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -152,6 +152,45 @@ helm upgrade --install openshell \
--values my-values.yaml
```

## RBAC

The chart creates the following RBAC resources in the release namespace:

| Resource | Scope | Name |
|---|---|---|
| ServiceAccount | Namespace | `openshell` |
| ServiceAccount | Namespace | `openshell-sandbox` (for sandbox pods) |
| Role + RoleBinding | Namespace | `openshell-sandbox` |
| ClusterRole + ClusterRoleBinding | Cluster | `openshell-node-reader` |

The namespaced Role covers sandbox lifecycle and identity:

| API Group | Resource | Verbs |
|---|---|---|
| `agents.x-k8s.io` | `sandboxes`, `sandboxes/status` | create, delete, get, list, patch, update, watch |
| `""` | `events` | get, list, watch |
| `""` | `pods` | get |

The ClusterRole grants node inspection and token validation:

| API Group | Resource | Verbs |
|---|---|---|
| `authentication.k8s.io` | `tokenreviews` | create |
| `""` | `nodes` | get, list, watch |

To use an existing ServiceAccount instead of creating one, set `serviceAccount.create=false` and supply its name:

```shell
helm upgrade --install openshell \
oci://ghcr.io/nvidia/openshell/helm-chart \
--version <version> \
--namespace openshell \
--set serviceAccount.create=false \
--set serviceAccount.name=my-existing-sa
```

The ServiceAccount must already have the Role and ClusterRole bindings described above.

## Next Steps

- To enable automatic certificate rotation with cert-manager, refer to [Managing Certificates](/kubernetes/managing-certificates).
Expand Down
Loading