incubator/kubewatch/README.md
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.
$ helm install incubator/kubewatch
This chart bootstraps a kubewatch deployment on a Kubernetes cluster using the Helm package manager.
To install the chart with the release name my-release:
$ 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.
To uninstall/delete the my-release deployment:
$ helm delete my-release
The command removes all the Kubernetes components associated with the chart and deletes the release.
The following table lists the configurable parameters of the kubewatch chart and their default values.
| Parameter | Description | Default |
|---|---|---|
affinity | node/pod affinities | None |
image.repository | Image repository | tuna/kubewatch |
image.tag | Image tag | v0.0.3 |
image.pullPolicy | Image pull policy | IfNotPresent |
nodeSelector | node labels for pod assignment | {} |
podAnnotations | annotations to add to each pod | {} |
podLabels | additional labesl to add to each pod | {} |
rbac.create | If true, create & use RBAC resources | false |
rbac.serviceAccountName | existing ServiceAccount to use (ignored if rbac.create=true) | default |
replicaCount | desired number of pods | 1 |
resourcesToWatch | list of resources which kubewatch should watch and notify slack | {pod: true, deployment: true} |
resourcesToWatch.pod | watch changes to Pods | true |
resourcesToWatch.deployment | watch changes to Deployments | true |
resourcesToWatch.replicationcontroller | watch changes to ReplicationControllers | false |
resourcesToWatch.replicaset | watch changes to ReplicaSets | false |
resourcesToWatch.daemonset | watch changes to DaemonSets | false |
resourcesToWatch.services | watch changes to Services | false |
resourcesToWatch.job | watch changes to Jobs | false |
resourcesToWatch.persistentvolume | watch changes to PersistentVolumes | false |
resources | pod resource requests & limits | {} |
slack.channel | slack channel to notify | "" |
slack.token | slack API token | "" |
tolerations | List 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,
$ 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,
$ helm install incubator/kubewatch --name my-release -f values.yaml
Tip: You can use the default values.yaml
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.