notebooks: document Workspaces concepts and architecture - #4474
notebooks: document Workspaces concepts and architecture#4474HarshPopat23 wants to merge 1 commit into
Conversation
|
[APPROVALNOTIFIER] This PR is NOT APPROVED This pull-request has been approved by: The full list of commands accepted by this bot can be found here. DetailsNeeds approval from an approver in each of these files:Approvers can indicate their approval by writing |
|
Hi @HarshPopat23. Thanks for your PR. I'm waiting for a kubeflow member to verify that this patch is reasonable to test. If it is, they should reply with Once the patch is verified, the new status will be reflected by the I understand the commands that are listed here. DetailsInstructions for interacting with me using PR comments are available here. If you have questions or suggestions related to my behavior, please file an issue against the kubernetes/test-infra repository. |
|
🚫 This command cannot be processed. Only organization members or owners can use the commands. |
|
cc : @christian-heusel |
b070ffd to
30d41aa
Compare
Please only explicitly tag me when you didn't get a response in a reasonable timeframe! 🤗 |
christian-heusel
left a comment
christian-heusel
left a comment
There was a problem hiding this comment.
Hey @HarshPopat23, thanks for striving to make the Kubeflow Workspaces documentation better! 🚀
I gave your changeset a brief review, however I'm a bit unsure whether any of these changes are actually an improvement over the previous version 🤔
HarshPopat23
changed the title
Signed-off-by: HarshPopat23 <musichk61@gmail.com>
30d41aa to
74a065d
Compare
| ### 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`. | |
There was a problem hiding this comment.
I don't think this should be explained on this page, we plan to have a separate (far more detailed) page for the architecture 🤔
There was a problem hiding this comment.
ohk so should i make detailed page and connect lik on this page or will look letter after this pr?
| - **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 |
There was a problem hiding this comment.
Why are these needed/sensible changes? 🤔
There was a problem hiding this comment.
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.
3 participants
Description of Changes
Summary
WorkspaceKindandWorkspace, as well as component responsibilities (Frontend,Backend, andController).Why
Maintainer feedback on #4474 indicated that subjective wording changes alone did not clearly improve the overview. Adding a foundational architecture summary addresses a concrete documentation gap by clarifying how cluster-scoped configuration (
WorkspaceKind), user workloads (Workspace), and runtime controllers interact, while retaining upstream phrasing and resolving typographical issues.Technical sources
Verified against the
notebooks-v2branch ofkubeflow/notebooks:workspaces/controller/api/v1beta1/workspacekind_types.go:WorkspaceKindcluster scope, spawner config, pod templates, activity and filter rules.workspaces/controller/api/v1beta1/workspace_types.go:Workspacenamespace scope, kind reference, user configuration.workspaces/frontend/README.md: Web UI responsibilities.workspaces/backend/README.md: Backend-for-frontend (BFF) service role.workspaces/controller/README.md: Reconciliation of custom resources.workspaces/controller/internal/controller/workspace_controller.go: Ownership and reconciliation ofStatefulSet,Service,ServiceAccount,RoleBindings, and conditional IstioVirtualService.Verification
git diff --check(no whitespace errors).python scripts/validate-urls.py -d content/en/docs/components/workspaces(all links inoverview.mdreturn 200).content/en/docs/components/workspaces/overview.md.Related documentation epic: kubeflow/notebooks#701