Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/lnsp/k8s-crash-informer
Informs a Mattermost or Slack channel if an annotated deployment goes into crash loop.
https://github.com/lnsp/k8s-crash-informer
chat-ops kubernetes kubernetes-controller mattermost monitoring slack
Last synced: 5 days ago
JSON representation
Informs a Mattermost or Slack channel if an annotated deployment goes into crash loop.
- Host: GitHub
- URL: https://github.com/lnsp/k8s-crash-informer
- Owner: lnsp
- License: mit
- Created: 2019-02-15T01:21:55.000Z (over 5 years ago)
- Default Branch: master
- Last Pushed: 2023-07-28T14:45:44.000Z (over 1 year ago)
- Last Synced: 2024-06-20T03:47:28.890Z (5 months ago)
- Topics: chat-ops, kubernetes, kubernetes-controller, mattermost, monitoring, slack
- Language: Go
- Homepage:
- Size: 277 KB
- Stars: 47
- Watchers: 3
- Forks: 8
- Open Issues: 2
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# k8s-crash-informer
[](https://github.com/lnsp/k8s-crash-informer/actions?workflow=Go) [](https://github.com/lnsp/k8s-crash-informer/actions?workflow=Docker)
This Kubernetes controller informs you when a Kubernetes Pod repeatedly dies (`CrashLoopBackOff`) while providing additional information like exit code and logs. **This is my first attempt at writing a Kubernetes controller, if you have any feedback please open an issue.**
## Usage
### Step 1: Add a config map for the informer
##### For Mattermost, you should use
```yaml
apiVersion: v1
data:
token:
channel:
team:
url:
kind: ConfigMap
metadata:
name: mattermost-informer-cfg
```
You should supply the [token of the bot](https://docs.mattermost.com/developer/bot-accounts.html) (or a [personal access token of a user](https://docs.mattermost.com/developer/personal-access-tokens.html)), server URL, team and channel.
##### If you use Slack, use
```yaml
apiVersion: v1
data:
channel:
token:
kind: ConfigMap
metadata:
name: slack-informer-cfg
```
You should use the Bot User OAuth Access Token as `token`. It can be copied from the Slack App admin interface after registering a new Slack API App and enabling the Bot feature.
##### If you use Telegram, use
```yaml
apiVersion: v1
data:
chatId:
token:
kind: ConfigMap
metadata:
name: telegram-informer-cfg
```
Extracting the chat ID in Telegram can be slightly finicky. The easiest way I've found is using the ID exposed in the URLs when using the web.telegram.org frontend.
This step is required to create a valid configuration for our crash informer.
### Step 2: Deploy the informer
```bash
# If you use Mattermost
kubectl apply -f manifests/mattermost-informer.yaml
# If you use Slack
kubectl apply -f manifests/slack-informer.yaml
# If you use Telegram
kubectl apply -f manifests/telegram-informer.yaml
```
You may want to update the `namespace` references, since the informer only watches a given namespace.
### Step 3: Annotate your Deployments, ReplicaSets or Pods
To begin watching pods (or deployments or replica sets), you only have to add the following annotation to the spec.
```yaml
annotations:
espe.tech/crash-informer: "true"
```
You may optionally set the backoff interval in seconds using `espe.tech/informer-backoff`.
### Step 4: Get notified!
