armada-operator

armada-operator is a small go project to automate the installation (and eventually management) of a fully-functional Armada deployment to a Kubernetes cluster using the Kubernetes operator pattern.

Description

Armada is a multi-Kubernetes batch job scheduler. This operator aims to make Armada easy to deploy and, well, operate in a Kubernetes cluster.

Quickstart

Want to start hacking right away?

You’ll need a Kubernetes cluster to run the operator. You can use KIND to run a local cluster for testing, or you can 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).

Start a Development Cluster

This section assumes you have KIND installed.

If you do not have a Kubernetes cluster to test against, you can start one using the following command:

make create-dev-cluster

Install using Helm

First, add the gresearch public Helm registry:

helm repo add gresearch https://g-research.github.io/charts

After that, you can install the Armada Operator using Helm:

helm install armada-operator gresearch/armada-operator --namespace armada-system --create-namespace

Build & install from scratch

Run the following command to install all Armada external dependencies (Apache Pulsar, Redis, PostgreSQL, NGINX, Prometheus)

make dev-setup

Then:

make dev-install-controller

Which will:

• install each CRD supported by the armada-operator on the cluster
• create a pod inside the kind cluster running the armada-operator controllers

Note: You may need to wait for some services (like Pulsar) to finish coming up to proceed to the next step. Check the status of the cluster with $ kubectl get -n armada pods.

Finally:

kubectl apply -n armada -f $(REPO_ROOT)/dev/quickstart/armada-crds.yaml

Which will deploy samples of each CRD. Once every Armada service is deployed, you should have a fully functional install of Armada running.

To stop the development cluster:

make delete-dev-cluster

This will totally destroy your development Kind cluster.

Local development

Before running the Operator, we first need to install the CRDs by running the following command:

make install

To run the operator locally, you can use the following command:

make run

To uninstall the Operator CRDs, you can use the following command:

make uninstall

Contributing

Please feel free to contribute bug-reports or ideas for enhancements via GitHub's issue system.

Code contributions are also welcome. When submitting a pull-request please ensure it references a relevant issue as well as making sure all CI checks pass.

Testing

Please test contributions thoroughly before requesting reviews. At a minimum:

make test-unit
make test-integration
make lint

should all succeed without error.

Add and change appropriate unit and integration tests to ensure your changes are covered by automated tests and appear to be correct.

How it works

This project aims to follow the Kubernetes Operator pattern

It uses Controllers which provides a reconcile function responsible for synchronizing resources until the desired state is reached on the cluster

License

Copyright 2023.

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.