diff --git a/.github/workflows/docs.yaml b/.github/workflows/docs.yaml index cbec3e85..8e6b2594 100644 --- a/.github/workflows/docs.yaml +++ b/.github/workflows/docs.yaml @@ -20,6 +20,10 @@ jobs: curl https://raw.githubusercontent.com/fluxcd/source-controller/master/docs/spec/v1alpha1/helmrepositories.md > docs/components/source/helmrepositories.md curl https://raw.githubusercontent.com/fluxcd/kustomize-controller/master/docs/api/kustomize.md > docs/components/kustomize/api.md curl https://raw.githubusercontent.com/fluxcd/kustomize-controller/master/docs/spec/v1alpha1/kustomization.md > docs/components/kustomize/kustomization.md + curl https://raw.githubusercontent.com/fluxcd/notification-controller/master/docs/api/notification.md > docs/components/notification/api.md + curl https://raw.githubusercontent.com/fluxcd/notification-controller/master/docs/spec/v1alpha1/event.md > docs/components/notification/event.md + curl https://raw.githubusercontent.com/fluxcd/notification-controller/master/docs/spec/v1alpha1/alert.md > docs/components/notification/alert.md + curl https://raw.githubusercontent.com/fluxcd/notification-controller/master/docs/spec/v1alpha1/provider.md > docs/components/notification/provider.md - name: Deploy docs uses: mhausenblas/mkdocs-deploy-gh-pages@master env: diff --git a/docs/components/kustomize/controller.md b/docs/components/kustomize/controller.md index af699231..a9acf827 100644 --- a/docs/components/kustomize/controller.md +++ b/docs/components/kustomize/controller.md @@ -15,7 +15,7 @@ Features: - Health assessment of the deployed workloads - Runs pipelines in a specific order (depends-on relationship) - Prunes objects removed from source (garbage collection) -- Reports cluster state changes (Slack/Discord) +- Reports cluster state changes (alerting provided by notification-controller) Links: diff --git a/docs/components/notification/controller.md b/docs/components/notification/controller.md new file mode 100644 index 00000000..6d5fac41 --- /dev/null +++ b/docs/components/notification/controller.md @@ -0,0 +1,16 @@ +# Notification Controller + +The Notification Controller is a Kubernetes operator, +specialized in dispatching events to external systems such as +Slack, Microsoft Teams, Discord and Rocket chat. + +The controller receives events via HTTP and dispatch them to external +webhooks based on event severity and involved objects. + +The controller can be configured with Kubernetes custom resources that +define how events are processed and where to dispatch them. + +Links: + +- Source code [fluxcd/notification-controller](https://github.com/fluxcd/notification-controller) +- Specification [docs](https://github.com/fluxcd/notification-controller/tree/master/docs/spec) diff --git a/docs/index.md b/docs/index.md index 46bae307..b66b709b 100644 --- a/docs/index.md +++ b/docs/index.md @@ -41,6 +41,9 @@ Components: - [HelmRepository CRD](components/source/helmrepositories.md) - [Kustomize Controller](components/kustomize/controller.md) - [Kustomization CRD](components/kustomize/kustomization.md) +- [Notification Controller](components/notification/controller.md) + - [Provider CRD](components/notification/provider.md) + - [Alert CRD](components/notification/alert.md) - Helm Controller (TBA) To get started with the toolkit please follow this [guide](get-started/index.md). diff --git a/docs/roadmap/index.md b/docs/roadmap/index.md index 172ebe8e..dff5ec19 100644 --- a/docs/roadmap/index.md +++ b/docs/roadmap/index.md @@ -28,12 +28,12 @@ Non-Goals Tasks - Review the git source and kustomize APIs -- Design the events API +- ~~Design the events API~~ - Implement events in source and kustomize controllers - Implement Prometheus metrics in source and kustomize controllers - Make the kustomize-controller apply/gc events on-par with Flux v1 apply events -- Design the notifications and events filtering API -- Implement a notification controller for Slack, MS Teams, Discord, Rocket +- ~~Design the notifications and events filtering API~~ +- ~~Implement a notification controller for Slack, MS Teams, Discord, Rocket~~ - Implement the migration command in tk - Create a migration guide for `flux.yaml` kustomize users diff --git a/mkdocs.yml b/mkdocs.yml index 26e27d07..a60a69c0 100644 --- a/mkdocs.yml +++ b/mkdocs.yml @@ -48,6 +48,12 @@ nav: - Overview: components/kustomize/controller.md - Kustomization CRD: components/kustomize/kustomization.md - Kustomize API Reference: components/kustomize/api.md + - Notification Controller: + - Overview: components/notification/controller.md + - Profile CRD: components/notification/profile.md + - Alert CRD: components/notification/alert.md + - Event: components/notification/event.md + - Notification API Reference: components/notification/api.md - Toolkit CLI: - Overview: cmd/tk.md - Bootstrap: cmd/tk_bootstrap.md