Back to Charts

kubewatch

incubator/kubewatch/README.md

latest4.1 KB
Original Source

kubewatch

kubewatch is a Kubernetes watcher that currently publishes notification to Slack. Run it in your k8s cluster, and you will get event notifications in a slack channel.

N.B. this chart is deprecated and has been moved to stable.

TL;DR;

console
$ helm install incubator/kubewatch

Introduction

This chart bootstraps a kubewatch deployment on a Kubernetes cluster using the Helm package manager.

Installing the Chart

To install the chart with the release name my-release:

console
$ helm install incubator/kubewatch --name my-release

The command deploys kubewatch on the Kubernetes cluster in the default configuration. The configuration section lists the parameters that can be configured during installation.

Uninstalling the Chart

To uninstall/delete the my-release deployment:

console
$ helm delete my-release

The command removes all the Kubernetes components associated with the chart and deletes the release.

Configuration

The following table lists the configurable parameters of the kubewatch chart and their default values.

ParameterDescriptionDefault
affinitynode/pod affinitiesNone
image.repositoryImage repositorytuna/kubewatch
image.tagImage tagv0.0.3
image.pullPolicyImage pull policyIfNotPresent
nodeSelectornode labels for pod assignment{}
podAnnotationsannotations to add to each pod{}
podLabelsadditional labesl to add to each pod{}
rbac.createIf true, create & use RBAC resourcesfalse
rbac.serviceAccountNameexisting ServiceAccount to use (ignored if rbac.create=true)default
replicaCountdesired number of pods1
resourcesToWatchlist of resources which kubewatch should watch and notify slack{pod: true, deployment: true}
resourcesToWatch.podwatch changes to Podstrue
resourcesToWatch.deploymentwatch changes to Deploymentstrue
resourcesToWatch.replicationcontrollerwatch changes to ReplicationControllersfalse
resourcesToWatch.replicasetwatch changes to ReplicaSetsfalse
resourcesToWatch.daemonsetwatch changes to DaemonSetsfalse
resourcesToWatch.serviceswatch changes to Servicesfalse
resourcesToWatch.jobwatch changes to Jobsfalse
resourcesToWatch.persistentvolumewatch changes to PersistentVolumesfalse
resourcespod resource requests & limits{}
slack.channelslack channel to notify""
slack.tokenslack API token""
tolerationsList of node taints to tolerate (requires Kubernetes >= 1.6)[]

Specify each parameter using the --set key=value[,key=value] argument to helm install. For example,

console
$ helm install incubator/kubewatch --name my-release \
  --set=slack.channel="#bots",slack.token="XXXX-XXXX-XXXX"

Alternatively, a YAML file that specifies the values for the above parameters can be provided while installing the chart. For example,

console
$ helm install incubator/kubewatch --name my-release -f values.yaml

Tip: You can use the default values.yaml

Create a Slack bot

Open https://my.slack.com/services/new/bot to create a new Slack bot. The API token can be found on the edit page (it starts with xoxb-).

Invite the Bot to your channel by typing /join @name_of_your_bot in the Slack message area.