Adding Alerting Docs

This commit is contained in:
Anurag Ekkati
2022-09-26 19:33:07 -07:00
parent d998c1a19e
commit 632eeaa527

12
docs/Alerting.md Normal file
View File

@@ -0,0 +1,12 @@
# Alerting on Reload
Reloader can alert when it triggers a rolling upgrade on Deployments or StatefulSets. Webhook notification alert would be sent to the configured webhook server with all the required information
#### Enabling the feature
In-order to enable this feature, you need to update the reloader.env.secret section of values.yaml providing the information needed for alert.
<pre> ALERT_ON_RELOAD: [ true/false ] Default: false
ALERT_SINK: [ slack/webhook ] Default: webhook
ALERT_WEBHOOK_URL: Required if ALERT_ON_RELOAD is true
ALERT_ADDITIONAL_INFO: Any additional information to be added to alert
#### Slack incoming-webhook creation docs
https://api.slack.com/messaging/webhooks