Kubewatch
kubewatch is a Kubernetes watcher that currently publishes notification to available collaboration hubs/notification channels. Run it in your k8s cluster, and you will get event notifications through webhooks.
Environment variables
NatStreaming
variable Name |
Default Value |
Description |
NATS_SERVER_HOST |
nats://localhost:4222 |
|
CLUSTER_ID |
example-stan |
|
CLIENT_ID |
kubewatch |
|
###CI-CONFIG
variable Name |
Default Value |
Description |
DEFAULT_NAMESPACE |
default |
|
Usage
$ kubewatch -h
Kubewath: A watcher for Kubernetes
kubewatch is a Kubernetes watcher that could publishes notification
to Slack/hipchat/mattermost/flock channels. It watches the culster
for resource changes and notifies them through webhooks.
supported webhooks:
- slack
- hipchat
- mattermost
- flock
- webhook
Usage:
kubewatch [flags]
kubewatch [command]
Available Commands:
config modify kubewatch configuration
resource manage resources to be watched
version print version
Flags:
-h, --help help for kubewatch
Use "kubewatch [command] --help" for more information about a command.
Install
Cluster Installation
Using helm:
When you have helm installed in your cluster, use the following setup:
helm install --name kubewatch stable/kubewatch --set='rbac.create=true,slack.channel=#YOUR_CHANNEL,slack.token=xoxb-YOUR_TOKEN,resourcesToWatch.pod=true,resourcesToWatch.daemonset=true'
You may also provide a values file instead:
rbac:
create: true
resourcesToWatch:
daemonset: true
deployment: false
pod: true
replicaset: false
replicationcontroller: false
services: true
secret: false
configmap: false
slack:
channel: '#YOUR_CHANNEL'
token: 'xoxb-YOUR_TOKEN'
And use that:
$ helm upgrade --install kubewatch stable/kubewatch --values=values-file.yml
Using kubectl:
In order to run kubewatch in a Kubernetes cluster quickly, the easiest way is for you to create a ConfigMap to hold kubewatch configuration.
An example is provided at kubewatch-configmap.yaml
, do not forget to update your own slack channel and token parameters. Alternatively, you could use secrets.
Create k8s configmap:
$ kubectl create -f kubewatch-configmap.yaml
Create the Pod directly, or create your own deployment:
$ kubectl create -f kubewatch.yaml
A kubewatch
container will be created along with kubectl
sidecar container in order to reach the API server.
Once the Pod is running, you will start seeing Kubernetes events in your configured Slack channel. Here is a screenshot:
To modify what notifications you get, update the kubewatch
ConfigMap and turn on and off (true/false) resources:
resource:
deployment: false
replicationcontroller: false
replicaset: false
daemonset: false
services: true
pod: true
secret: false
configmap: false
ingress: false
Working with RBAC
Kubernetes Engine clusters running versions 1.6 or higher introduced Role-Based Access Control (RBAC). We can create ServiceAccount
for it to work with RBAC.
$ kubectl create -f kubewatch-service-account.yaml
If you do not have permission to create it, you need to become a admin first. For example, in GKE you would run:
$ kubectl create clusterrolebinding cluster-admin-binding --clusterrole=cluster-admin --user=REPLACE_EMAIL_HERE
Edit kubewatch.yaml
, and create a new field under spec
with serviceAccountName: kubewatch
, you can achieve this by running:
$ sed -i '/spec:/a\ \ serviceAccountName: kubewatch' kubewatch.yaml
Then just create pod
as usual with:
$ kubectl create -f kubewatch.yaml
Local Installation
Using go package installer:
# Download and install kubewatch
$ go get -u github.com/bitnami-labs/kubewatch
# Configure the notification channel
$ kubewatch config add slack --channel <slack_channel> --token <slack_token>
# Add resources to be watched
$ kubewatch resource add --po --svc
INFO[0000] resource svc configured
INFO[0000] resource po configured
# start kubewatch server
$ kubewatch
INFO[0000] Starting kubewatch controller pkg=kubewatch-service
INFO[0000] Starting kubewatch controller pkg=kubewatch-pod
INFO[0000] Processing add to service: default/kubernetes pkg=kubewatch-service
INFO[0000] Processing add to service: kube-system/tiller-deploy pkg=kubewatch-service
INFO[0000] Processing add to pod: kube-system/tiller-deploy-69ffbf64bc-h8zxm pkg=kubewatch-pod
INFO[0000] Kubewatch controller synced and ready pkg=kubewatch-service
INFO[0000] Kubewatch controller synced and ready pkg=kubewatch-pod
Kubewatch supports config
command for configuration. Config file will be saved at $HOME/.kubewatch.yaml
$ kubewatch config -h
config command allows admin setup his own configuration for running kubewatch
Usage:
kubewatch config [flags]
kubewatch config [command]
Available Commands:
add add webhook config to .kubewatch.yaml
view view .kubewatch.yaml
Flags:
-h, --help help for config
Use "kubewatch config [command] --help" for more information about a command.
Example:
slack:
-
Create a slack Bot
-
Edit the Bot to customize its name, icon and retrieve the API token (it starts with xoxb-
).
-
Invite the Bot into your channel by typing: /join @name_of_your_bot
in the Slack message area.
-
Add Api token to kubewatch config using the following steps
$ kubewatch config add slack --channel <slack_channel> --token <slack_token>
You have an altenative choice to set your SLACK token, channel via environment variables:
$ export KW_SLACK_TOKEN='XXXXXXXXXXXXXXXX'
$ export KW_SLACK_CHANNEL='#channel_name'
flock:
-
Create a flock bot.
-
Add flock webhook url to config using the following command.
$ kubewatch config add flock --url <flock_webhook_url>
You have an altenative choice to set your FLOCK URL
$ export KW_FLOCK_URL='https://api.flock.com/hooks/sendMessage/XXXXXXXX'
Viewing config
To view the entire config file $HOME/.kubewatch.yaml
use the following command.
$ kubewatch config view
Contents of .kubewatch.yaml
handler:
slack:
token: xoxb-xxxxx-yyyy-zzz
channel: kube-watch
hipchat:
token: ""
room: ""
url: ""
mattermost:
channel: ""
url: ""
username: ""
flock:
url: ""
webhook:
url: ""
resource:
deployment: false
replicationcontroller: false
replicaset: false
daemonset: false
services: false
pod: true
job: false
persistentvolume: false
namespace: false
secret: false
configmap: false
ingress: false
namespace: ""
Resources
To manage the resources being watched, use the following command, changes will be saved to $HOME/.kubewatch.yaml
.
$ kubewatch resource -h
manage resources to be watched
Usage:
kubewatch resource [flags]
kubewatch resource [command]
Available Commands:
add adds specific resources to be watched
remove remove specific resources being watched
Flags:
--cm watch for plain configmap
--deploy watch for deployments
--ds watch for daemonsets
-h, --help help for resource
--ing watch for ingresses
--job watch for job
--ns watch for namespaces
--po watch for pods
--pv watch for persistent volumes
--rc watch for replication controllers
--rs watch for replicasets
--secret watch for plain secrets
--svc watch for services
Use "kubewatch resource [command] --help" for more information about a command.
Add/Remove resource:
$ kubewatch resource add -h
adds specific resources to be watched
Usage:
kubewatch resource add [flags]
Flags:
-h, --help help for add
Global Flags:
--cm watch for plain configmaps
--deploy watch for deployments
--ds watch for daemonsets
--ing watch for ingresses
--job watch for jobs
--ns watch for namespaces
--po watch for pods
--pv watch for persistent volumes
--rc watch for replication controllers
--rs watch for replicasets
--secret watch for plain secrets
--svc watch for services
Example:
# rc, po and svc will be watched
$ kubewatch resource add --rc --po --svc
# rc, po and svc will be stoped from being watched
$ kubewatch resource remove --rc --po --svc
Build
Using go
Clone the repository into your $GOPATH and then build it.
$ mkdir -p $GOPATH/src/github.com/devtron-labs/
$ cd $GOPATH/src/github.com/devtron-labs/
$ git clone https://github.com/devtron-labs/kubewatch.git
$ cd kubewatch
$ go build -o kubewatch main.go
You can also use the Makefile directly:
$ make build
Prerequisites
- You need to have Go (v1.7 or later) installed. Make sure to set
$GOPATH
Using Docker
$ make docker-image
$ docker images
REPOSITORY TAG IMAGE ID CREATED SIZE
kubewatch latest 919896d3cd90 3 minutes ago 27.9MB
Prerequisites
- you need to have docker installed.