Skip to content
Merged
Show file tree
Hide file tree
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
14 changes: 8 additions & 6 deletions .github/workflows/ci.yml
Original file line number Diff line number Diff line change
Expand Up @@ -33,7 +33,7 @@ jobs:
- name: Render and lint all chart overlays
run: make helm-lint
- name: Package chart
run: helm package deploy/helm/openshell-dashboard --version 0.0.0-dev --app-version sha-test --destination "$RUNNER_TEMP"
run: helm package deploy/helm/console --version 0.0.0-dev --app-version sha-test --destination "$RUNNER_TEMP"
- name: Helm unit tests
run: |
helm plugin install https://github.com/helm-unittest/helm-unittest --version v1.0.3
Expand All @@ -42,7 +42,7 @@ jobs:
- name: Generated chart README is current
run: |
make helm-docs
git diff --exit-code -- deploy/helm/openshell-dashboard/README.md
git diff --exit-code -- deploy/helm/console/README.md

# On a pull request the two check-* jobs do their work only when their half
# of the tree changed. On a push, to main or to a release branch, they always
Expand Down Expand Up @@ -322,7 +322,9 @@ jobs:
# the job's GitHub OIDC token for a one-hour token of the robot ai-openshell+console_release,
# which can write quay.io/ai-openshell/console and its chart and nothing
# else. Quay hands that token out only to the exact subject
# repo:ai-openshell/console:environment:release, and the environment admits
# repo:ai-openshell@311201172/console@1316331667:environment:release (the
# repository uses GitHub's immutable subjects, which carry the owner's and
# the repository's IDs; see docs/releasing.md), and the environment admits
# main and release/** only, so a pull request cannot get it even if it edits
# this file: its subject is ...:pull_request, which no robot trusts. A pull
# request gets no image.
Expand Down Expand Up @@ -566,10 +568,10 @@ jobs:
if: steps.tip.outputs.is_tip == 'true'
run: |
set -euo pipefail
helm package deploy/helm/openshell-dashboard --version 0.0.0-dev \
helm package deploy/helm/console --version 0.0.0-dev \
--app-version "sha-${GITHUB_SHA::7}" --destination "$RUNNER_TEMP"
helm push "$RUNNER_TEMP/openshell-dashboard-0.0.0-dev.tgz" \
"oci://quay.io/${GITHUB_REPOSITORY,,}/helm-chart"
helm push "$RUNNER_TEMP/console-0.0.0-dev.tgz" \
"oci://quay.io/ai-openshell/charts"

