Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

Awesome Lists | Featured Topics | Projects

https://github.com/sukeesh/k8s-job-notify

Kuberenets Job/CronJob Notifier
https://github.com/sukeesh/k8s-job-notify

Last synced: about 2 months ago
JSON representation

Kuberenets Job/CronJob Notifier

Host: GitHub
URL: https://github.com/sukeesh/k8s-job-notify
Owner: sukeesh
License: mit
Created: 2019-11-25T15:47:28.000Z (almost 5 years ago)
Default Branch: master
Last Pushed: 2022-06-09T08:57:34.000Z (over 2 years ago)
Last Synced: 2024-06-20T06:28:36.985Z (3 months ago)
Language: Go
Size: 44.2 MB
Stars: 129
Watchers: 6
Forks: 18
Open Issues: 7
Metadata Files:
- Readme: README.md
- License: LICENSE

Awesome Lists containing this project

awesome-k8s - k8s-job-notify

README

# Kubernetes Job/CronJob Notifier

[![GitHub followers](https://img.shields.io/github/followers/sukeesh?label=Follow&style=social)](https://github.com/sukeesh)
[![Twitter URL](https://img.shields.io/twitter/url?style=social&url=https%3A%2F%2Fgithub.com%2Fsukeesh%2Fk8s-job-notify)](https://twitter.com/intent/tweet?url=https%3A%2F%2Fgithub.com%2Fsukeesh%2Fk8s-job-notify)

[![DeepSource](https://static.deepsource.io/deepsource-badge-light.svg)](https://deepsource.io/gh/sukeesh/k8s-job-notify/?ref=repository-badge)

[![GoReport](https://goreportcard.com/badge/github.com/sukeesh/k8s-job-notify)](https://goreportcard.com/report/github.com/sukeesh/k8s-job-notify)
[![Docker Pulls](https://img.shields.io/docker/pulls/sukeesh/k8s-job-notify.svg?style=flat-square&logo=docker)](https://hub.docker.com/r/sukeesh/k8s-job-notify/tags)
![GitHub commit activity](https://img.shields.io/github/commit-activity/m/sukeesh/k8s-job-notify?color=red&logo=github&style=flat-square)

This tool sends an alert to slack whenever there is a [Kubernetes](https://github.com/kubernetes/kubernetes) cronJob/Job failure/success.

**No extra setup** required to deploy this tool on to your cluster, just apply below K8s deploy manifest 🎉

This uses `InClusterConfig` for accessing Kubernetes API.

## Limitations

- Namespace scoped i.e., each namespace should have this deploy _separately_
- **All the jobs** in the namespace are fetched and verified for failures
- Will add support for selectors in future 📋

## Development

If you wish to run this locally, clone this repository, set `webhook` and `namespace` env variables.
This expects kube config to be in `~/.kube/config` (default)

```sh
$ export webhook="slack_webhook_url" && export namespace="" && go build && ./k8s-job-notify
```

You can also adjust the notification level to `failed` instead of `all` so that it only sends failed notificatinos.

```sh
$ export webhook="slack_webhook_url" && export namespace="" && export notification_level="failed" && go build && ./k8s-job-notify
```

Docker 🐳

---

Docker images are hosted at [hub.docker/k8s-job-notify](https://hub.docker.com/r/sukeesh/k8s-job-notify)

## Releases

- If you want to use stable releases, please use [github release tags](https://github.com/sukeesh/k8s-job-notify/releases). For example, `image: sukeesh/k8s-job-notify:1.2`
- If you wish to use unstable, use `image: sukeesh/k8s-job-notify:beta` (triggered whenever push to `master` is made)

## To start using this

Create and apply below kubernetes deployment in your cluster

```yaml
apiVersion: apps/v1
kind: Deployment
metadata:
labels:
app: kjn
name: k8s-job-notify
namespace:
spec:
replicas: 1
selector:
matchLabels:
app: kjn
template:
metadata:
annotations:
sidecar.istio.io/inject: 'false'
labels:
app: kjn
spec:
#serviceAccountName: k8s-job-notify (optional, see RBAC)
containers:
- env:
- name: webhook
value: # creating a secret for this var is recommended
- name: namespace
valueFrom:
fieldRef:
fieldPath: metadata.namespace
- name: incluster
value: '1'
- name: "notification_level"
value: 'all' # or 'failed'
image: sukeesh/k8s-job-notify:
name: k8s-job-notify
resources:
limits:
cpu: 500m
memory: 256Mi
requests:
cpu: 500m
memory: 128Mi
```

If your kubernetes uses RBAC, you should apply the following manifest as well:

```yaml
---
apiVersion: v1
kind: ServiceAccount
metadata:
name: k8s-job-notify
namespace:

---
apiVersion: rbac.authorization.k8s.io/v1
kind: Role
metadata:
namespace:
name: job-reader
rules:
- apiGroups: ['batch'] # "" indicates the core API group
resources:
- jobs
verbs:
- get
- list
- watch

---
apiVersion: rbac.authorization.k8s.io/v1
kind: RoleBinding
metadata:
name: k8s-job-notify
namespace:
roleRef:
apiGroup: rbac.authorization.k8s.io
kind: Role
name: job-reader
subjects:
- kind: ServiceAccount
name: k8s-job-notify
namespace:
```

If you want to show cluster name in message:

```yaml
containers:
image: sukeesh/k8s-job-notify:
name: k8s-job-notify
args: ['--cluster-name=']
```

## Contributing 🤝

Contributions, issues and feature requests are welcome.

## Author

👤 Sukeesh

- Twitter: [@sukeeshbabu](https://twitter.com/sukeeshbabu)

Please feel free to ⭐️ this repository if this project helped you! 😉

## 📝 License