notebooks/components/notebook-controller/config
apoger 939e1e22ca Introduce a mechanism to build all Kubeflow images (kubeflow/kubeflow#6555)
* build: Update components makefiles for building

We'll create a top-level Makefile under components/ dir
that has the following rules:

* build-all:
  To build all images locally

* push-all:
  * We can use a specific REGISTRY and retag the images
  * Push all the images

This top-level Makefile will run the sub-Makefiles that every
component has for building and pushing the images.

We modified every sub-Makefile as follows:
* We don't use a registry in images by default
* Removed unused rules and vars
* Use the --dirty flag of git describe in TAG

        --dirty[=<mark>]
               Describe the working tree. It means describe HEAD and
               appends <mark> (-dirty by default) if the working tree
               is dirty.

Signed-off-by: Apotolos Gerakaris <apoger@arrikto.com>

* build: Create makefiles for notebook servers

The common starting point of building the notebook-server
images are the following 4 *base* images:
- base
- codeserver
- jupyter
- rstudio

All other server images need to build on top of them. We'll
dynamically pass the base images in every Dockerfile by
using an ARG IMG. We can set the value of this ARG during
docker build with the --build-arg CLI argument.

This way we build both the base images with a tag locally,
and then we pass that image as arg via the Makefile and build the rest

So we modified our building procedure as follows:
1. Build the base image since everything starts from there

2. Pass the base image as an ARG in the Dockerfiles of
jupyter, codeserver, rstudio images and build on top

3. Pass the base images in all other server images and build
on top

For that we will:

1. Create a Makefile for each of the notebook servers, in each folder
   a. Each makefile will be responsible for building the bases and use args for passing them on

2. Use the central Makefile to call each Makefile from above

Signed-off-by: Apotolos Gerakaris <apoger@arrikto.com>

* cherry-pick: Notebook server upstream fixes

Relevant upstream PR: https://github.com/kubeflow/kubeflow/pull/6466/files

Signed-off-by: Apotolos Gerakaris <apoger@arrikto.com>

* build: Fix Makefiles

- Remove build-gcp and build-gcr rules as we don't use them anywhere in
the project
- Fix code conficts

Signed-off-by: Apotolos Gerakaris <apoger@arrikto.com>

* build: Fix Dockerfiles for notbook-server images

We remove the previous logic of using already built images as bases.
The users must use only the Makefiles to pass the appropriate BASE_IMG
and build the images correctly.

Thus, we have Makefiles everywhere that:

- Can build any base image
- If an image requires another notebook base, then we first build that one using its makefile,
  and then use it as docker ARG for building the next one

Signed-off-by: Apotolos Gerakaris <apoger@arrikto.com>

* build: Fix notebook-controller Makefile

Removed a misplaced "|" char that breaks the Makefile

Signed-off-by: Apotolos Gerakaris <apoger@arrikto.com>

* build: Update GH action workflows

* Update workflow for notebook-server images:
  - Add a step for building all images by using the
  central-Makefile under components/example-notebook-servers/ dir.
  - Add a step for pushing all images by using the
  central-Makefile under components/example-notebook-servers/ dir.

* Update workflow for all Kubeflow images:
  - Add a step for building & pushing all images by using the
  top-level Makefile under components/ dir.

Signed-off-by: Apotolos Gerakaris <apoger@arrikto.com>

* build: Remove completely ECR references from images

Replace everywhere the "public.ecr.aws/j1r0q0g6/notebooks/notebook-servers"
prefix with "kubeflownotebookswg"

Signed-off-by: Apotolos Gerakaris <apoger@arrikto.com>

* build: Fix GH actions for Kubeflow components

Fix GH actions to use the updated make rules
when building the Kubeflow component images.

Remove the "docker.io" prefix when building with
GH action workflows

Signed-off-by: Apotolos Gerakaris <apoger@arrikto.com>
2022-07-01 17:54:06 +00:00
..
base release: Images for the 1.5.0 tag (kubeflow/kubeflow#6398) 2022-03-09 22:37:11 +00:00
crd Support K8s 1.22 in notebook controller (kubeflow/kubeflow#6374) 2022-05-03 15:49:01 +00:00
default Support K8s 1.22 in notebook controller (kubeflow/kubeflow#6374) 2022-05-03 15:49:01 +00:00
manager Support K8s 1.22 in notebook controller (kubeflow/kubeflow#6374) 2022-05-03 15:49:01 +00:00
overlays Notebook Controller: Consolidate manifests (kubeflow/kubeflow#5723) 2021-03-19 10:22:16 -07:00
rbac notebooks: Allow notebook controller to patch events (kubeflow/kubeflow#6523) 2022-06-20 12:25:37 +00:00
samples Introduce a mechanism to build all Kubeflow images (kubeflow/kubeflow#6555) 2022-07-01 17:54:06 +00:00
README.md Notebook Controller: Consolidate manifests (kubeflow/kubeflow#5723) 2021-03-19 10:22:16 -07:00

README.md

Manifests

This folder contains manifests for installing notebook-controller. The structure is the following:

.
├── crd
├── default
├── manager
├── rbac
├── samples
├── base
├── overlays
│   ├── kubeflow
│   └── standalone

The breakdown is the following:

  • crd, default, manager, rbac, samples: Kubebuilder-generated structure. We keep this in order to be compatible with kubebuilder workflows. This is not meant for the consumer of the manifests.
  • base, overlays: Kustomizations meant for consumption by the user:
    • overlays/kubeflow: Installs notebook-controller as part of Kubeflow. The resulting manifests should be the same as the result of the deprecated base_v3 from kubeflow/manifests. At a glance, it makes the following changes:
      • Use namespace kubeflow.
      • Remove namespace resource.
      • Add KFAM container.
      • Add KFAM Service and VirtualService.
    • overlays/standalone: Install notebook-controller in its own namespace. Useful for testing or for users that prefer to install just the controller.

CRD Issue

We patch the kubebuilder-generated CRD with an older version. That's because the validation was more relaxed in a previous version and now we ended up with some clients and resources in a state that fails more detailed validation, but works correctly. For more information, see: https://github.com/kubeflow/kubeflow/issues/5722