Skip to main content
Version: 1.11

Mattermost for Botkube Cloud

Prerequisites

  • Botkube Cloud account which you can create here for free.

Create a Botkube Cloud Instance with Mattermost

Follow the steps below to install Botkube in your Mattermost instance.

  1. Go to Botkube Cloud Web App and create a new instance.

    You can do it by clicking "Create an Instance" button on Home Page or under this link Create an Instance

  2. Fill in the Instance Display Name and click Next button.

    Instance Display Name

  3. Click Add platform dropdown, and select Mattermost option. Mattermost Platform Select

  4. Follow the Mattermost instructions for creating a bot account. When creating the bot account, use the following details:

    • Username — Botkube

      note

      You can also use a custom username for your bot. Just remember that you'll need to provide this username during a later step of the Botkube installation.

    • Description — Botkube helps you monitor your Kubernetes cluster, debug critical deployments and gives recommendations for standard practices by running checks on the Kubernetes resources..

    • Icon — You can download the Botkube icon from this link.

  5. Paste the bot name in the form

    Bot Name in the form

  6. Past the token in the form

    Personal Token in the form

  7. Add Botkube to a channel

    Make sure that the newly created bot account is added to your Mattermost team by following these instructions.

    Invite Bot Account

    Add Botkube user created to the channel you want to receive notifications in.

    Channels in the form

  8. Add plugins you want to enable in your Botkube instance and click Next button.

    Plugins

  9. Include optional default aliases and default actions and click Create button to create Botkube Cloud instance.

    Create

  10. Follow the instructions in the summary page to deploy Botkube into your environment.

Summary

Clean up

Remove Botkube from Mattermost Team

  • Deactivate or remove Botkube user from Mattermost Team. Login as System Admin, in the Menu proceed to System console -> Users -> botkube -> Deactivate.
  • Archive Channel created for Botkube communication if required.

Remove Botkube from Kubernetes cluster

  1. Go to Botkube Cloud instances page and click Manage button of the instance you want to remove.

  2. Click Delete instance button, type instance name in the popup and click Delete instance.

    caution

    Remember to execute the displayed command to completely remove Botkube and related resources from your cluster.

    Delete