README.md

velero-notifications

This is a simple Kubernetes controller written in Crystal that sends Email/Slack/webhook notifications when backups are performed by Velero in a Kubernetes cluster.

If you like this or any of my other projects and would like to help with their development, consider becoming a sponsor.

Installation

• Clone the repo
• Install with Helm

helm upgrade --install \
  --namespace velero \
  --set velero_namespace=velero \
  --set notification_prefix="[Velero]" \
  --set slack.enabled=true \
  --set slack.failures_only=false \
  --set slack.webhook=https://... \
  --set slack.channel=velero \
  --set slack.username=Velero \
  --set email.enabled=true \
  --set email.failures_only=true \
  --set email.smtp.host=... \
  --set email.smtp.port=587 \
  --set email.smtp.username=... \
  --set email.smtp.password=... \
  --set email.from_address=... \
  --set email.to_address=...
  --set webhook.enabled=true \
  --set webhook.failures_only=false \
  --set webhook.url=https://... \
  velero-backup-notification ./helm

That's it! You should now receive notifications when a backup is completed or fails. It couldn't be simpler than that!

License

MIT License

Stargazers over time