MCAD v2

This repository contains a reimplementation of MCAD (multi-cluster-app-dispatcher) using recent versions of controller runtime and kubebuilder.

This reimplementation does not support quotas or dispatching to multiple clusters yet.

See PORTING.md for instructions on how to port AppWrappers from MCAD to MCAD v2.

Getting Started

You’ll need a Kubernetes cluster to run against. You can use KIND to get a local cluster for testing, or run against a remote cluster. Note: Your controller will automatically use the current context in your kubeconfig file (i.e. whatever cluster kubectl cluster-info shows).

Running locally against cluster

Install the CRDs into the cluster:

make install

Run your controller (this will run in the foreground, so switch to a new terminal if you want to leave it running):

make run

NOTE: You can also run this in one step by running: make install run

Uninstall the CRDs:

make uninstall

Running on the cluster

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

make docker-build docker-push IMG=<image-name>:<image-tag>

Or build and push a multi-architecture image with:

make docker-buildx IMG=<image-name>:<image-tag>

Deploy the CRDs and controller to the cluster with the image specified by IMG:

make deploy IMG=<image-name>:<image-tag>

Undeploy the CRDs and controller from the cluster:

make undeploy

Modifying the API definitions

If you are editing the API definitions, generate the manifests such as CRs or CRDs using:

make manifests

NOTE: Run make --help for more information on all potential make targets

Helm Chart

Alternatively, MCAD can be installed on a cluster using Helm.

Install the CRDs and controller in the mcad-system namespace:

helm install --namespace mcad-system mcad-controller deployment/mcad-controller \
  --create-namespace \
  --set image.repository=<image-name> \
  --set image.tag=<image-tag> \
  --set resources.requests.cpu=100m \
  --set resources.requests.memory=512Mi \
  --set resources.limits.cpu=2000m \
  --set resources.limits.memory=4096Mi

Uninstall from mcad-system namespace:

helm uninstall mcad-controller -n mcad-system

Uninstall CRDs:

kubectl delete crd appwrappers.workload.codeflare.dev

Pre-commit hooks

This repository includes pre-configured pre-commit hooks. Make sure to install the hooks immediately after cloning the repository:

pre-commit install

See https://pre-commit.com for prerequisites.

Running tests locally

You can do make run-e2e to build MCAD and run the entire test suite against it on freshly created kind cluster in a fully automated fashion. For development purposes, other modes are also supported. See the detailed instructons in test/README.md for more details.

License

Licensed under the Apache License, Version 2.0 (the "License"); you may not use this file except in compliance with the License. You may obtain a copy of the License at

http://www.apache.org/licenses/LICENSE-2.0

Unless required by applicable law or agreed to in writing, software distributed under the License is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the License for the specific language governing permissions and limitations under the License.

project-codeflare / mcad

readme