Skip to content

Commit 08ea902

Browse files
committed
docs: add supervisor image Helm values to manage-gateways reference
The supervisor init container was introduced in #1154 but the three `supervisor.image.*` values were missing from the Helm values reference table in the manage-gateways doc. Signed-off-by: mesutoezdil <mesudozdil@gmail.com>
1 parent 9ea94b6 commit 08ea902

1 file changed

Lines changed: 18 additions & 1 deletion

File tree

deploy/helm/openshell/README.md

Lines changed: 18 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -47,12 +47,29 @@ The `dev` tags are intended for testing changes ahead of a release. Production d
4747

4848
## Configuration
4949

50-
See [`values.yaml`](values.yaml) for configurable values. Selected overlays:
50+
See [`values.yaml`](values.yaml) for the full list of configurable values. Selected overlays:
5151

5252
- [`ci/values-gateway.yaml`](ci/values-gateway.yaml) — gateway-only configuration
5353
- [`ci/values-cert-manager.yaml`](ci/values-cert-manager.yaml) — cert-manager integration
5454
- [`ci/values-keycloak.yaml`](ci/values-keycloak.yaml) — Keycloak OIDC integration
5555

56+
Commonly configured values:
57+
58+
| Value | Purpose |
59+
|---|---|
60+
| `image.repository` / `image.tag` | Gateway image. Defaults to `ghcr.io/nvidia/openshell/gateway`. |
61+
| `service.type` | Kubernetes service type. Use `ClusterIP`, `NodePort`, or your platform default. |
62+
| `server.dbUrl` | Gateway database URL. Defaults to SQLite on the chart-managed persistent volume. |
63+
| `server.sandboxNamespace` | Namespace where sandbox resources are created. |
64+
| `server.sandboxImage` | Default sandbox image used when a sandbox does not specify one. |
65+
| `server.grpcEndpoint` | Endpoint that sandbox supervisors use to call back to the gateway. |
66+
| `server.sshGatewayHost` / `server.sshGatewayPort` | Public host and port returned to CLI clients for SSH proxy connections. |
67+
| `server.disableTls` | Run the gateway over plaintext HTTP. Use only behind a trusted transport. |
68+
| `server.tls.*` | Secret names for server and client mTLS materials. |
69+
| `supervisor.image.repository` | Repository for the supervisor init container image. Defaults to `ghcr.io/nvidia/openshell/supervisor`. |
70+
| `supervisor.image.tag` | Tag for the supervisor image. Defaults to the chart's `appVersion` so the supervisor and gateway stay in sync. |
71+
| `supervisor.image.pullPolicy` | Pull policy for the supervisor image. Defaults to the Kubernetes cluster default when unset. |
72+
5673
## PKI bootstrap
5774

5875
By default, a pre-install/pre-upgrade hook Job runs `openshell-gateway generate-certs`

0 commit comments

Comments
 (0)