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
326b138ca9
botkube/README.md

35 lines
2.7 KiB
Markdown
Raw Normal View History

Update README
2019-01-15 18:44:41 +00:00
# BotKube
Added badges and fixed punctuation (#387) ##### ISSUE TYPE - Docs Pull Request ##### SUMMARY - Added license, slack & release badges - added period at end of sentence Fixes - changed in README.md file
2020-10-06 05:03:28 +00:00
[Documentation]Add repo licence info and badge (#360) ISSUE TYPE - Docs Pull Request SUMMARY Add Licence reference badge in README Add licence related info in README ##### ISSUE TYPE - Docs Pull Request ##### SUMMARY <!--- Describe the change, including rationale and design decisions --> Add Licence reference badge in README for getting visible at first glance Add licence related info in README <!--- 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 -->
2020-10-01 13:58:42 +00:00
[![CI](https://github.com/infracloudio/botkube/workflows/CI/badge.svg?branch=develop)](https://github.com/infracloudio/botkube/actions?query=workflow%3ACI+branch%3Adevelop) [![Go Report Card](https://goreportcard.com/badge/github.com/infracloudio/botkube)](https://goreportcard.com/report/github.com/infracloudio/botkube)
[![BotKube website](https://img.shields.io/badge/docs-botkube.io-blue.svg)](https://botkube.io)
[![GoDoc](https://godoc.org/github.com/infracloudio/botkube?status.svg)](https://godoc.org/github.com/infracloudio/botkube)
[![Release Version](https://img.shields.io/github/v/release/infracloudio/botkube?label=Botkube)](https://github.com/infracloudio/botkube/releases/latest)
[![License](https://img.shields.io/github/license/infracloudio/botkube?color=light%20green&logo=github)](https://github.com/infracloudio/botkube/blob/develop/LICENSE)
Added badges and fixed punctuation (#387) ##### ISSUE TYPE - Docs Pull Request ##### SUMMARY - Added license, slack & release badges - added period at end of sentence Fixes - changed in README.md file
2020-10-06 05:03:28 +00:00
[![Slack](https://badgen.net/badge/slack/BotKube?icon=slack)](http://join.botkube.io/)
Add build status in README
2018-12-31 06:13:59 +00:00
Update README
2019-01-15 18:49:19 +00:00
For complete documentation visit www.botkube.io
Update README
2019-01-15 18:44:41 +00:00
Added hyperlinks to communication platforms (#401) ##### ISSUE TYPE <!--- Pick one below and delete the rest: --> - Docs Pull Request ##### SUMMARY <!--- Describe the change, including rationale and design decisions --> I added proper hyperlinks to slack, mattermost and microsoft teams <!--- 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 -->
2020-10-06 16:23:08 +00:00
BotKube integration with [Slack](https://slack.com), [Mattermost](https://mattermost.com) or [Microsoft Teams](https://www.microsoft.com/microsoft-365/microsoft-teams/group-chat-software) helps you monitor your Kubernetes cluster, debug critical deployments and gives recommendations for standard practices by running checks on the Kubernetes resources.
Update README
2019-01-15 18:44:41 +00:00
You can also ask BotKube to execute kubectl commands on k8s cluster which helps debugging an application or cluster.
Update README.md
2018-12-28 07:04:43 +00:00
Added image
2019-01-24 09:53:37 +00:00
![](botkube-title.jpg)
Update README.md
2019-01-04 09:59:26 +00:00
## Getting started
Update README.md! (#371) Signed-off-by: Binit Ghimire <thebinitghimire@gmail.com> ##### ISSUE TYPE <!--- Pick one below and delete the rest: --> - Docs Pull Request ##### SUMMARY <!--- Describe the change, including rationale and design decisions --> I resolved a grammatical mistake in **Line 15** of the documentation. <!--- 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 13:39:06 +00:00
Please follow [this](https://www.botkube.io/installation/) for a complete BotKube installation guide.
Added support for Mattermost
2019-03-14 18:46:46 +00:00
Add arch diagram in README
2019-01-24 12:09:11 +00:00
## Architecture
![](/botkube_arch.jpg)
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
- **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.
Add arch diagram in README
2019-01-24 12:09:11 +00:00
- **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.
Update README.md
2019-06-03 10:58:33 +00:00
- **Event Notifier:** Finally, notifier sends BotKube event over the configured communication channel.
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
- **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.
Update README.md
2019-06-03 10:58:33 +00:00
- **Executor:** Executes BotKube or kubectl command and sends back the result to the Bot interface.
Update README
2019-01-15 18:44:41 +00:00
Visit www.botkube.io for Configuration, Usage and Examples.
[Documentation]Add repo licence info and badge (#360) ISSUE TYPE - Docs Pull Request SUMMARY Add Licence reference badge in README Add licence related info in README ##### ISSUE TYPE - Docs Pull Request ##### SUMMARY <!--- Describe the change, including rationale and design decisions --> Add Licence reference badge in README for getting visible at first glance Add licence related info in README <!--- 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 -->
2020-10-01 13:58:42 +00:00
## Licence
This project is currently licensed under the [MIT License](https://github.com/infracloudio/botkube/blob/develop/LICENSE).
Reference in New Issue Copy Permalink