Skip to content

Commit 8d70aa8

Browse files
committed
docs(helm): make OpenShift SCC guidance topology-aware in chart README
The chart README's OpenShift quick-start told every user to grant the privileged SCC to the sandbox service account. For the proxy-pod topology that is both unnecessary and counter to the topology's purpose: network enforcement runs outside the pod, so sandbox pods are non-root with drop-ALL and admit under the built-in nonroot-v2 SCC. Split the guidance by topology: combined/sidecar keep the privileged grant; proxy-pod skips it and binds nonroot-v2 via sandboxServiceAccount.openshift.nonrootSCC=true (no manual oc adm policy step). Edit the README.md.gotmpl source and regenerate README.md. The published docs page already carries the topology-aware guidance. Reported in review by 2000krysztof. Signed-off-by: Russell Bryant <[email protected]>
1 parent b3b3c75 commit 8d70aa8

2 files changed

Lines changed: 42 additions & 4 deletions

File tree

‎deploy/helm/openshell/README.md‎

Lines changed: 21 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -32,13 +32,17 @@ helm install openshell oci://ghcr.io/nvidia/openshell/helm-chart --version <vers
3232

3333
## Install on OpenShift
3434

35-
See the full [OpenShift install guide](https://docs.nvidia.com/openshell/latest/kubernetes/openshift) for details. Quick start:
35+
See the full [OpenShift install guide](https://docs.nvidia.com/openshell/latest/kubernetes/openshift) for details. The SCC the sandbox service account needs depends on the supervisor topology.
36+
37+
### combined (default) or sidecar
38+
39+
These topologies enforce network policy inside the sandbox pod and require the `privileged` SCC on the sandbox service account:
3640

3741
```shell
3842
# Precreate the openshell namespace so we can create the SCC cluster role
3943
oc create ns openshell
4044

41-
# Sandboxes are deployed into the openshell namespace and use the openshell-sandbox service account
45+
# Sandboxes use the openshell-sandbox service account
4246
oc adm policy add-scc-to-user privileged -z openshell-sandbox -n openshell
4347

4448
# Deploy openshell with overrides to allow SCC assignment of fsGroup and runAsUser for the gateway
@@ -48,6 +52,21 @@ helm install openshell oci://ghcr.io/nvidia/openshell/helm-chart --version <vers
4852
--set securityContext.runAsUser=null
4953
```
5054

55+
### proxy-pod
56+
57+
Network enforcement moves to a separate supervisor pod, so sandbox pods run non-root with `drop: ALL` and need no elevated privileges. The built-in `nonroot-v2` SCC is sufficient — do not grant `privileged`. Let the chart bind `nonroot-v2` via `sandboxServiceAccount.openshift.nonrootSCC=true` (requires the default `workspaceMode=shared`); no manual `oc adm policy` step for the sandbox service account is needed:
58+
59+
```shell
60+
oc create ns openshell
61+
62+
helm install openshell oci://ghcr.io/nvidia/openshell/helm-chart --version <version> -n openshell \
63+
--set server.disableTls=true \
64+
--set podSecurityContext.fsGroup=null \
65+
--set securityContext.runAsUser=null \
66+
--set supervisor.topology=proxy-pod \
67+
--set sandboxServiceAccount.openshift.nonrootSCC=true
68+
```
69+
5170
## Available versions
5271

5372
| Tag | Source | Notes |

‎deploy/helm/openshell/README.md.gotmpl‎

Lines changed: 21 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -32,13 +32,17 @@ helm install openshell oci://ghcr.io/nvidia/openshell/helm-chart --version <vers
3232

3333
## Install on OpenShift
3434

35-
See the full [OpenShift install guide](https://docs.nvidia.com/openshell/latest/kubernetes/openshift) for details. Quick start:
35+
See the full [OpenShift install guide](https://docs.nvidia.com/openshell/latest/kubernetes/openshift) for details. The SCC the sandbox service account needs depends on the supervisor topology.
36+
37+
### combined (default) or sidecar
38+
39+
These topologies enforce network policy inside the sandbox pod and require the `privileged` SCC on the sandbox service account:
3640

3741
```shell
3842
# Precreate the openshell namespace so we can create the SCC cluster role
3943
oc create ns openshell
4044
41-
# Sandboxes are deployed into the openshell namespace and use the openshell-sandbox service account
45+
# Sandboxes use the openshell-sandbox service account
4246
oc adm policy add-scc-to-user privileged -z openshell-sandbox -n openshell
4347
4448
# Deploy openshell with overrides to allow SCC assignment of fsGroup and runAsUser for the gateway
@@ -48,6 +52,21 @@ helm install openshell oci://ghcr.io/nvidia/openshell/helm-chart --version <vers
4852
--set securityContext.runAsUser=null
4953
```
5054

55+
### proxy-pod
56+
57+
Network enforcement moves to a separate supervisor pod, so sandbox pods run non-root with `drop: ALL` and need no elevated privileges. The built-in `nonroot-v2` SCC is sufficient — do not grant `privileged`. Let the chart bind `nonroot-v2` via `sandboxServiceAccount.openshift.nonrootSCC=true` (requires the default `workspaceMode=shared`); no manual `oc adm policy` step for the sandbox service account is needed:
58+
59+
```shell
60+
oc create ns openshell
61+
62+
helm install openshell oci://ghcr.io/nvidia/openshell/helm-chart --version <version> -n openshell \
63+
--set server.disableTls=true \
64+
--set podSecurityContext.fsGroup=null \
65+
--set securityContext.runAsUser=null \
66+
--set supervisor.topology=proxy-pod \
67+
--set sandboxServiceAccount.openshift.nonrootSCC=true
68+
```
69+
5170
## Available versions
5271

5372
| Tag | Source | Notes |

0 commit comments

Comments
 (0)