Hades

This project is a Kubernetes Operator designed to automate the creation of jobs until a successful one is achieved. In the event of a job failure, this operator initiates the generation of new jobs at regular intervals until a successful job is obtained. This operator is activated following the identification of a job failure by Kubernetes.

How it works?

This system includes a monitoring mechanism that oversees jobs within a specific namespace. Upon detecting a failed job, it creates a new Sole object. Subsequently, an agent routinely retrieves these entries from the operator-loop and generates Jobs until a successful job is achieved.

Why Hades?

Hades is a prominent figure in Greek mythology, known as the ruler of the underworld and the god of the dead. He is one of the three major Olympian gods, alongside his brothers Zeus and Poseidon. Hades is often depicted as stern and unyielding, residing in his realm of the dead where souls go after death. He is typically portrayed as a somber figure, holding a scepter or key that symbolizes his control over the underworld. Despite his ominous role, Hades is not considered inherently evil; rather, he maintains order and balance in the realm of the dead.

The operator functions akin to the mythical figure of Hades. In a similar fashion, this operator is responsible for managing failed cronjobs, which can be likened to souls in the underworld. Just as Hades maintains order and control over the deceased, this operator ensures that failed cronjobs are appropriately handled and managed within the system. It embodies a sense of authority and regulation, akin to the role played by Hades in Greek mythology.

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 on the cluster

Install Instances of Custom Resources:

kubectl apply -f config/samples/

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

make docker-build docker-push IMG=<some-registry>/operator:tag

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

make deploy IMG=<some-registry>/operator:tag

Uninstall CRDs

To delete the CRDs from the cluster:

make uninstall

Undeploy controller

UnDeploy the controller to the cluster:

make undeploy

How it works

This project aims to follow the Kubernetes Operator pattern

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

Test It Out

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

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

More information can be found via the Kubebuilder Documentation

Contribute

If you find a suitable issue, express your interest in working on it and proceed to fork the project's repository to your GitHub account. From there, create a new branch to make your changes, ensuring they adhere to the project's coding style and guidelines. Thoroughly test your modifications to confirm they work as intended before committing and pushing them to your forked repository. Finally, submit a detailed pull request to the original project's repository, including an explanation of your changes and their benefits. Engage in constructive discussions with project maintainers and other contributors, respecting their guidelines and feedback throughout the process.

amirhnajafiz/hades