Skip to content

overview.md

Latest commit

 

History

History
45 lines (35 loc) · 3.24 KB

overview.md

File metadata and controls

45 lines (35 loc) · 3.24 KB

Notebooks

Overview

  • Integrates Kubeflow Notebooks v2 workspace UI into ODH Dashboard via Module Federation.
  • Adds Workspace and WorkspaceKind management under the AI Hub area.
  • Upstream sources live in a git subtree under upstream/.

Design Intent

  • No ODH-authored BFF; federated remote name is notebooks.
  • Host proxy: Proxies /workspaces/api to the upstream API (path rewritten to /api).
  • ODH registration: Under upstream/workspaces/frontend/src/odh/ — extensions.ts for area/nav/route; NotebooksWrapper.tsx loads the federated shell.
  • Upstream vs ODH: Upstream repo includes its own Go backend for non-ODH deployments; in ODH federated mode, browser traffic to workspace APIs goes through the dashboard proxy to that API surface, not a separate dashboard BFF layer.
  • Dockerfile.workspace: Federated build depends on unpublished workspace packages (@odh-dashboard/plugin-core, @odh-dashboard/internal, dynamic plugin SDK) and needs monorepo context.
  • Development: Treat the host as source of truth for auth and navigation; the notebooks dev server is the federated asset origin only.

Key Concepts

Term Definition
NotebookImage Image registered as a WorkspaceKind defining a notebook environment.
NotebookServer Upstream name for the running workspace instance (Workspace CR lifecycle).
CustomNotebookEnvironment User-defined WorkspaceKind extending a base image.
Workspace Notebooks v2 CR (kind: Workspace) for a running notebook environment.
WorkspaceKind CR defining image and resource profile for Workspaces.
notebooks-plugin Area ID from this package’s extensions; gated by dev/feature flags.

Interactions

Dependency Type Details
Main ODH Dashboard Host Loads notebooks remote; shares plugin-core and internal packages.
Workbenches (frontend) Reliant area reliantAreas: ['workbenches'] — workbenches must be enabled; see Workbenches Docs.
Kubernetes API Workspace / WorkspaceKind CRs (upstream backend in non-ODH layouts).
upstream/workspaces/backend Upstream BFF Upstream’s Go server; ODH uses /workspaces/api proxy to reach its API shape.
JupyterHub External Only for some upstream deployment modes; not required for ODH federated dev.

Known Issues / Gotchas

  • Subtree updates: Refresh with npm run update-subtree; review upstream breaking changes to extensions or WorkspaceKind schema before merging — adjust src/odh/ as needed.
  • npm run start:dev:ext: Isolates upstream UI without the ODH host — use npm run start:dev + root npm run dev:frontend for real integration (same class of issue as start:dev:ext on the main app for other federated packages).
  • Docker: Build Dockerfile.workspace from repo root, not packages/notebooks/, or workspace deps are missing.
  • Visibility: Area uses a dev flag (Notebooks Plugin); production exposure depends on promoting to a proper feature flag in OdhDashboardConfig.
  • OdhDashboardConfig: reliantAreas: ['workbenches'] — core workbench area must be on for nav items.