sibyl

Sibyl

Watch for error events, fetch logs from the problem pod, post em to slack. Simple as that

Sibyl allows you to send Kubernetes error alerts with log context to slack!

Setup

To deploy Sibyl, you need to create a Slack App connected to your workspace where you would like to receive alerts, and then you need to deploy Sibyl into the target Kubernetes cluster that you would like to receive alerts from.

Create The Slack App

Go to Slack Apps, login and on the top right select “Create New App”: https://api.slack.com/apps
On the popup select “From Manifest”
Select your workspace
Flip to the YAML tab, and then upload the manifest located in this repository at: docs/sibyl-slack-manifest.yml
One created, select Settings > Basic Information and scroll down to the “Display Information” section. Select “Add App Icon”
Upload the Sibyl icon located in this repository at: docs/assets/sibyl-icon.png
Then go to Settings > Install App and select “Install App To Workspace”
Follow the screens and prompts. Note the slack channel you choose, you will need this when you install Sibyl
Once complete, go back to Settings > Install App and copy the “Bot User OAuth Token”. You will need this when you install Sibyl

Install Sibyl Into Your Cluster

Install with Helm by running:

# Add The Repository
helm repo add sibyl https://bensoer.github.io/sibyl
# Install the chart
helm upgrade --install sibyl sibyl/sibyl --set slack.channel=<YOUR_SLACK_CHANNEL> --set slack.botToken=<BOT_TOKEN>

Set YOUR_SLACK_CHANNEL to the channel your selected in step 8 when you installed Sibyl slack app in your workspace

Set BOT_TOKEN to the “Bot User OAuth Token” on the Settings > Install App page of your Sibyl Slack App

Configuration

Sibyl comes with a handful of configurations you can modify in the project.

Variable	Description	Required	Default Value / Possible Values
`SLACK_BOT_TOKEN`	Slack App Bot Auth Token	TRUE	N/A
`SLACK_CHANNEL`	Slack Channel To Post Alerts To	TRUE	Both `#mychannelname` and `mychannelname` formats are accepted
`LOG_LEVEL`	Set the log output level. `DEBUG` will output log from depednency libraries as well	FALSE	Default: `INFO`. Options: `INFO`, `DEBUG`, `WARNING`, `ERROR`
`HEALTH_CHECK_PORT`	Set the port to listen for health checks. You will need to update the Helm chart to match this value if changed	FALSE	8080

The above configurations are passed to Sibyl, and read at startup, via environment variables. The SLACK_BOT_TOKEN and SLACK_CHANNEL variables are the only ones that have been mapped out into helm values though.

To modify the other settings you will need to do the following:

Create a secret within your cluster called sibyl-env-configuration containing keys that match each environment variable and the values to the setting you want. Example:
```
 apiVersion: v1
 kind: Secret
 metadata:
 name: sibyl-env-credentials
 stringData:
     LOG_LEVEL: DEBUG
```
Apply this secret into the same namespace as sibyl is deployed

Deploy the helm chart with its envFrom values pointing at the configuration secret:

 helm upgrade --install sibyl sibyl/sibyl --set slack.channel=<YOUR_SLACK_CHANNEL> --set slack.botToken=<BOT_TOKEN>
 --set envFrom[0].secretRef.name=sibyl-env-credentials

Alternatively, make a copy of the values.yaml file and apply these changes and deploy it like this (assuming you set slack.channel and slack.botToken within it as well)

 helm upgrade --install sibyl sibyl/sibyl --values=./yourvaluesfile.yaml

If the deployment does not restart Sibyl, give it a restart through kubectl:
```
 kubectl rollout restart deployment sibyl
```

Developer Notes

Install development onto minikube by running:

helm upgrade --install sibyl charts/sibyl --set image.tag=main --set image.pullPolicy=Always

This site is open source. Improve this page.