Skip to content

cwiklik/micro-mcad

 
 

Repository files navigation

MicroMCAD

This code is a quick prototype exploring what an implementation of MCAD (multi-cluster-app-dispatcher) could look like if utilizing the latest controller runtime and kubebuilder. This prototype focuses on MCAD core capabilities (queuing and dispatching logic, resource management, priorities and preemption, error handling and requeuing) but does not implement advanced capabilities such multi-cluster management and quotas.

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=<some-registry>/mcad:<some-tag>

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

make deploy IMG=<some-registry>/mcad:<some-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

License

Copyright 2023 IBM Corporation.

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

https://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.

Releases

No releases published

Packages

No packages published

Languages

  • Go 82.7%
  • Makefile 14.8%
  • Dockerfile 2.5%