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
262 Commits 12 Branches 17 Tags 8.7 MiB
Go 92.8%
Shell 5%
Makefile 0.9%
Dockerfile 0.8%
Smarty 0.5%
a64b24d8b6
Go to file
Akanksha kumari a64b24d8b6
Initialized the DiscoveryClient Variable (#337) 
##### ISSUE TYPE
<!--- Pick one below and delete the rest: -->
 - Bug fix Pull Request

##### SUMMARY
Fixes #336
2020-09-10 11:00:07 +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 Added support for Mattermost 2019-04-04 16:31:53 +05:30
hack Fixes #179: Migration of current travis ci to github-actions ci. (#244) 2020-05-14 10:32:03 +05:30
helm/botkube Update resource in deployment manifests with G/V/R format (#332) 2020-09-07 17:28:55 +00:00
pkg Initialized the DiscoveryClient Variable (#337) 2020-09-10 11:00:07 +00:00
test (feat.) creation of SharedInformer from Dynamic ClientSet (#253) 2020-09-07 03:42:32 +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.10.0 2020-04-27 09:58:06 +05:30
botkube_arch.jpg Update BotKube architecture diagram (#263) 2020-04-23 10:36:58 +05:30
botkube-title.jpg Added image 2019-01-24 15:23:48 +05:30
CHANGELOG.md Release v0.10.0 2020-04-27 09:58:06 +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 Update CONTRIBUTE.md to work with the latest changes (#237) 2019-12-23 23:20:49 +05:30
deploy-all-in-one-tls.yaml Update resource in deployment manifests with G/V/R format (#332) 2020-09-07 17:28:55 +00:00
deploy-all-in-one.yaml Update resource in deployment manifests with G/V/R format (#332) 2020-09-07 17:28:55 +00:00
go.mod Add MS Teams support (#242) 2020-08-11 06:12:09 +00:00
go.sum (feat.) creation of SharedInformer from Dynamic ClientSet (#253) 2020-09-07 03:42:32 +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 Remove travis CI integration (#281) 2020-05-14 13:13:43 +05:30
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 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.