README
¶
Botkube is a messaging bot for monitoring and debugging Kubernetes clusters.
Overview
Botkube is a troubleshooting and monitoring solution that empowers DevOps teams to work more efficiently, enables developers to troubleshoot their applications without special Kubernetes access or knowledge, and improves reliability by delivering timely, context-enhanced notifications about events in your Kubernetes environments. It integrates with multiple communication platforms, such as Slack, Discord, or Mattermost. Botkube monitors events from various sources, allows you to securely run commands, and run automated actions triggered by any of the plugins Botkube supports or your own custom plugins.
You can also execute kubectl, helm and other commands on your K8s, which helps debugging an application or cluster.
Getting started
Follow the official Botkube installation guide to get started.
Features
💬 Connect to your clusters from anywhere at any time
Botkube integrates with all common messaging platforms including:
- Slack
- Discord
- Mattermost
💡 Elevate your troubleshooting workflow with intelligent insights
Supercharge your technical workflow with our seamless alert consolidation and filtering. Gain automated intelligent insights to troubleshoot with precision and efficiency. Get alerted by Kubernetes, Prometheus, and other tools.
🚀 See alerts, Take action
Take your ChatOps experience to new heights and go beyond just monitoring. Seamlessly take action on your clusters with ease and efficiency. Access tools like kubectl and helm right from your collaboration workspace. Collaborate with other team members in real time.
Documentation
For full documentation, visit docs.botkube.io. The documentation sources reside on the botkube-docs repository.
Licence
This project is currently licensed under the MIT License.
Directories
¶
| Path | Synopsis |
|---|---|
|
cmd
|
|
|
botkube-agent
command
|
|
|
cli
command
|
|
|
cli/cmd/telemetry
Package telemetry provides CLI commands for managing Botkube telemetry settings.
|
Package telemetry provides CLI commands for managing Botkube telemetry settings. |
|
config-exporter
command
|
|
|
executor/echo
command
|
|
|
executor/kubectl
command
|
|
|
source/cm-watcher
command
|
|
|
source/kubernetes
command
|
|
|
Package main provides a tool to generate the Botkube plugin index.
|
Package main provides a tool to generate the Botkube plugin index. |
|
target/build-plugins
command
|
|
|
target/gen-goreleaser
command
|
|
|
target/serve-plugins
command
|
|
|
internal
|
|
|
cli
Package cli is copied and adjusted code from: https://github.com/kubernetes-sigs/kind/blob/b6bc112522651d98c81823df56b7afa511459a3b/pkg/internal/env/term.go#L51
|
Package cli is copied and adjusted code from: https://github.com/kubernetes-sigs/kind/blob/b6bc112522651d98c81823df56b7afa511459a3b/pkg/internal/env/term.go#L51 |
|
cli/analytics
Package analytics provides CLI analytics command utilities.
|
Package analytics provides CLI analytics command utilities. |
|
executor
Package executor aggregates officially supported Botkube plugin executors.
|
Package executor aggregates officially supported Botkube plugin executors. |
|
pkg
|
|
|
bot/interactive
Package interactive provides utilities for building interactive bot messages.
|
Package interactive provides utilities for building interactive bot messages. |
|
loggerx
Package loggerx provides helper functions and extensions responsible for logging.
|
Package loggerx provides helper functions and extensions responsible for logging. |
|
mathx
Package mathx provides helper math utility functions.
|
Package mathx provides helper math utility functions. |
|
plugin
Package plugin provides utilities for loading and managing plugin configurations.
|
Package plugin provides utilities for loading and managing plugin configurations. |
|
sink
Package sink.
|
Package sink. |