e1b1b05b6d
This commit adds a GHA workflow to support publishing a container image for the `workspaces/controller` component as well as some updates to the `Makefile` to establish reasonable (but overridable) defaults.
Key behavior:
- Publishes controller images on any workspaces/ directory change
- Builds images with commit SHA tags by default
- "release" images with use the tag as defined by the `VERSION` file
- a `-dirty` suffix is added to the tag if the codebase is not `porcelain`
- no `latest` tag is ever produced on images
- Uses `ghcr.io/kubeflow/notebooks` registry with configurable naming
example image name from "random" commit:
- `ghcr.io/kubeflow/notebooks/workspaces-controller:sha-3fa851ab3173942dbaa1a609468e7f9eadf5f4e4`
example image name from release:
- `ghcr.io/kubeflow/notebooks/workspaces-controller:v2.0.0`
Signed-off-by: Andy Stoneberg <astonebe@redhat.com>
|
||
|---|---|---|
| .. | ||
| api/v1beta1 | ||
| cmd | ||
| config | ||
| hack | ||
| internal | ||
| test | ||
| .dockerignore | ||
| .gitignore | ||
| .golangci.yml | ||
| Dockerfile | ||
| Makefile | ||
| OWNERS | ||
| PROJECT | ||
| README.md | ||
| go.mod | ||
| go.sum | ||
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>/workspaces-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>/workspaces-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.
- Build the installer for the image built and published in the registry:
make build-installer IMG=<some-registry>/workspaces-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.
- Using the installer
Users can just run kubectl apply -f to install the project, i.e.:
kubectl apply -f https://raw.githubusercontent.com/<org>/workspaces-controller/<tag or branch>/dist/install.yaml