jamadar

command module

v0.0.15 Latest Latest Go to latest Published: Jun 11, 2019 License: Apache-2.0 Imports: 2 Imported by: 0

Details

Valid go.mod file

The Go module system was introduced in Go 1.11 and is the official dependency management solution for Go.
Redistributable license

Redistributable licenses place minimal restrictions on how software can be used, modified, and redistributed.
Tagged version

Modules with tagged versions give importers more predictable builds.
Stable version

When a project reaches major version v1 it is considered stable.
Learn more about best practices

Repository

github.com/stakater/jamadar

Links

Open Source Insights

README ¶

Jamadar

WHY NAME JAMADAR?

Jamadar, an Urdu word, is used for Sweepers/Cleaners in Pakistan. This Jamadar will keep your cluster clean and sweep away the left overs of your cluster and will act as you want it to.

Problem

Dangling/Redundant resources take a lot of space and memory in a cluster. So we want to delete these unneeded resources depending upon the age and pre-defined annotations. e.g. I would like to delete namespaces that were without a specific annotation and are almost a month old and would like to take action whenever that happens.

Solution

Jamadar is a Kubernetes controller that can poll at configured time intervals and watch for dangling resources that are an 'X' time period old and don't have a specific annotation, and will delete them and take corresponding actions.

Configuring

First of all you need to modify configs/config.yaml file. Following are the available options that you can use to customize Jamadar:

Key	Description
pollTimeInterval	The time interval after which the controller will poll and look for dangling resources, The value can be in "ms", "s", "m", "h" or even combined like 2h45m
age	The time period that a dangling resource has been created e.g. delete only resources that are 7 days old, The value can be in "d", "w", "m", "y", Combined format is not supported
resources	The resources that you want to be taken care of by Jamadar, e.g. namespaces, pods, etc
actions	The Array of actions that you want to take, e.g. send message to Slack, etc
restrictedNamespaces	The Array of string which contains the namespaces names to ignore

Supported Resources

Currently we are supporting the following dangling resources,

namespaces

We will be adding support for other Resources as well in the future

Supported Actions

Currently we are supporting following Actions with their Parameters,

Default: No parameters needed, it will just log to console the details.
Slack: you need to provide token and Channel Name as Parameters in the yaml file

We will be adding support for other Actions as well in the future

Deploying to Kubernetes

You have to first clone or download the repository contents. The kubernetes deployment and files are provided inside deployments/kubernetes/manifests folder.

Deploying through kubectl

You can deploy Jamadar by running the following kubectl commands:

kubectl apply -f configmap.yaml -n <namespace>
kubectl apply -f rbac.yaml -n <namespace>
kubectl apply -f deployment.yaml -n <namespace>

Helm Charts

Or alternatively if you configured helm on your cluster, you can deploy Jamadar via helm chart located under deployments/kubernetes/chart/Jamadar folder.