multi-cluster-app-dispatcher

README

Multi-Cluster App Dispatcher

The multi-cluster-app-dispatcher is a Kubernetes controller providing mechanisms for applications to manage batch jobs in a single or multi-cluster environment.

The multi-cluster-app-dispatcher (MCAD) controller is capable of (i) providing an abstraction for wrapping all resources of the job/application and treating them holistically, (ii) queuing job/application creation requests and applying different queuing policies, e.g., First In First Out, Priority, (iii) dispatching the job to one of multiple clusters, where a MCAD queuing agent runs, using configurable dispatch policies, and (iv) auto-scaling pod sets, balancing job demands and cluster availability (future work).

Build Information

Follow the build instructions here to build the Multi-Cluster-App-Dispatcher controller.

Deployment Information

Refer to deployment instructions here on how to deploy the multi-cluster-app-dispatcher as a controller in Kubernetes.

Alternatively, for a quick deployment, you can use the easy-deploy make target to build, push, and deploy your custom image of MCAD on your Kubernetes cluster:

make easy-deploy TAG=<image tag> USERNAME=<quay.io username>

Note: Ensure you are logged into your quay.io account on your local machine, and your kubeconfig is pointing to the cluster you want to deploy MCAD on.

Release Process

1. Run the mcad-release.yml action under Actions by entering the new release version in the Release tag input field and click Run workflow.

2. Verify that mcad-release.yml action passed successfully. The workflow will Build and push the image to mcad-controller quay repository with specified release version tag and create GitHub release tag.

3. Verify a new release is created on the Releases page.

4. The latest release changes should also reflect in the mcad go package module.

Tutorial

Refer to the tutorial on how to use multi-cluster-app-dispatcher to run batch job in Kubernetes

Overall Architecture