kubeflow
/
notebooks
mirror of https://github.com/kubeflow/notebooks.git
1
0
Fork 0
Code Issues Packages Projects Releases Wiki Activity
notebooks/workspaces/controller
History
aTheo 91484fee07
feat(ws): retry failed reconciles much less aggressively (#256) 
* feat:Notebooks 2.0 // retry reconciliation failures less aggressively

Signed-off-by: Adriana Theodorakopoulou <atheodorak@outlook.com>

* mathew: fixes 1

Signed-off-by: Mathew Wicks <5735406+thesuperzapper@users.noreply.github.com>

---------

Signed-off-by: Adriana Theodorakopoulou <atheodorak@outlook.com>
Signed-off-by: Mathew Wicks <5735406+thesuperzapper@users.noreply.github.com>
Co-authored-by: Mathew Wicks <5735406+thesuperzapper@users.noreply.github.com>
 		2025-04-15 23:12:23 +00:00
..
api/v1beta1 feat(ws): add `podTemplatePod` to Workspace status, for backend logs (#210) 2025-02-14 22:05:37 +00:00
cmd feat(ws): retry failed reconciles much less aggressively (#256) 2025-04-15 23:12:23 +00:00
config feat(ws): add `podTemplatePod` to Workspace status, for backend logs (#210) 2025-02-14 22:05:37 +00:00
hack feat(ws): initial commit for controller (#5) 2024-05-23 18:36:26 +00:00
internal feat(ws): retry failed reconciles much less aggressively (#256) 2025-04-15 23:12:23 +00:00
test test(ws): enhance e2e test setup and cleanup (#39) 2024-12-05 21:14:00 +00:00
.dockerignore feat(ws): initial commit for controller (#5) 2024-05-23 18:36:26 +00:00
.gitignore feat(ws): initial commit for controller (#5) 2024-05-23 18:36:26 +00:00
.golangci.yml chore: update go linting + update dependencies for controller (#137) 2024-12-02 16:56:58 +00:00
Dockerfile chore: update go linting + update dependencies for controller (#137) 2024-12-02 16:56:58 +00:00
Makefile test(ws): enhance e2e test setup and cleanup (#39) 2024-12-05 21:14:00 +00:00
PROJECT feat(ws): add validation webhooks for Workspace and WorkspaceKind (#34) 2024-08-29 00:14:03 +00:00
README.md feat(ws): initial commit for controller (#5) 2024-05-23 18:36:26 +00:00
go.mod chore: update go linting + update dependencies for controller (#137) 2024-12-02 16:56:58 +00:00
go.sum chore: update go linting + update dependencies for controller (#137) 2024-12-02 16:56:58 +00:00

README.md

Kubeflow Workspace Controller

The Kubeflow Workspace Controller is responsible for reconciling the Workspace and WorkspaceKind resources used in Kubeflow Notebooks 2.0.

⚠️ Warning ⚠️

The Kubeflow Workspace Controller is a work in progress and is NOT currently ready for use. We greatly appreciate any contributions.

Getting Started

Prerequisites

  • go version v1.21.0+
  • docker version 17.03+.
  • kubectl version v1.11.3+.
  • Access to a Kubernetes v1.11.3+ cluster.

To Deploy on the cluster

Build and push your image to the location specified by IMG:

make docker-build docker-push IMG=<some-registry>/workspace-controller:tag

NOTE: This image ought to be published in the personal registry you specified. And it is required to have access to pull the image from the working environment. Make sure you have the proper permission to the registry if the above commands don’t work.

Install the CRDs into the cluster:

make install

Deploy the Manager to the cluster with the image specified by IMG:

make deploy IMG=<some-registry>/workspace-controller:tag

NOTE: If you encounter RBAC errors, you may need to grant yourself cluster-admin privileges or be logged in as admin.

Create instances of your solution You can apply the samples (examples) from the config/sample:

kubectl apply -k config/samples/

NOTE: Ensure that the samples has default values to test it out.

To Uninstall

Delete the instances (CRs) from the cluster:

kubectl delete -k config/samples/

Delete the APIs(CRDs) from the cluster:

make uninstall

UnDeploy the controller from the cluster:

make undeploy

Project Distribution

Following are the steps to build the installer and distribute this project to users.

  1. Build the installer for the image built and published in the registry:
make build-installer IMG=<some-registry>/workspace-controller:tag

NOTE: The makefile target mentioned above generates an 'install.yaml' file in the dist directory. This file contains all the resources built with Kustomize, which are necessary to install this project without its dependencies.

  1. Using the installer

Users can just run kubectl apply -f to install the project, i.e.:

kubectl apply -f https://raw.githubusercontent.com/<org>/workspace-controller/<tag or branch>/dist/install.yaml