Version: 1.0

Source

The source configuration allows you to define multiple source configurations that can be later referred in communication bindings. For example, take a look at such source definition:

sources:
  "k8s-recommendation-alerts": # This is a source configuration name, which is referred in communication bindings.
    botkube/kubernetes:
      # ... trimmed ...

  "prometheus-firing-alerts": # This is a source configuration name, which is referred in communication bindings.
    botkube/prometheus:
      # ... trimmed ...

This can be later used by the communication platforms:

communications:
  "default-group":
    slack:
      channels:
        "default":
          bindings:
            sources: # The order is important for merging strategy.
              - k8s-recommendation-events # The source configuration name
              - prometheus-firing-events # The source configuration name
          # ... trimmed ...

To use the Botkube source plugins, first you need to define the plugins repository under the plugins property:

plugins:
  repositories:
    repo-name:
      url: https://example.com/plugins-index.yaml

Next, you can configure source from a given repository:

sources:
  "plugins":
    repo-name/source-name@v1.0.0: # Plugin name syntax: <repo>/<plugin>[@<version>]. If version is not provided, the latest version from repository is used.
      enabled: true
      config: {}

For all source configuration properties, see the syntax section.

Syntax

# Map of sources. The `sources` property name is an alias for a given configuration.
# Key name is used as a binding reference.
#
# Format: sources.{alias}
sources:
  "prom":
    botkube/prometheus@v1.0.1: # Plugin name syntax: <repo>/<plugin>[@<version>]. If version is not provided, the latest version from repository is used.
      enabled: true # If not enabled, plugin is not downloaded and started.
      config: # Plugin's specific configuration.
        url: "http://localhost:9090"

  "k8s-recommendation-events":
    # Built-in kubernetes source configuration.
    botkube/kubernetes:
      enabled: true
      config:
        # Kubernetes configuration
        recommendations:
          pod:
            noLatestImageTag: true
        # ... trimmed ...

# Configuration for Botkube executors and sources plugins.
plugins:
  # Directory, where downloaded plugins are cached.
  cacheDir: "/tmp"
  # List of plugins repositories.
  repositories:
    # This repository serves officially supported Botkube plugins.
    botkube:
      url: https://github.com/kubeshop/botkube/releases/download/v1.0.1/plugins-index.yaml
    # Other 3rd party repositories.
    repo-name:
      url: https://example.com/plugins-index.yaml

The default configuration for the Botkube Helm chart can be found in the values.yaml file.

Syntax​

Syntax