Skip to content

Commit

Permalink
Update document
Browse files Browse the repository at this point in the history
  • Loading branch information
pkosiec committed Aug 31, 2023
1 parent bee522d commit dcc92d3
Show file tree
Hide file tree
Showing 6 changed files with 16 additions and 39 deletions.
50 changes: 16 additions & 34 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -8,7 +8,6 @@
Botkube is a messaging bot for monitoring and debugging Kubernetes clusters.
</p>


<p align="center">
<a href="https://github.com/kubeshop/botkube/releases/latest">
<img src="https://img.shields.io/github/v/release/kubeshop/botkube" alt="Latest Release" />
Expand All @@ -31,59 +30,42 @@

Botkube helps you monitor your Kubernetes cluster, debug critical deployments and gives recommendations for standard practices by running checks on the Kubernetes resources. It integrates with multiple communication platforms, such as [Slack](https://slack.com), [Discord](https://discord.com/), or [Mattermost](https://mattermost.com).

You can also execute `kubectl` commands on K8s cluster via Botkube which helps debugging an application or cluster.
You can also execute `kubectl`, `helm` and other commands on your K8s, which helps debugging an application or cluster.

<p align="center">
<img src="./docs/assets/main-demo.gif" />
</p>

## Getting started

Please follow [this](https://docs.botkube.io/installation/) for a complete Botkube installation guide.

## Documentation

For full documentation, visit [botkube.io](https://docs.botkube.io). The documentation sources reside on the [botkube-docs](https://github.com/kubeshop/botkube-docs) repository under **content** directory.
Follow [the official Botkube installation guide](https://docs.botkube.io/installation/) to get started.

## Features

<img src="./docs/assets/icons/terminal-box-line.svg" width="12%" align="right"/>

### Execute `kubectl` commands

The same `kubectl` capabilities inside your favorite communicator. You do not have to learn anything new! Plus, you can configure which `kubectl` commands Botkube can execute. See [configuration](https://docs.botkube.io/configuration/) for details.

<br /><br />
### 💬 Connect to your clusters from anywhere at any time

<img src="./docs/assets/icons/question-answer-line.svg" width="10%" align="left"/>
Botkube intergrates with all common messaging platforms including:

### Use multiple communication platforms
- Teams
- Slack
- Discord
- Mattermost

Botkube integrates with Slack, Discord, Mattermost, Microsoft Teams, ElasticSearch and outgoing webhook. See [configuration](https://docs.botkube.io/configuration/communication/) syntax for details.
### 💡 Elevate your troubleshooting workflow with intelligent insights

<br /><br />
Supercharge your technical workflow with our seamless alert consolidation and filtering. Gain automated intelligent insights to troubleshoot with precision and efficiency. Get alerted by Kubernetes, Prometheus, and other tools.

<img src="./docs/assets/icons/stack-line.svg" width="13%" align="right"/>
### 🚀 See alerts, Take action

### Monitor any Kubernetes resource
Take your ChatOps experience to new heights and go beyond just monitoring. Seamlessly take action on your clusters with ease and efficiency. Access tools like `kubectl` and `helm` right from your collaboration workspace. Collaborate with other team members in real time.

Botkube supports literally any Kubernetes resource, including Custom Resources. For example, if you use [`cert-manager`](https://cert-manager.io/), you can get alerted about certificate issue, or backup failure in case you use backup tools like [Velero](https://velero.io/) or [Kanister](https://kanister.io/).
### 📖 Wait, there's more!

<br /><br />
Read more about Botkube features on [the official website](https://botkube.io/features/).

<img src="./docs/assets/icons/bug-line.svg" width="12%" align="left"/>

### Debug anywhere, anytime

Using Botkube you can debug your apps deployed on Kubernetes from anywhere. To extract crucial information from the cluster, you can even use mobile communicator apps, like Slack. The entire team can see what steps have already been taken and avoid duplicated work.

<br /><br />

<img src="./docs/assets/icons/cloud-line.svg" width="12%" align="right"/>

### Deploy on any Kubernetes cluster
## Documentation

You can deploy Botkube backend on any Kubernetes cluster. It doesn't matter whether it is [K3d](https://k3d.io), managed Kubernetes on a cloud provider, or bare-metal one.
For full documentation, visit [docs,botkube.io](https://docs.botkube.io). The documentation sources reside on the [botkube-docs](https://github.com/kubeshop/botkube-docs) repository.

## Licence

Expand Down
1 change: 0 additions & 1 deletion docs/assets/icons/bug-line.svg

This file was deleted.

1 change: 0 additions & 1 deletion docs/assets/icons/cloud-line.svg

This file was deleted.

1 change: 0 additions & 1 deletion docs/assets/icons/question-answer-line.svg

This file was deleted.

1 change: 0 additions & 1 deletion docs/assets/icons/stack-line.svg

This file was deleted.

1 change: 0 additions & 1 deletion docs/assets/icons/terminal-box-line.svg

This file was deleted.

0 comments on commit dcc92d3

Please sign in to comment.