Skip to content

docs: add supervisor image Helm values to manage-gateways reference #1214

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
mesutoezdil wants to merge 1 commit into
base: main
Choose a base branch
from
+18 −1
Open

docs: add supervisor image Helm values to manage-gateways reference #1214

Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
19 changes: 18 additions & 1 deletion deploy/helm/openshell/README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -47,8 +47,25 @@ The `dev` tags are intended for testing changes ahead of a release. Production d

## Configuration

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

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

Commonly configured values:

| Value | Purpose |
|---|---|
| `image.repository` / `image.tag` | Gateway image. Defaults to `ghcr.io/nvidia/openshell/gateway`. |
| `service.type` | Kubernetes service type. Use `ClusterIP`, `NodePort`, or your platform default. |
| `server.dbUrl` | Gateway database URL. Defaults to SQLite on the chart-managed persistent volume. |
| `server.sandboxNamespace` | Namespace where sandbox resources are created. |
| `server.sandboxImage` | Default sandbox image used when a sandbox does not specify one. |
| `server.grpcEndpoint` | Endpoint that sandbox supervisors use to call back to the gateway. |
| `server.sshGatewayHost` / `server.sshGatewayPort` | Public host and port returned to CLI clients for SSH proxy connections. |
| `server.disableTls` | Run the gateway over plaintext HTTP. Use only behind a trusted transport. |
| `server.tls.*` | Secret names for server and client mTLS materials. |
| `supervisor.image.repository` | Repository for the supervisor init container image. Defaults to `ghcr.io/nvidia/openshell/supervisor`. |
| `supervisor.image.tag` | Tag for the supervisor image. Defaults to the chart's `appVersion` so the supervisor and gateway stay in sync. |
| `supervisor.image.pullPolicy` | Pull policy for the supervisor image. Defaults to the Kubernetes cluster default when unset. |
Loading