Usage

Debugging deployments using BotKube

@BotKube allows you to execute kubectl commands on your Kubernetes cluster. Run @BotKube help in the Slack channel or directly to the BotKube user to find more information about the supported commands. help As suggested in help message, to execute kubectl commands, send message in following format in the Slack channel where BotKube is already added or as a direct message to BotKube.

@BotKube <kubectl command without `kubectl` prefix>

See Examples for the use cases.

Managing Slack notifications

Depending upon your configuration, you will receive Slack notifications about Kubernetes resources lifecycle events and their health. BotKube bot allows you to enable/disable notifications using direct messages. Run @BotKube help in the Slack channel where the bot is added or as a direct message to the BotKube, the bot will reply with the help message about the supported message formats.

BotKube_help

View BotKube configuration

Run @BotKube notifier showconfig message on a channel where BotKube is added. The bot will reply you with the configuration with which the controller is running.

If you wish to change the configuration, you can update config section in helm/botkube/values.yaml and then run helm upgrade.

$ helm upgrade botkube --set config.communications.slack.channel=<SLACK_CHANNEL_NAME>,config.communications.slack.token=<SLACK_API_TOKEN_FOR_THE_BOT>,config.settings.clustername=<CLUSTER_NAME>,config.settings.allowkubectl=<ALLOW_KUBECTL> helm/botkube/

OR

You can also modify the controller configuration at runtime. You have to edit the configmap which will also restart the BotKube pod to update mounted configuration in the pod.

$ kubectl edit configmap botkube-configmap -n botkube

This command will open configmap specs in vim editor. Do the required changes, save and exit. The BotKube pod will automatically restart to have these configuration in effect.

Check BotKube health

Run @BotKube ping to the Slack channel where BotKube is added. The BotKube will respond you with message PONG if it is running. Else check the deployment in Kubernetes cluster in the botkube namespace.

ping

Disable Slack notifications

If you want to stop receiving Slack notifications from BotKube, run @BotKube notifier stop to the Slack channel where BotKube is added. You will no longer receive notifications from the BotKube

notifier_stop

Enable Slack notifications

If you want to receice Slack notifications from BotKube again, run @BotKube notifier start to the Slack channel where BotKube is added.

notifier_start

Check notifier status

Run @BotKube notifier status to check status of notifier if running or stopped

notifier_status