From 70225dfbf10ad6d1471c456cf4bab0645ad563cd Mon Sep 17 00:00:00 2001 From: Nicholas Jones Date: Fri, 26 Jul 2024 12:00:58 +0100 Subject: [PATCH] Add a basic README --- README.md | 10 ++++++++++ 1 file changed, 10 insertions(+) create mode 100644 README.md diff --git a/README.md b/README.md new file mode 100644 index 0000000..c4f12df --- /dev/null +++ b/README.md @@ -0,0 +1,10 @@ +# fluxcd-suspend-notifier + +Application that watches for suspend status changes of fluxcd resources. This is designed to operate in the context of +fluxcd running in a GKE cluster. + +- GKE audit logs are tailed to observe when fluxcd resources are mutated. We use this mechanism specifically as it + contains details of the user that has made the modification +- The kubernetes API is used to check if the suspend status has changed (resource modifications can occur for other + reasons) +- If the suspend status has changed, a notification is dispatched via Slack