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
275 Commits 12 Branches 17 Tags 8.7 MiB
Go 92.8%
Shell 5%
Makefile 0.9%
Dockerfile 0.8%
Smarty 0.5%
98fbfe2177
Go to file
Vishal Kichloo 98fbfe2177
Update README.md (#359) 
##### ISSUE TYPE
<!--- Pick one below and delete the rest: -->
 - Docs Pull Request

##### SUMMARY
<!--- Describe the change, including rationale and design decisions -->

<!---
If you are fixing an existing issue, please include "Fixes #nnn" in your
PR comment; and describe briefly what the change does.
-->

<!--- Please list dependencies added with your change also -->

Fixes #353
2020-10-01 06:03:37 +00:00
.github Remove travis CI integration (#281) 2020-05-14 13:13:43 +05:30
branding/logos Add BotKube icons for reference (#316) 2020-07-27 12:38:50 +00:00
build Add MS Teams support (#242) 2020-08-11 06:12:09 +00:00
cmd/botkube Add MS Teams support (#242) 2020-08-11 06:12:09 +00:00
design Update mattermost-support.md (#361) 2020-10-01 05:56:18 +00:00
hack Fixes #179: Migration of current travis ci to github-actions ci. (#244) 2020-05-14 10:32:03 +05:30
helm/botkube Release v0.11.0 2020-09-29 20:29:19 +05:30
pkg Fix for missing update diff for first update event (#345) 2020-09-26 14:07:52 +00:00
test (fix) Validate Resource before enabling an Informer against it. (#335) 2020-09-14 09:11:44 +00:00
.gitignore Added restrictAccess flag to restrict BotKube command execution 2020-01-01 18:10:25 +05:30
.mergify.yml Mergify: configuration update (#287) 2020-06-16 10:06:19 +05:30
.release Release v0.11.0 2020-09-29 20:29:19 +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.11.0 2020-09-29 20:29:19 +05:30
CODE_OF_CONDUCT.md Create CODE_OF_CONDUCT.md 2019-03-01 14:25:34 +05:30
comm_config.yaml Add MS Teams support (#242) 2020-08-11 06:12:09 +00:00
CONTRIBUTING.md Fix installation steps in CONTRIBUTING.md (#348) 2020-09-28 05:05:01 +00:00
deploy-all-in-one-tls.yaml Release v0.11.0 2020-09-29 20:29:19 +05:30
deploy-all-in-one.yaml Release v0.11.0 2020-09-29 20:29:19 +05:30
go.mod Add e2e test for Custom Resource support (#338) 2020-09-13 05:21:59 +00:00
go.sum Add e2e test for Custom Resource support (#338) 2020-09-13 05:21:59 +00:00
LICENSE Add license headers to source files (#266) 2020-04-27 09:20:16 +05:30
Makefile Use infracloudio/botkube repo for docker images 2019-09-30 14:35:27 +05:30
README.md Update README.md (#359) 2020-10-01 06:03:37 +00:00
resource_config.yaml Update resource in deployment manifests with G/V/R format (#332) 2020-09-07 17:28:55 +00:00

README.md

BotKube

CI Go Report Card BotKube website GoDoc Release Version

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.

Hacktoberfest 2020

BotKube is participating in Hacktoberfest 2020. We are giving some really cool swags to our contributors, learn more at - https://www.infracloud.io/blogs/infracloud-joins-hacktoberfest-2020/.

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, 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.