An app that helps you monitor your Kubernetes cluster, debug critical deployments & gives recommendations for standard practices
Go to file
Pierluigi Lenoci 5c40418b56
Fixed BOTKUBE_VERSION (#483)
##### ISSUE TYPE
<!--- Pick one below and delete the rest: -->
 - Bug fix Pull Request

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

The software notifies on the channel if you are using the updated version of BotKube or not. To do this, use the BOTKUBE_VERSION variable which is set up with the `.Chart.Version` value which does not necessarily correspond to the version of the software running on the cluster. The actual version of the software that runs is the one that comes from `.Values.image.tag`. 

<img width="616" alt="Screenshot 2021-05-11 at 09 51 39" src="https://user-images.githubusercontent.com/36044817/117780091-96588700-b23f-11eb-984c-b6555b1f3629.png">
2021-05-21 13:23:53 +00:00
.github Update Go and pkg deps (#475) 2021-04-24 20:06:01 +05:30
branding/logos Add BotKube icons for reference (#316) 2020-07-27 12:38:50 +00:00
build Update Go and pkg deps (#475) 2021-04-24 20:06:01 +05:30
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 github_changelog_generator to work with v1.15.2 (#453) 2021-01-29 00:25:18 +05:30
helm/botkube Fixed BOTKUBE_VERSION (#483) 2021-05-21 13:23:53 +00:00
pkg Update Go and pkg deps (#475) 2021-04-24 20:06:01 +05:30
test Update Go and pkg deps (#475) 2021-04-24 20:06:01 +05:30
.codespell-whitelist Codespell action for BotKube (#394) 2020-10-05 12:26:10 +05:30
.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.12.1 2021-04-25 18:28:47 +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.1 2021-04-25 18:28:47 +05:30
CODE_OF_CONDUCT.md Create CODE_OF_CONDUCT.md 2019-03-01 14:25:34 +05:30
comm_config.yaml Add Discord support (#268) 2020-10-06 04:37:49 +00:00
CONTRIBUTING.md Update CONTRIBUTING.md (#391) 2020-10-05 07:09:23 +00:00
deploy-all-in-one-tls.yaml Release v0.12.1 2021-04-25 18:28:47 +05:30
deploy-all-in-one.yaml Release v0.12.1 2021-04-25 18:28:47 +05:30
go.mod Fix CI builds (#489) 2021-05-21 13:03:56 +00:00
go.sum Fix CI builds (#489) 2021-05-21 13:03:56 +00:00
LICENSE Add license headers to source files (#266) 2020-04-27 09:20:16 +05:30
Makefile adding option to create and destroy kind clusters (#365) 2020-10-05 04:23:36 +00:00
README.md Added hyperlinks to communication platforms (#401) 2020-10-06 16:23:08 +00:00
resource_config.yaml Update Go and pkg deps (#475) 2021-04-24 20:06:01 +05:30

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.

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