An app that helps you monitor your Kubernetes cluster, debug critical deployments & gives recommendations for standard practices
Go to file
Prasad Ghangal 05691f61b8
Update K8s package deps to 1.16 (#193)
Signed-off-by: Prasad Ghangal <prasad.ghangal@gmail.com>
2019-10-11 15:53:02 +05:30
.github Add GitHub Pull Request template 2019-04-04 19:51:22 +05:30
build Update K8s package deps to 1.16 (#193) 2019-10-11 15:53:02 +05:30
cmd/botkube Add support for Webhooks 2019-09-02 13:18:51 +05:30
design Added support for Mattermost 2019-04-04 16:31:53 +05:30
hack Refactor Test Suite (#174) 2019-09-03 22:27:24 +05:30
helm/botkube Fix namespace format in config files (#198) 2019-10-11 14:57:47 +05:30
pkg Update Deprecated API groups in K8s 1.16 (#192) 2019-10-10 15:28:47 +05:30
test Update Deprecated API groups in K8s 1.16 (#192) 2019-10-10 15:28:47 +05:30
.gitignore Remove vendoring since we have switched to go modules (#166) 2019-08-26 21:58:41 +05:30
.release Release v0.8.0 2019-07-09 16:13:16 +05:30
.travis.yml Use infracloudio/botkube repo for docker images 2019-09-30 14:35:27 +05:30
botkube_arch.jpg Update BotKube architecture image 2019-06-04 13:13:38 +05:30
botkube-title.jpg Added image 2019-01-24 15:23:48 +05:30
CHANGELOG.md Release v0.8.0 2019-07-09 16:13:16 +05:30
CODE_OF_CONDUCT.md Create CODE_OF_CONDUCT.md 2019-03-01 14:25:34 +05:30
config.yaml Fix namespace format in config files (#198) 2019-10-11 14:57:47 +05:30
CONTRIBUTING.md Use infracloudio/botkube repo for docker images 2019-09-30 14:35:27 +05:30
deploy-all-in-one-tls.yaml Fix namespace format in config files (#198) 2019-10-11 14:57:47 +05:30
deploy-all-in-one.yaml Fix namespace format in config files (#198) 2019-10-11 14:57:47 +05:30
go.mod Update K8s package deps to 1.16 (#193) 2019-10-11 15:53:02 +05:30
go.sum Update K8s package deps to 1.16 (#193) 2019-10-11 15:53:02 +05:30
LICENSE Add MIT license 2019-01-16 00:16:41 +05:30
Makefile Use infracloudio/botkube repo for docker images 2019-09-30 14:35:27 +05:30
README.md Add Latest Release Version Badge (#196) 2019-10-11 10:02:32 +05:30

BotKube

Build Status Go Report Card BotKube website Slack GoDoc Release Version

For complete documentation visit www.botkube.io

BotKube integration with Slack or Mattermost helps you monitor your Kubernetes cluster, debug critical deployments and gives recommendations for standard practices by running checks on the Kubernetes resources. You can also ask BotKube to execute kubectl commands on k8s cluster which helps debugging an application or cluster.

Getting started

Please follow this for complete BotKube installation guide.

Architecture

  • Informer Controller: Registers informers to kube-apiserver to watch events on the configured k8s resources. It forwards the incoming k8s event to the Event Manager
  • Event Manager: Extracts required fields from k8s event object and creates a new BotKube event struct. It passes BotKube event struct to the Filter Engine
  • Filter Engine: Takes the k8s object and BotKube event struct and runs Filters on them. Each filter runs some validations on the k8s object and modifies the messages in the BotKube event struct if required.
  • Event Notifier: Finally, notifier sends BotKube event over the configured communication channel.
  • Bot Interface: Bot interface takes care of authenticating and managing connections with communication mediums like Slack, Mattermost. It reads/sends messages from/to commucation mediums.
  • Executor: Executes BotKube or kubectl command and sends back the result to the Bot interface.

Visit www.botkube.io for Configuration, Usage and Examples.