botkube

module
v1.3.0-rc.2 Latest Latest
Warning

This package is not in the latest version of its module.

Go to latest
Published: Aug 11, 2023 License: MIT

README

Botkube Logo Light

Botkube is a messaging bot for monitoring and debugging Kubernetes clusters.

Latest Release License Slack CI Build Go Docs

Overview

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, Discord, or Mattermost.

You can also execute kubectl commands on K8s cluster via Botkube which helps debugging an application or cluster.

Getting started

Please follow this for a complete Botkube installation guide.

Documentation

For full documentation, visit botkube.io. The documentation sources reside on the botkube-docs repository under content directory.

Features

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



Use multiple communication platforms

Botkube integrates with Slack, Discord, Mattermost, Microsoft Teams, ElasticSearch and outgoing webhook. See configuration syntax for details.



Monitor any Kubernetes resource

Botkube supports literally any Kubernetes resource, including Custom Resources. For example, if you use cert-manager, you can get alerted about certificate issue, or backup failure in case you use backup tools like Velero or Kanister.



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.



Deploy on any Kubernetes cluster

You can deploy Botkube backend on any Kubernetes cluster. It doesn't matter whether it is K3d, managed Kubernetes on a cloud provider, or bare-metal one.

Licence

This project is currently licensed under the MIT License.

Directories

Path Synopsis
cmd
cli
internal
cli
Package cli is copied and adjusted code from: https://github.com/kubernetes-sigs/kind/blob/b6bc112522651d98c81823df56b7afa511459a3b/pkg/internal/env/term.go#L51
Package cli is copied and adjusted code from: https://github.com/kubernetes-sigs/kind/blob/b6bc112522651d98c81823df56b7afa511459a3b/pkg/internal/env/term.go#L51
executor
Package executor aggregates officially supported Botkube plugin executors.
Package executor aggregates officially supported Botkube plugin executors.
executor/x/getter
Package getter.
Package getter.
loggerx
Package loggerx provides helper functions and extensions responsible for logging.
Package loggerx provides helper functions and extensions responsible for logging.
ptr
pkg
api
bot
pluginx
Package pluginx provides helper functions to simplify working it Botkube plugins.
Package pluginx provides helper functions to simplify working it Botkube plugins.
test

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL