valitydev/botkube
14
0
Fork 0
mirror of https://github.com/valitydev/botkube.git synced 2024-11-06 08:25:19 +00:00
Code Issues Actions Packages Projects Releases Wiki Activity
An app that helps you monitor your Kubernetes cluster, debug critical deployments & gives recommendations for standard practices
364 Commits 12 Branches 17 Tags 8.7 MiB
Go 92.8%
Shell 5%
Makefile 0.9%
Dockerfile 0.8%
Smarty 0.5%
9b3a8b128f
Go to file
Ivan Martynyuk 9b3a8b128f
Merge pull request #1 from valitydev/ft/TD-74 
TD-74::add filter to show pod's url in kibana
2022-02-17 10:48:48 +03:00
.github Feature: CI vulnerability scan #565 2022-02-09 18:08:18 +00:00
branding/logos Add BotKube icons for reference (#316) 2020-07-27 12:38:50 +00:00
build Update base image to address busybox CVEs (#551) 2021-12-03 15:02:34 +00:00
cmd/botkube Add Discord support (#268) 2020-10-06 04:37:49 +00:00
design Fix spelling and change case in comments and docs (#411) 2020-10-16 10:33:19 +00:00
hack Update release script to bump release tags (#544) 2021-11-17 15:31:36 +00:00
helm/botkube [helm] Set empty list as default value for extraEnv #540 2022-02-04 08:42:38 +00:00
pkg TD-74::add logs-url field to events entity 2022-02-16 16:46:58 +03:00
test [Test] Do not log msg in tests (#555) 2021-12-17 11:18:40 +00:00
.codespell-whitelist Codespell action for BotKube (#394) 2020-10-05 12:26:10 +05:30
.gitignore Publish multi-arch images with goreleaser (#509) 2021-08-19 10:56:22 +05:30
.goreleaser.yml Publish multi-arch images with goreleaser (#509) 2021-08-19 10:56:22 +05:30
.mergify.yml ci(Mergify): configuration update (#563) 2022-02-04 09:40:12 +05:30
.release Release v0.12.4 2021-12-13 09:13:05 +05:30
botkube_arch.jpg Update BotKube architecture diagram (#344) 2020-09-24 05:28:04 +00:00
botkube-title.jpg Added image 2019-01-24 15:23:48 +05:30
CHANGELOG.md Release v0.12.4 2021-12-13 09:13:05 +05:30
CODE_OF_CONDUCT.md Create CODE_OF_CONDUCT.md 2019-03-01 14:25:34 +05:30
comm_config.yaml TD-74::move kibana url to yaml configuration 2022-02-14 15:04:01 +03:00
CONTRIBUTING.md Publish multi-arch images with goreleaser (#509) 2021-08-19 10:56:22 +05:30
deploy-all-in-one-tls.yaml Release v0.12.4 2021-12-13 09:13:05 +05:30
deploy-all-in-one.yaml Release v0.12.4 2021-12-13 09:13:05 +05:30
go.mod Upgrade github.com/gogo/protobuf dep (#553) 2021-12-14 10:20:14 +05:30
go.sum Upgrade github.com/gogo/protobuf dep (#553) 2021-12-14 10:20:14 +05:30
LICENSE Add license headers to source files (#266) 2020-04-27 09:20:16 +05:30
Makefile Publish multi-arch images with goreleaser (#509) 2021-08-19 10:56:22 +05:30
README.md Remove hacktoberfest reference from the README (#529) 2021-10-06 15:09:31 +00:00
resource_config.yaml Update Go and pkg deps (#475) 2021-04-24 20:06:01 +05:30

README.md

BotKube

CI Go Report Card BotKube website GoDoc Release Version License Slack

For complete documentation visit www.botkube.io

BotKube integration with Slack, Mattermost or Microsoft Teams 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 a 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, Microsoft Teams and reads/sends messages from/to them.
  • Executor: Executes BotKube or kubectl command and sends back the result to the Bot interface.

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

Licence

This project is currently licensed under the MIT License.