Skip to content

notebooks: document Workspaces concepts and architecture #4474

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
HarshPopat23 wants to merge 1 commit into
base: master
Choose a base branch
from
Open

notebooks: document Workspaces concepts and architecture #4474

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
25 changes: 20 additions & 5 deletions content/en/docs/components/workspaces/overview.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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.

Expand All @@ -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
Comment on lines -24 to +28

@christian-heusel christian-heusel Sep 1, 2026

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Why are these needed/sensible changes? 🤔

@HarshPopat23 HarshPopat23 Sep 1, 2026

Copy link
Copy Markdown
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Ya but i am just reading the docs and try to connect with the other docs which i have read erlier...
and feel like i should do that..
no worries i will remove it.

`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`. |
Comment on lines +40 to +46

@christian-heusel christian-heusel Sep 1, 2026

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I don't think this should be explained on this page, we plan to have a separate (far more detailed) page for the architecture 🤔

@HarshPopat23 HarshPopat23 Sep 1, 2026

Copy link
Copy Markdown
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

ohk so should i make detailed page and connect lik on this page or will look letter after this pr?


## Get Started

Ready to try Kubeflow Workspaces? Follow the
Expand Down