# The release pipeline (publish.yml, scripts/release/) runs for real only on
# main and on release branches, after a merge. This job is where a mistake in
Expand Down
8 changes: 4 additions & 4 deletions .github/workflows/publish.yml
Original file line number Diff line number Diff line change
Expand Up @@ -225,8 +225,8 @@ jobs:
VERSION: ${{ needs.publish.outputs.version }}
run: |
set -euo pipefail
registry="oci://quay.io/${GITHUB_REPOSITORY,,}/helm-chart"
ref="$registry/openshell-dashboard"
registry="oci://quay.io/ai-openshell/charts"
ref="$registry/console"
if helm show chart "$ref" --version "$VERSION" > "$RUNNER_TEMP/chart-lookup.log" 2>&1; then
echo "Chart $ref:$VERSION already exists; leaving immutable version untouched."
exit 0
Expand All @@ -235,6 +235,6 @@ jobs:
cat "$RUNNER_TEMP/chart-lookup.log"
exit 1
fi
helm package deploy/helm/openshell-dashboard --version "$VERSION" \
helm package deploy/helm/console --version "$VERSION" \
--app-version "$VERSION" --destination "$RUNNER_TEMP"
helm push "$RUNNER_TEMP/openshell-dashboard-${VERSION}.tgz" "$registry"
helm push "$RUNNER_TEMP/console-${VERSION}.tgz" "$registry"
2 changes: 1 addition & 1 deletion AGENTS.md
Original file line number Diff line number Diff line change
Expand Up @@ -22,7 +22,7 @@ backend/ Go BFF; the compat suite is in test/compat/ (make compat, ne
pkg/clients/ Bearer forwarding (auth.go) and the direct gRPC calls (raw*.go)
pkg/models/ Response DTOs (From*() converters) and request builders
scripts/ Release and CI tooling (gateway-range.mjs, release/, retag-image.sh) and dev-env.sh (the local stack)
deploy/ Dockerfile, Helm chart (helm/openshell-dashboard), Keycloak realm (keycloak/), local stack (dev/), compat stack and gateway pins (ci/)
deploy/ Dockerfile, Helm chart (helm/console), Keycloak realm (keycloak/), local stack (dev/), compat stack and gateway pins (ci/)
docs/ Guides (install, authentication, configuration, compatibility, development, architecture, releasing) and ADRs (adrs/)
```

Expand Down
6 changes: 3 additions & 3 deletions Makefile
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
IMAGE_NAME ?= openshell-dashboard
IMAGE_NAME ?= console
TAG ?= latest
PLATFORMS ?= linux/amd64,linux/arm64

Expand Down Expand Up @@ -65,7 +65,7 @@ dev-reset: ## Stop it and delete its data and its sandboxes' containers
scripts/dev-env.sh reset

build: ## Build the container image (BFF + static frontend)
docker build -t openshell-dashboard:latest -f deploy/Dockerfile .
docker build -t console:latest -f deploy/Dockerfile .

buildx:
docker buildx build \
Expand Down Expand Up @@ -128,7 +128,7 @@ helm-lint: ## Lint and render Helm charts and their example values
[ -f "$$chart_file" ] || continue; \
chart=$${chart_file%/Chart.yaml}; \
set --; \
if [ "$$chart" = deploy/helm/openshell-dashboard ]; then \
if [ "$$chart" = deploy/helm/console ]; then \
set -- --set-string oidc.issuer=https://idp.example.com/realms/openshell; \
fi; \
helm lint "$$chart" "$$@"; \
Expand Down
10 changes: 5 additions & 5 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -22,8 +22,8 @@ The dashboard is installed with its Helm chart, in the namespace of the gateway
Create the Secret the auth proxy reads:

```sh
kubectl -n openshell create secret generic openshell-dashboard-oidc \
--from-literal=client-secret='<client secret of the openshell-dashboard client>' \
kubectl -n openshell create secret generic console-oidc \
--from-literal=client-secret='<client secret of the console client>' \
--from-literal=cookie-secret="$(openssl rand -hex 16)"
```

Expand Down Expand Up @@ -55,8 +55,8 @@ networkPolicy:
Install the chart:

```sh
helm upgrade --install openshell-dashboard \
oci://quay.io/ai-openshell/console/helm-chart/openshell-dashboard \
helm upgrade --install console \
oci://quay.io/ai-openshell/charts/console \
--version <dashboard version> --namespace openshell -f values.yaml
```

Expand Down Expand Up @@ -106,7 +106,7 @@ gateway does not return a total count.
- [Architecture](docs/architecture.md): components, principles, roles
- [Releasing](docs/releasing.md): how a release is cut and numbered
- [Decision records](docs/adrs/README.md)
- [Helm chart](deploy/helm/openshell-dashboard/README.md): every chart value
- [Helm chart](deploy/helm/console/README.md): every chart value

## Development

Expand Down
2 changes: 1 addition & 1 deletion SECURITY.md
Original file line number Diff line number Diff line change
Expand Up @@ -21,7 +21,7 @@ This policy covers the OpenShell Dashboard codebase:
- **React frontend** (`frontend/`) — UI components and API hooks
- **Container image** — Dockerfile, build pipeline
- **CI/CD** — GitHub Actions workflows
- **Helm chart and example files** (`deploy/helm/openshell-dashboard`, `deploy/keycloak`) — the chart is what keeps the auth proxy the only path to the BFF
- **Helm chart and example files** (`deploy/helm/console`, `deploy/keycloak`) — the chart is what keeps the auth proxy the only path to the BFF

For vulnerabilities in the OpenShell gateway itself, report to the [NVIDIA OpenShell project](https://github.com/NVIDIA/OpenShell) via NVIDIA PSIRT.

Expand Down
2 changes: 1 addition & 1 deletion backend/cmd/server/main.go
Original file line number Diff line number Diff line change
Expand Up @@ -113,7 +113,7 @@ func main() {
app.SetProviderProfiles(clients.raw)

addr := net.JoinHostPort(*listenAddress, *port)
slog.Info("openshell-dashboard BFF listening",
slog.Info("console BFF listening",
"addr", addr,
"scheme", inboundScheme(*tlsCert, *tlsKey),
"gateway", *gatewayURL,
Expand Down
4 changes: 2 additions & 2 deletions deploy/Dockerfile
Original file line number Diff line number Diff line change
Expand Up @@ -30,7 +30,7 @@ RUN CGO_ENABLED=0 go build -o /out/server ./cmd/server
FROM alpine:3.20
RUN adduser -D -u 1001 dashboard
USER 1001
COPY --from=backend /out/server /usr/local/bin/openshell-dashboard
COPY --from=backend /out/server /usr/local/bin/console
COPY --from=frontend /app/frontend/dist /srv/static
ENV PORT=8080 \
STATIC_DIR=/srv/static
Expand Down Expand Up @@ -61,4 +61,4 @@ ARG OPENSHELL_SDK_VERSION=""
LABEL io.github.ai-openshell.console.gateway.line="${GATEWAY_RELEASE_LINE}" \
io.github.ai-openshell.console.sdk="${OPENSHELL_SDK_VERSION}"

ENTRYPOINT ["/usr/local/bin/openshell-dashboard"]
ENTRYPOINT ["/usr/local/bin/console"]
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
# SPDX-FileCopyrightText: Copyright (c) 2026 OpenShell Dashboard contributors
# SPDX-License-Identifier: Apache-2.0
apiVersion: v2
name: openshell-dashboard
name: console
description: OIDC-protected web dashboard for an OpenShell gateway
type: application
version: 0.0.0
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -15,8 +15,8 @@ Deploys one stateless dashboard Deployment alongside an [OpenShell gateway](http
- A Secret with that client's secret and a cookie secret. The chart does not create it:

```sh
kubectl -n openshell create secret generic openshell-dashboard-oidc \
--from-literal=client-secret='<client secret of the openshell-dashboard client>' \
kubectl -n openshell create secret generic console-oidc \
--from-literal=client-secret='<client secret of the console client>' \
--from-literal=cookie-secret="$(openssl rand -hex 16)"
```

Expand Down Expand Up @@ -48,8 +48,8 @@ networkPolicy:
Install the published chart:

```sh
helm upgrade --install openshell-dashboard \
oci://quay.io/ai-openshell/console/helm-chart/openshell-dashboard \
helm upgrade --install console \
oci://quay.io/ai-openshell/charts/console \
--version <dashboard version> --namespace openshell -f values.yaml
```

Expand All @@ -63,14 +63,14 @@ These files are in the repository, not in the packaged chart. CI renders each on

| File | When it applies |
|---|---|
| [`values-keycloak.yaml`](https://github.com/ai-openshell/console/blob/main/deploy/helm/openshell-dashboard/ci/values-keycloak.yaml) | Keycloak as the identity provider: the role gate, PKCE, and a sign-out that ends the Keycloak session |
| [`values-gateway-api.yaml`](https://github.com/ai-openshell/console/blob/main/deploy/helm/openshell-dashboard/ci/values-gateway-api.yaml) | An HTTPRoute attached to an existing Gateway |
| [`values-port-forward.yaml`](https://github.com/ai-openshell/console/blob/main/deploy/helm/openshell-dashboard/ci/values-port-forward.yaml) | A trial through `kubectl port-forward`, without an ingress |
| [`values-route-edge.yaml`](https://github.com/ai-openshell/console/blob/main/deploy/helm/openshell-dashboard/ci/values-route-edge.yaml) | An OpenShift Route that terminates TLS at the router |
| [`values-route-reencrypt.yaml`](https://github.com/ai-openshell/console/blob/main/deploy/helm/openshell-dashboard/ci/values-route-reencrypt.yaml) | An OpenShift Route with reencrypt, where oauth2-proxy serves HTTPS |
| [`values-openshift-scc.yaml`](https://github.com/ai-openshell/console/blob/main/deploy/helm/openshell-dashboard/ci/values-openshift-scc.yaml) | OpenShift's `restricted-v2` SCC, which assigns the user and group |
| [`values-mtls-client-cert.yaml`](https://github.com/ai-openshell/console/blob/main/deploy/helm/openshell-dashboard/ci/values-mtls-client-cert.yaml) | A gateway that requires a client certificate and has no OIDC |
| [`values-tls-disabled.yaml`](https://github.com/ai-openshell/console/blob/main/deploy/helm/openshell-dashboard/ci/values-tls-disabled.yaml) | A gateway that runs without TLS, on a trusted network |
| [`values-keycloak.yaml`](https://github.com/ai-openshell/console/blob/main/deploy/helm/console/ci/values-keycloak.yaml) | Keycloak as the identity provider: the role gate, PKCE, and a sign-out that ends the Keycloak session |
| [`values-gateway-api.yaml`](https://github.com/ai-openshell/console/blob/main/deploy/helm/console/ci/values-gateway-api.yaml) | An HTTPRoute attached to an existing Gateway |
| [`values-port-forward.yaml`](https://github.com/ai-openshell/console/blob/main/deploy/helm/console/ci/values-port-forward.yaml) | A trial through `kubectl port-forward`, without an ingress |
| [`values-route-edge.yaml`](https://github.com/ai-openshell/console/blob/main/deploy/helm/console/ci/values-route-edge.yaml) | An OpenShift Route that terminates TLS at the router |
| [`values-route-reencrypt.yaml`](https://github.com/ai-openshell/console/blob/main/deploy/helm/console/ci/values-route-reencrypt.yaml) | An OpenShift Route with reencrypt, where oauth2-proxy serves HTTPS |
| [`values-openshift-scc.yaml`](https://github.com/ai-openshell/console/blob/main/deploy/helm/console/ci/values-openshift-scc.yaml) | OpenShift's `restricted-v2` SCC, which assigns the user and group |
| [`values-mtls-client-cert.yaml`](https://github.com/ai-openshell/console/blob/main/deploy/helm/console/ci/values-mtls-client-cert.yaml) | A gateway that requires a client certificate and has no OIDC |
| [`values-tls-disabled.yaml`](https://github.com/ai-openshell/console/blob/main/deploy/helm/console/ci/values-tls-disabled.yaml) | A gateway that runs without TLS, on a trusted network |

## Configuration notes

Expand Down Expand Up @@ -153,7 +153,7 @@ These files are in the repository, not in the packaged chart. CI renders each on
| httpRoute.gateway.sectionName | string | `""` | Listener name when attaching to an existing Gateway. Set it to the HTTPS listener: without it the route attaches to every listener that admits it. For a Gateway this chart creates, the chart sets it. |
| httpRoute.hostnames | list | `[]` | Public hostnames; first hostname supplies callback URL if redirectURL is empty. |
| imagePullSecrets | list | `[]` | Image pull secrets for the dashboard pod. |
| nameOverride | string | `"openshell-dashboard"` | Resource name override; pod identity label remains openshell-dashboard. |
| nameOverride | string | `"console"` | Resource name override; the pod's app.kubernetes.io/name label stays console. |
| networkPolicy.enabled | bool | `true` | Restrict ingress to the proxy port from the ingress controller namespace. |
| networkPolicy.ingressFrom | list | `[]` | Optional ingress peers replacing the default namespace selector (e.g. host-network routers or Gateway data-plane pods). |
| networkPolicy.ingressNamespace | string | `""` | Namespace of ingress data-plane pods. Defaults to openshift-ingress for Routes; required for HTTPRoute unless ingressFrom is set. |
Expand All @@ -164,10 +164,10 @@ These files are in the repository, not in the packaged chart. CI renders each on
| oidc.audience | string | `"openshell-api"` | Expected audience claim for the API resource server. IdP must add it to token aud. Purely informational: the chart only prints it in the post-install notes. |
| oidc.backendLogoutURL | string | `"auto"` | IdP logout URL oauth2-proxy calls from the pod when a user signs out (HTTP GET), so the IdP session ends too; {id_token} is replaced with the session ID token. `auto` derives it from the issuer for provider keycloak-oidc (`<issuer>/protocol/openid-connect/logout?id_token_hint={id_token}`) and sets none for other providers. Empty disables backend logout. Separate from dashboard.logoutURL. |
| oidc.caConfigMapName | string | `""` | ConfigMap with ca.crt to trust private issuer TLS (also set on gateway). |
| oidc.clientId | string | `"openshell-dashboard"` | OAuth2-proxy OIDC client ID. |
| oidc.clientId | string | `"console"` | OAuth2-proxy OIDC client ID. |
| oidc.clientIdSecretKey | string | `""` | Optional key in oidc.existingSecret holding client ID; when set, takes precedence over oidc.clientId. |
| oidc.codeChallengeMethod | string | `""` | PKCE challenge method (e.g. S256); empty disables PKCE for providers that do not support it. |
| oidc.existingSecret | string | `"openshell-dashboard-oidc"` | Existing Secret containing keys client-secret and cookie-secret. |
| oidc.existingSecret | string | `"console-oidc"` | Existing Secret containing keys client-secret and cookie-secret. |
| oidc.issuer | string | `""` | OIDC issuer URL (e.g. https://keycloak.example.com/realms/openshell) |
| oidc.provider | string | `"oidc"` | oauth2-proxy provider (oidc for generic OIDC, keycloak-oidc for Keycloak role filtering). |
| oidc.redirectURL | string | `""` | Full public callback URL; required when host is dynamically allocated. Empty derives from Route/HTTPRoute host. |
Expand All @@ -183,13 +183,13 @@ These files are in the repository, not in the packaged chart. CI renders each on
| podLabels | object | `{}` | Extra pod labels; cannot override identity/instance selector labels. |
| podLifecycle.terminationGracePeriodSeconds | int | `30` | Pod termination grace period in seconds. |
| podSecurityContext.fsGroup | int | `1000` | fsGroup of the pod; on OpenShift set podSecurityContext to null. |
| probes.liveness.dashboardCommand | list | `["/usr/local/bin/openshell-dashboard","--healthcheck"]` | Dashboard exec command for liveness. |
| probes.liveness.dashboardCommand | list | `["/usr/local/bin/console","--healthcheck"]` | Dashboard exec command for liveness. |
| probes.liveness.failureThreshold | int | `3` | Liveness probe failure threshold. |
| probes.liveness.periodSeconds | int | `10` | Liveness probe period in seconds. |
| probes.readiness.dashboardCommand | list | `["/usr/local/bin/openshell-dashboard","--healthcheck"]` | Dashboard exec command for readiness. |
| probes.readiness.dashboardCommand | list | `["/usr/local/bin/console","--healthcheck"]` | Dashboard exec command for readiness. |
| probes.readiness.failureThreshold | int | `3` | Readiness probe failure threshold. |
| probes.readiness.periodSeconds | int | `5` | Readiness probe period in seconds. |
| probes.startup.dashboardCommand | list | `["/usr/local/bin/openshell-dashboard","--healthcheck"]` | Dashboard exec command; the default calls the BFF's loopback self-check. |
| probes.startup.dashboardCommand | list | `["/usr/local/bin/console","--healthcheck"]` | Dashboard exec command; the default calls the BFF's loopback self-check. |
| probes.startup.failureThreshold | int | `30` | Startup probe failure threshold (dashboard and proxy). |
| probes.startup.periodSeconds | int | `2` | Startup probe period in seconds. |
| replicaCount | int | `1` | Number of stateless dashboard pods (ignored when autoscaling is enabled). |
Expand Down
Loading
Loading