cli

command
v1.16.0-rc.2 Latest Latest
Warning

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

Go to latest
Published: Aug 11, 2026 License: MIT Imports: 4 Imported by: 0

README

Migration tool for Botkube Cloud

Command line tool that helps you migrate your Botkube installation to Botkube Cloud.

Installation

go build -o bctl main.go

Usage

We assume you have a working Botkube instance and a Botkube Cloud account. This tool gathers all the information needed to migrate your Botkube instance from your Kubernetes cluster - a working kube config is also needed.

  1. Find the namespace where the Botkube instance is installed (botkube is the default):
kubectl get ns
kubectl get pod -n botkube --show-labels
  1. Login to Botkube Cloud:
bctl login
  1. Run the migration tool and follow instructions:
bctl migrate --namespace botkube --labels app=botkube

Implementation details

Login

We tried to make the migration process as simple and automated as possible. The login workflow involves a locally served http server that listens for a callback from the browser after the user login. The callback contains the access token that is used to authenticate the user and is stored locally in ~/.botkube/config.json. The server is stopped after the callback is received.

Migration

Once user is logged in, Botkube CLI creates a Pod in the same namespace where Botkube resides. Then, it mounts the same Secrets and ConfigMaps as the Botkube Pod, and pulls entire configuration to a ConfigMap botkube-config-exporter.

Once we have the configuration, we can turn it into a API call and create identical resources in Botkube Cloud.

Documentation

The Go Gopher

There is no documentation for this package.

Directories

Path Synopsis
cmd
telemetry
Package telemetry provides CLI commands for managing Botkube telemetry settings.
Package telemetry provides CLI commands for managing Botkube telemetry settings.

Jump to

Keyboard shortcuts

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