Skip to content

isabella232/kubwise

 
 

Repository files navigation

KubeWise Mark and Name

KubeWise is a Slack Bot for Helm. It notifies a Slack channel whenever a Helm chart is installed, upgraded or uninstalled in your Kubernetes cluster.

A demo of KubeWise posting Slack messages as ZooKeeper is installed, upgraded and uninstalled

Getting Started

  1. Create a Slack Bot.
    • username: kubewise
    • name: KubeWise
    • icon: Use This
  2. Save it and grab the API token.
  3. Invite the Bot into your channel by typing /invite @kubewise in your Slack channel.
  4. Install KubeWise in your Kubernetes cluster. See below.
kubectl create namespace kubewise
helm repo add larder https://charts.larder.dev
helm install kubewise larder/kubewise --namespace kubewise --set slack.token="<api-token>" --set slack.channel="#<channel>"

That's it! From now on, Helm operations will result in a message in your chosen Slack channel.

Supported Chat Apps

Logo Name Supported Get notified when support is added
Slack mark Slack
Microsoft Teams mark Microsoft teams Let me know
Flock mark Flock Let me know
Mattermost mark Mattermost Let me know
Twist Let me know
Telegram Let me know

Using KubeWise from outside a cluster

It is easy to use KubeWise from outside your Kubernetes cluster. It will pick up your local kubectl configuration and use it to speak to your cluster.

You will need to compile the go binary from source. For example,

# Clone and compile the binary
git clone git@github.com:larderdev/kubwise.git
cd kubewise
go build

# Run it against a cluster
env KW_SLACK_CHANNEL="#<channel>" KW_SLACK_TOKEN="<api-token>" kubewise

About

A Slack Bot for Helm

Resources

License

Code of conduct

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published

Languages

  • Go 90.0%
  • Smarty 7.8%
  • Dockerfile 1.2%
  • Shell 1.0%