Skip to main content
Version: 1.7

Elasticsearch for self-hosted Botkube


  • Botkube CLI installed according to the Getting Started guide
  • Access to Kubernetes cluster
  • Elasticsearch server

Install Botkube in Kubernetes cluster

To deploy Botkube agent in your cluster, run:

export CLUSTER_NAME={cluster_name}
export ELASTICSEARCH_ADDRESS={elasticsearch_address}
export ELASTICSEARCH_USERNAME={elasticsearch_username}
export ELASTICSEARCH_PASSWORD={elasticsearch_password}
export ELASTICSEARCH_INDEX_NAME={elasticsearch_index_name}

botkube install --version v1.7.0 \
--set communications.default-group.elasticsearch.enabled=true \
--set communications.default-group.elasticsearch.server=${ELASTICSEARCH_ADDRESS} \
--set communications.default-group.elasticsearch.username=${ELASTICSEARCH_USERNAME} \
--set communications.default-group.elasticsearch.password=${ELASTICSEARCH_PASSWORD} \
--set settings.clusterName=${CLUSTER_NAME}


  • ELASTICSEARCH_ADDRESS is an address on which Elasticsearch server is reachable e.g,
  • ELASTICSEARCH_USERNAME is the username for authentication to Els server,
  • ELASTICSEARCH_PASSWORD is a password for the username to authenticate with Els server,
  • ELASTICSEARCH_INDEX_NAME (optional) is an index name on which Botkube events will be stored (default: botkube).

Configuration syntax is explained here. All possible installation parameters are documented here.

Remove Botkube from Kubernetes cluster

Execute the following command to completely remove Botkube and related resources from your cluster:

botkube uninstall