readme

hack/deployment.sample.yml

@@ -26,6 +26,12 @@ spec:
               value: "1"
             - name: PROJECT_ID
               value: "my-project-id"
+            # - name: WEBHOOK_ENDPOINT
+            #   value: https://my.webhookrelay.com/v1/webhooks/2fc52b16-75f7-41f2-8e2d-81afbbcae709  
+            # - name: SLACK_TOKEN
+            #   value: your-token-here
+            # - name: SLACK_CHANNELS
+            #   value: general            
           name: keel
           command: ["/bin/keel"]
           ports:

readme.md

@@ -187,3 +187,30 @@ Once Keel is deployed in your Kubernetes cluster - it occasionally scans your cu
 
 If you have any quetions or notice a problem - raise an issue.
 
+## Notifications
+
+Keel uses a simple notification framework that can easily be extended. Out of the box Keel supports
+two types of notifications: Slack and webhooks.
+
+
+### Configuring Slack notifications
+
+First, get a Slack token, info about that can be found in the [docs](https://get.slack.help/hc/en-us/articles/215770388-Create-and-regenerate-API-tokens).
+
+Then, provide token via __SLACK_TOKEN__ environment variable. You should also provide __SLACK_CHANNELS__ environment variable with a comma separated list of channels where these notifications should go.
+
+Keel will be sending messages when deployment updates succeed or fail.
+
+### Configuring webhook notifications
+
+Provide an endpoint via __WEBHOOK_ENDPOINT__ environment variable. 
+
+Webhook payload sample:
+
+```
+{
+	"name": "update deployment",
+	"message": "Successfully updated deployment default/wd (karolisr/webhook-demo:0.0.10)",
+	"createdAt": "2017-07-08T10:08:45.226565869+01:00"	
+}
+```