From 74a065da890df6fce0b01cf1f063acf5225fbea9 Mon Sep 17 00:00:00 2001 From: HarshPopat23 Date: Fri, 28 Aug 2026 23:16:14 +0530 Subject: [PATCH] notebooks: document Workspaces concepts and architecture Signed-off-by: HarshPopat23 --- .../en/docs/components/workspaces/overview.md | 25 +++++++++++++++---- 1 file changed, 20 insertions(+), 5 deletions(-) diff --git a/content/en/docs/components/workspaces/overview.md b/content/en/docs/components/workspaces/overview.md index 8656b70573..b7329fe97e 100644 --- a/content/en/docs/components/workspaces/overview.md +++ b/content/en/docs/components/workspaces/overview.md @@ -4,11 +4,11 @@ description: An overview of Kubeflow Workspaces weight: 10 --- -## What does Kubeflow Workspace offer? +## What do Kubeflow Workspaces offer? Kubeflow Workspaces provides on-demand, containerized development environments that run directly on your Kubernetes cluster. This bridges the gap to give data scientists, machine learning engineers -and agents a convenient access to the infrastructure in your Kubernetes cluster to code, explore +and agents convenient access to the infrastructure in your Kubernetes cluster to code, explore data, and run experiments, while platform administrators keep full control over the images, hardware resources, and security that back those environments. @@ -21,15 +21,30 @@ replacing the original Notebooks controller with a more flexible and extensible - **Interactive development environments on Kubernetes**: run your IDE next to your data and powerful compute instead of locally on your workstation. -- **Support for any web-based IDE**, with first-class examples for popular examples such as +- **Support for any web-based IDE**, with first-class examples for popular IDEs such as [JupyterLab](https://github.com/jupyterlab/jupyterlab), [Visual Studio Code (code-server)](https://github.com/coder/code-server), and [RStudio](https://github.com/rstudio/rstudio). -- **Persona-based design** Cluster admins curate the available environments through the +- **Persona-based design**: Cluster admins curate the available environments through the `WorkspaceKind` custom resource, including base images, default resources, and pod-level - configuration, so endusers can create `Workspace` resources in a guided wizard without having to + configuration, so end users can create `Workspace` resources in a guided wizard without having to understand the underlying Kubernetes resources. +## Core concepts and architecture + +### Custom resources + +- **`WorkspaceKind`**: Cluster-scoped resource curated by platform administrators. It defines the Workspace template, image and pod configuration choices, and administrative policies. +- **`Workspace`**: Namespace-scoped resource representing an individual user development environment. It references a `WorkspaceKind` and records the user-selected configuration. + +### Component responsibilities + +| Component | Responsibility | +| --- | --- | +| **Frontend** | User interface for creating, monitoring, and managing Workspaces. | +| **Backend** | Backend-for-frontend API used by the UI. | +| **Controller** | Reconciles `Workspace` and `WorkspaceKind` resources and manages the runtime Kubernetes resources. The controller currently owns a `StatefulSet`, `Service`, `ServiceAccount`, `RoleBindings`, and optionally an Istio `VirtualService`. | + ## Get Started Ready to try Kubeflow Workspaces? Follow the