diff --git a/README.md b/README.md index 937ec8007..02447e421 100644 --- a/README.md +++ b/README.md @@ -47,6 +47,8 @@ helm install openshell oci://ghcr.io/nvidia/openshell/helm-chart See [`deploy/helm/openshell/README.md`](deploy/helm/openshell/README.md) for available versions, dev tag conventions, and configuration. +For deploying OpenShell on OpenShift, see [`deploy/helm/openshell/README.md#install-on-openshift`](deploy/helm/openshell/README.md#install-on-openshift). + ### Create a sandbox ```bash diff --git a/deploy/helm/openshell/README.md b/deploy/helm/openshell/README.md index 911fe40fc..f6a385bba 100644 --- a/deploy/helm/openshell/README.md +++ b/deploy/helm/openshell/README.md @@ -4,12 +4,29 @@ This chart deploys the OpenShell gateway into a Kubernetes cluster. It is published as an OCI artifact to GHCR at `oci://ghcr.io/nvidia/openshell/helm-chart`. -## Install +## Install on Kubernetes ```bash helm install openshell oci://ghcr.io/nvidia/openshell/helm-chart --version ``` +## Install on OpenShift + +```bash +# Precreate the openshell namespace so we can create the SCC cluster role +oc create ns openshell + +# Sandboxes are deployed into the openshell namespace and use the default service account for now +oc adm policy add-scc-to-user privileged -z default -n openshell + +# Deploy openshell with overrides to allow SCC assignment of fsGroup and runAsUser for the gateway +helm install openshell oci://ghcr.io/nvidia/openshell/helm-chart --version -n openshell \ + --set pkiInitJob.enabled=false \ + --set server.disableTls=true \ + --set podSecurityContext.fsGroup=null \ + --set securityContext.runAsUser=null +``` + ## Available versions | Tag | Source | Notes |