DOCSEARCHbyAlgolia
Submit Docs

Botkube Documentation

website·Indexed 34 days ago

https://docs.botkube.io/

Documentation for Botkube, an open-source tool that integrates Kubernetes and other cloud-native tools with communication platforms like Slack. It features source plugins for Kubernetes, ArgoCD, GitHub Events, and Prometheus, as well as executor plugins for kubectl, Helm, and Flux to run CLI commands directly from chat.

Tokens
129K
Snippets
740
Records
919
Agent score
60%

What's inside Botkube

  1. Overview of Botkube Source Plugins

    Source plugins in Botkube are used to monitor Kubernetes environments and trigger notifications based on specific events or metrics. Available source plugins include:

    • Kubernetes Events: Built-in monitoring for K8s events.
    • ArgoCD: Integration for GitOps workflow notifications.
    • Prometheus: Connection to Prometheus metrics for monitoring.
    • Keptn: Automation of testing, deployment, and operations.

  2. Overview of Botkube Executor Plugins

    An executor plugin allows you to extend Botkube's functionality by running specific commands (e.g., kubectl) directly within a communication platform's chat window. Executor plugins are binaries that must implement the Protocol Buffers contract defined in the Botkube executor proto.

  3. Overview of Botkube Executor Plugins

    Botkube executor plugins allow developers to extend Botkube's functionality by running specific commands (e.g., kubectl) directly within a communication platform's chat window. An executor is a binary that implements the gRPC Protocol Buffers contract defined in the executor.proto file.

  4. Overview of Botkube AI Assistant features

    The AI Assistant plugin (v1.14) uses OpenAI's GPT-4o to help teams identify, diagnose, and troubleshoot Kubernetes cluster issues. Key capabilities include:

    • Analysis of Kubernetes events via an 'AI Help' button.
    • Troubleshooting based on kubectl commands, container logs, events, and resource usage (CPU/memory).
    • Cluster-wide scans for anomalies, security, and misconfigurations.
    • Answering arbitrary questions or instructions, including those based on user-supplied documentation.
    • Providing information on Botkube agent status, configuration, and documentation.
    • Maintaining conversation context within message threads (stored in-memory; cleared on restart).

  5. Overview of Botkube Executor Plugins

    Executor plugins allow users to perform actions and execute commands within their Kubernetes environment directly from the integrated communication channel. Available executor plugins include:

    • Kubectl: Execute standard Kubernetes commands.
    • AI: Intelligent interactions and automation via an AI assistant.
    • Helm: Manage Helm deployments and releases.
    • Flux: Perform GitOps operations.
    • Exec: Connect custom plugins for tailored Kubernetes workflows.

  6. Overview of Botkube AI Assistant features

    The AI Assistant plugin is powered by OpenAI's GPT-4o and helps teams identify, diagnose, and troubleshoot Kubernetes cluster issues. Key capabilities include:

    • Analysis of Kubernetes events via an 'AI Help' button.
    • Troubleshooting based on kubectl commands, container logs, events, and resource usage (CPU/memory).
    • Cluster-wide scans for anomalies, security, and misconfigurations.
    • Answering arbitrary questions or instructions.
    • RAG capabilities using user-supplied documentation.
    • Providing information on Botkube agent status, configuration, and documentation.
    • Maintaining conversation context within message threads.

  7. Overview of Botkube Communication Platform Integrations

    Botkube integrates with various communication platforms to allow users to receive Kubernetes notifications and interact with clusters directly from their chat interface. Supported platforms include Slack, Discord, and Mattermost.

  8. Overview of Botkube Source Plugins

    Botkube source plugins allow developers to extend functionality by creating binaries that provide asynchronous streaming of domain-specific events (e.g., Kubernetes or Prometheus events). A source plugin must implement the Protocol Buffers contract defined in source.proto.

  9. Overview of Botkube Predefined Actions

    Botkube provides predefined actions to automate common troubleshooting tasks. These actions are disabled by default and can be enabled via configuration or Botkube commands.

    Available predefined actions:

    • describe-created-resource: Describes a newly created resource.
    • show-logs-on-error: Prints logs when a Pod, StatefulSet, DaemonSet, or Deployment encounters an error.

  10. Overview of Botkube AI Assistant features

    The AI Assistant plugin (powered by OpenAI GPT-4o) provides AI-driven capabilities for Kubernetes cluster management, including:

    • Analysis of Kubernetes events via an 'AI Help' button.
    • Troubleshooting based on kubectl commands, container logs, events, and resource usage (CPU/memory).
    • Cluster-wide scanning for anomalies, security issues, and misconfigurations.
    • Answering arbitrary questions or instructions.
    • RAG (Retrieval-Augmented Generation) capabilities using user-supplied documentation.
    • Botkube-specific support based on agent status, configuration, and official documentation.
    • Conversation context persistence within message threads.

  11. Overview of Botkube capabilities

    Botkube is a troubleshooting and monitoring solution for Kubernetes environments. It allows DevOps teams to improve reliability through context-enhanced notifications and enables developers to troubleshoot applications without requiring direct Kubernetes access or specialized knowledge. Key capabilities include monitoring events from various sources, securely running commands, and executing automated actions via built-in or custom plugins.

  12. Overview of Botkube capabilities

    Botkube is a troubleshooting and monitoring solution for Kubernetes environments. It allows DevOps teams to deliver context-enhanced notifications about cluster events and enables developers to troubleshoot applications without requiring direct Kubernetes access or specialized knowledge. Key capabilities include monitoring events from various sources, securely running commands, and executing automated actions via built-in or custom plugins.