Merge pull request #73 from fluxcd/notification-controller

Add notification component

.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:

.github/workflows/e2e.yaml

@@ -41,7 +41,7 @@ jobs:
           ./bin/tk check --pre
       - name: tk install --version
         run: |
-          ./bin/tk install --version=master --namespace=test --verbose
+          ./bin/tk install --version=master --namespace=test --verbose --components="source-controller,kustomize-controller"
       - name: tk uninstall
         run: |
           ./bin/tk uninstall --namespace=test --crds --silent

cmd/tk/main.go

@@ -112,7 +112,7 @@ func init() {
 	rootCmd.PersistentFlags().BoolVarP(&verbose, "verbose", "", false,
 		"print generated objects")
 	rootCmd.PersistentFlags().StringSliceVar(&components, "components",
-		[]string{"source-controller", "kustomize-controller"},
+		[]string{"source-controller", "kustomize-controller", "notification-controller"},
 		"list of components, accepts comma-separated values")
 }
 

docs/cmd/tk.md

@@ -67,7 +67,7 @@ Command line utility for assembling Kubernetes CD pipelines the GitOps way.
 ### Options
 
 ```
-      --components strings   list of components, accepts comma-separated values (default [source-controller,kustomize-controller])
+      --components strings   list of components, accepts comma-separated values (default [source-controller,kustomize-controller,notification-controller])
   -h, --help                 help for tk
       --kubeconfig string    path to the kubeconfig file (default "~/.kube/config")
       --namespace string     the namespace scope for this operation (default "gitops-system")

docs/cmd/tk_bootstrap.md

@@ -16,7 +16,7 @@ The bootstrap sub-commands bootstrap the toolkit components on the targeted Git
 ### Options inherited from parent commands
 
 ```
-      --components strings   list of components, accepts comma-separated values (default [source-controller,kustomize-controller])
+      --components strings   list of components, accepts comma-separated values (default [source-controller,kustomize-controller,notification-controller])
       --kubeconfig string    path to the kubeconfig file (default "~/.kube/config")
       --namespace string     the namespace scope for this operation (default "gitops-system")
       --timeout duration     timeout for this operation (default 5m0s)

docs/cmd/tk_bootstrap_github.md

@@ -54,7 +54,7 @@ tk bootstrap github [flags]
 ### Options inherited from parent commands
 
 ```
-      --components strings   list of components, accepts comma-separated values (default [source-controller,kustomize-controller])
+      --components strings   list of components, accepts comma-separated values (default [source-controller,kustomize-controller,notification-controller])
       --kubeconfig string    path to the kubeconfig file (default "~/.kube/config")
       --namespace string     the namespace scope for this operation (default "gitops-system")
       --timeout duration     timeout for this operation (default 5m0s)

docs/cmd/tk_bootstrap_gitlab.md

@@ -50,7 +50,7 @@ tk bootstrap gitlab [flags]
 ### Options inherited from parent commands
 
 ```
-      --components strings   list of components, accepts comma-separated values (default [source-controller,kustomize-controller])
+      --components strings   list of components, accepts comma-separated values (default [source-controller,kustomize-controller,notification-controller])
       --kubeconfig string    path to the kubeconfig file (default "~/.kube/config")
       --namespace string     the namespace scope for this operation (default "gitops-system")
       --timeout duration     timeout for this operation (default 5m0s)

docs/cmd/tk_check.md

@@ -32,7 +32,7 @@ tk check [flags]
 ### Options inherited from parent commands
 
 ```
-      --components strings   list of components, accepts comma-separated values (default [source-controller,kustomize-controller])
+      --components strings   list of components, accepts comma-separated values (default [source-controller,kustomize-controller,notification-controller])
       --kubeconfig string    path to the kubeconfig file (default "~/.kube/config")
       --namespace string     the namespace scope for this operation (default "gitops-system")
       --timeout duration     timeout for this operation (default 5m0s)

docs/cmd/tk_completion.md

@@ -33,7 +33,7 @@ To configure your bash shell to load completions for each session add to your ba
 ### Options inherited from parent commands
 
 ```
-      --components strings   list of components, accepts comma-separated values (default [source-controller,kustomize-controller])
+      --components strings   list of components, accepts comma-separated values (default [source-controller,kustomize-controller,notification-controller])
       --kubeconfig string    path to the kubeconfig file (default "~/.kube/config")
       --namespace string     the namespace scope for this operation (default "gitops-system")
       --timeout duration     timeout for this operation (default 5m0s)

docs/cmd/tk_create.md

@@ -17,7 +17,7 @@ The create sub-commands generate sources and resources.
 ### Options inherited from parent commands
 
 ```
-      --components strings   list of components, accepts comma-separated values (default [source-controller,kustomize-controller])
+      --components strings   list of components, accepts comma-separated values (default [source-controller,kustomize-controller,notification-controller])
       --kubeconfig string    path to the kubeconfig file (default "~/.kube/config")
       --namespace string     the namespace scope for this operation (default "gitops-system")
       --timeout duration     timeout for this operation (default 5m0s)

docs/cmd/tk_create_kustomization.md

@@ -63,7 +63,7 @@ tk create kustomization [name] [flags]
 ### Options inherited from parent commands
 
 ```
-      --components strings   list of components, accepts comma-separated values (default [source-controller,kustomize-controller])
+      --components strings   list of components, accepts comma-separated values (default [source-controller,kustomize-controller,notification-controller])
       --export               export in YAML format to stdout
       --interval duration    source sync interval (default 1m0s)
       --kubeconfig string    path to the kubeconfig file (default "~/.kube/config")

docs/cmd/tk_create_source.md

@@ -15,7 +15,7 @@ The create source sub-commands generate sources.
 ### Options inherited from parent commands
 
 ```
-      --components strings   list of components, accepts comma-separated values (default [source-controller,kustomize-controller])
+      --components strings   list of components, accepts comma-separated values (default [source-controller,kustomize-controller,notification-controller])
       --export               export in YAML format to stdout
       --interval duration    source sync interval (default 1m0s)
       --kubeconfig string    path to the kubeconfig file (default "~/.kube/config")

docs/cmd/tk_create_source_git.md

@@ -70,7 +70,7 @@ tk create source git [name] [flags]
 ### Options inherited from parent commands
 
 ```
-      --components strings   list of components, accepts comma-separated values (default [source-controller,kustomize-controller])
+      --components strings   list of components, accepts comma-separated values (default [source-controller,kustomize-controller,notification-controller])
       --export               export in YAML format to stdout
       --interval duration    source sync interval (default 1m0s)
       --kubeconfig string    path to the kubeconfig file (default "~/.kube/config")

docs/cmd/tk_delete.md

@@ -16,7 +16,7 @@ The delete sub-commands delete sources and resources.
 ### Options inherited from parent commands
 
 ```
-      --components strings   list of components, accepts comma-separated values (default [source-controller,kustomize-controller])
+      --components strings   list of components, accepts comma-separated values (default [source-controller,kustomize-controller,notification-controller])
       --kubeconfig string    path to the kubeconfig file (default "~/.kube/config")
       --namespace string     the namespace scope for this operation (default "gitops-system")
       --timeout duration     timeout for this operation (default 5m0s)

docs/cmd/tk_delete_kustomization.md

@@ -19,7 +19,7 @@ tk delete kustomization [name] [flags]
 ### Options inherited from parent commands
 
 ```
-      --components strings   list of components, accepts comma-separated values (default [source-controller,kustomize-controller])
+      --components strings   list of components, accepts comma-separated values (default [source-controller,kustomize-controller,notification-controller])
       --kubeconfig string    path to the kubeconfig file (default "~/.kube/config")
       --namespace string     the namespace scope for this operation (default "gitops-system")
   -s, --silent               delete resource without asking for confirmation

docs/cmd/tk_delete_source.md

@@ -15,7 +15,7 @@ The delete source sub-commands delete sources.
 ### Options inherited from parent commands
 
 ```
-      --components strings   list of components, accepts comma-separated values (default [source-controller,kustomize-controller])
+      --components strings   list of components, accepts comma-separated values (default [source-controller,kustomize-controller,notification-controller])
       --kubeconfig string    path to the kubeconfig file (default "~/.kube/config")
       --namespace string     the namespace scope for this operation (default "gitops-system")
   -s, --silent               delete resource without asking for confirmation

docs/cmd/tk_delete_source_git.md

@@ -19,7 +19,7 @@ tk delete source git [name] [flags]
 ### Options inherited from parent commands
 
 ```
-      --components strings   list of components, accepts comma-separated values (default [source-controller,kustomize-controller])
+      --components strings   list of components, accepts comma-separated values (default [source-controller,kustomize-controller,notification-controller])
       --kubeconfig string    path to the kubeconfig file (default "~/.kube/config")
       --namespace string     the namespace scope for this operation (default "gitops-system")
   -s, --silent               delete resource without asking for confirmation

docs/cmd/tk_export.md

@@ -16,7 +16,7 @@ The export sub-commands export resources in YAML format.
 ### Options inherited from parent commands
 
 ```
-      --components strings   list of components, accepts comma-separated values (default [source-controller,kustomize-controller])
+      --components strings   list of components, accepts comma-separated values (default [source-controller,kustomize-controller,notification-controller])
       --kubeconfig string    path to the kubeconfig file (default "~/.kube/config")
       --namespace string     the namespace scope for this operation (default "gitops-system")
       --timeout duration     timeout for this operation (default 5m0s)

docs/cmd/tk_export_kustomization.md

@@ -31,7 +31,7 @@ tk export kustomization [name] [flags]
 
 ```
       --all                  select all resources
-      --components strings   list of components, accepts comma-separated values (default [source-controller,kustomize-controller])
+      --components strings   list of components, accepts comma-separated values (default [source-controller,kustomize-controller,notification-controller])
       --kubeconfig string    path to the kubeconfig file (default "~/.kube/config")
       --namespace string     the namespace scope for this operation (default "gitops-system")
       --timeout duration     timeout for this operation (default 5m0s)

docs/cmd/tk_export_source.md

@@ -17,7 +17,7 @@ The export source sub-commands export sources in YAML format.
 
 ```
       --all                  select all resources
-      --components strings   list of components, accepts comma-separated values (default [source-controller,kustomize-controller])
+      --components strings   list of components, accepts comma-separated values (default [source-controller,kustomize-controller,notification-controller])
       --kubeconfig string    path to the kubeconfig file (default "~/.kube/config")
       --namespace string     the namespace scope for this operation (default "gitops-system")
       --timeout duration     timeout for this operation (default 5m0s)

docs/cmd/tk_export_source_git.md

@@ -31,7 +31,7 @@ tk export source git [name] [flags]
 
 ```
       --all                  select all resources
-      --components strings   list of components, accepts comma-separated values (default [source-controller,kustomize-controller])
+      --components strings   list of components, accepts comma-separated values (default [source-controller,kustomize-controller,notification-controller])
       --kubeconfig string    path to the kubeconfig file (default "~/.kube/config")
       --namespace string     the namespace scope for this operation (default "gitops-system")
       --timeout duration     timeout for this operation (default 5m0s)

docs/cmd/tk_get.md

@@ -15,7 +15,7 @@ The get sub-commands print the statuses of sources and resources.
 ### Options inherited from parent commands
 
 ```
-      --components strings   list of components, accepts comma-separated values (default [source-controller,kustomize-controller])
+      --components strings   list of components, accepts comma-separated values (default [source-controller,kustomize-controller,notification-controller])
       --kubeconfig string    path to the kubeconfig file (default "~/.kube/config")
       --namespace string     the namespace scope for this operation (default "gitops-system")
       --timeout duration     timeout for this operation (default 5m0s)

docs/cmd/tk_get_kustomizations.md

@@ -19,7 +19,7 @@ tk get kustomizations [flags]
 ### Options inherited from parent commands
 
 ```
-      --components strings   list of components, accepts comma-separated values (default [source-controller,kustomize-controller])
+      --components strings   list of components, accepts comma-separated values (default [source-controller,kustomize-controller,notification-controller])
       --kubeconfig string    path to the kubeconfig file (default "~/.kube/config")
       --namespace string     the namespace scope for this operation (default "gitops-system")
       --timeout duration     timeout for this operation (default 5m0s)

docs/cmd/tk_get_sources.md

@@ -15,7 +15,7 @@ The get source sub-commands print the statuses of the sources.
 ### Options inherited from parent commands
 
 ```
-      --components strings   list of components, accepts comma-separated values (default [source-controller,kustomize-controller])
+      --components strings   list of components, accepts comma-separated values (default [source-controller,kustomize-controller,notification-controller])
       --kubeconfig string    path to the kubeconfig file (default "~/.kube/config")
       --namespace string     the namespace scope for this operation (default "gitops-system")
       --timeout duration     timeout for this operation (default 5m0s)

docs/cmd/tk_get_sources_git.md

@@ -19,7 +19,7 @@ tk get sources git [flags]
 ### Options inherited from parent commands
 
 ```
-      --components strings   list of components, accepts comma-separated values (default [source-controller,kustomize-controller])
+      --components strings   list of components, accepts comma-separated values (default [source-controller,kustomize-controller,notification-controller])
       --kubeconfig string    path to the kubeconfig file (default "~/.kube/config")
       --namespace string     the namespace scope for this operation (default "gitops-system")
       --timeout duration     timeout for this operation (default 5m0s)

docs/cmd/tk_install.md

@@ -37,7 +37,7 @@ tk install [flags]
 ### Options inherited from parent commands
 
 ```
-      --components strings   list of components, accepts comma-separated values (default [source-controller,kustomize-controller])
+      --components strings   list of components, accepts comma-separated values (default [source-controller,kustomize-controller,notification-controller])
       --kubeconfig string    path to the kubeconfig file (default "~/.kube/config")
       --namespace string     the namespace scope for this operation (default "gitops-system")
       --timeout duration     timeout for this operation (default 5m0s)

docs/cmd/tk_resume.md

@@ -15,7 +15,7 @@ The resume sub-commands resume a suspended resource.
 ### Options inherited from parent commands
 
 ```
-      --components strings   list of components, accepts comma-separated values (default [source-controller,kustomize-controller])
+      --components strings   list of components, accepts comma-separated values (default [source-controller,kustomize-controller,notification-controller])
       --kubeconfig string    path to the kubeconfig file (default "~/.kube/config")
       --namespace string     the namespace scope for this operation (default "gitops-system")
       --timeout duration     timeout for this operation (default 5m0s)

docs/cmd/tk_resume_kustomization.md

@@ -20,7 +20,7 @@ tk resume kustomization [name] [flags]
 ### Options inherited from parent commands
 
 ```
-      --components strings   list of components, accepts comma-separated values (default [source-controller,kustomize-controller])
+      --components strings   list of components, accepts comma-separated values (default [source-controller,kustomize-controller,notification-controller])
       --kubeconfig string    path to the kubeconfig file (default "~/.kube/config")
       --namespace string     the namespace scope for this operation (default "gitops-system")
       --timeout duration     timeout for this operation (default 5m0s)

docs/cmd/tk_suspend.md

@@ -15,7 +15,7 @@ The suspend sub-commands suspend the reconciliation of a resource.
 ### Options inherited from parent commands
 
 ```
-      --components strings   list of components, accepts comma-separated values (default [source-controller,kustomize-controller])
+      --components strings   list of components, accepts comma-separated values (default [source-controller,kustomize-controller,notification-controller])
       --kubeconfig string    path to the kubeconfig file (default "~/.kube/config")
       --namespace string     the namespace scope for this operation (default "gitops-system")
       --timeout duration     timeout for this operation (default 5m0s)

docs/cmd/tk_suspend_kustomization.md

@@ -19,7 +19,7 @@ tk suspend kustomization [name] [flags]
 ### Options inherited from parent commands
 
 ```
-      --components strings   list of components, accepts comma-separated values (default [source-controller,kustomize-controller])
+      --components strings   list of components, accepts comma-separated values (default [source-controller,kustomize-controller,notification-controller])
       --kubeconfig string    path to the kubeconfig file (default "~/.kube/config")
       --namespace string     the namespace scope for this operation (default "gitops-system")
       --timeout duration     timeout for this operation (default 5m0s)

docs/cmd/tk_sync.md

@@ -15,7 +15,7 @@ The sync sub-commands trigger a reconciliation of sources and resources.
 ### Options inherited from parent commands
 
 ```
-      --components strings   list of components, accepts comma-separated values (default [source-controller,kustomize-controller])
+      --components strings   list of components, accepts comma-separated values (default [source-controller,kustomize-controller,notification-controller])
       --kubeconfig string    path to the kubeconfig file (default "~/.kube/config")
       --namespace string     the namespace scope for this operation (default "gitops-system")
       --timeout duration     timeout for this operation (default 5m0s)

docs/cmd/tk_sync_kustomization.md

@@ -32,7 +32,7 @@ tk sync kustomization [name] [flags]
 ### Options inherited from parent commands
 
 ```
-      --components strings   list of components, accepts comma-separated values (default [source-controller,kustomize-controller])
+      --components strings   list of components, accepts comma-separated values (default [source-controller,kustomize-controller,notification-controller])
       --kubeconfig string    path to the kubeconfig file (default "~/.kube/config")
       --namespace string     the namespace scope for this operation (default "gitops-system")
       --timeout duration     timeout for this operation (default 5m0s)

docs/cmd/tk_sync_source.md

@@ -15,7 +15,7 @@ The sync source sub-commands trigger a reconciliation of sources.
 ### Options inherited from parent commands
 
 ```
-      --components strings   list of components, accepts comma-separated values (default [source-controller,kustomize-controller])
+      --components strings   list of components, accepts comma-separated values (default [source-controller,kustomize-controller,notification-controller])
       --kubeconfig string    path to the kubeconfig file (default "~/.kube/config")
       --namespace string     the namespace scope for this operation (default "gitops-system")
       --timeout duration     timeout for this operation (default 5m0s)

docs/cmd/tk_sync_source_git.md

@@ -27,7 +27,7 @@ tk sync source git [name] [flags]
 ### Options inherited from parent commands
 
 ```
-      --components strings   list of components, accepts comma-separated values (default [source-controller,kustomize-controller])
+      --components strings   list of components, accepts comma-separated values (default [source-controller,kustomize-controller,notification-controller])
       --kubeconfig string    path to the kubeconfig file (default "~/.kube/config")
       --namespace string     the namespace scope for this operation (default "gitops-system")
       --timeout duration     timeout for this operation (default 5m0s)

docs/cmd/tk_uninstall.md

@@ -34,7 +34,7 @@ tk uninstall [flags]
 ### Options inherited from parent commands
 
 ```
-      --components strings   list of components, accepts comma-separated values (default [source-controller,kustomize-controller])
+      --components strings   list of components, accepts comma-separated values (default [source-controller,kustomize-controller,notification-controller])
       --kubeconfig string    path to the kubeconfig file (default "~/.kube/config")
       --namespace string     the namespace scope for this operation (default "gitops-system")
       --timeout duration     timeout for this operation (default 5m0s)

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:
 

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)

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).

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
 

manifests/bases/kustomize-controller/kustomization.yaml

@@ -1,5 +1,12 @@
 apiVersion: kustomize.config.k8s.io/v1beta1
 kind: Kustomization
 resources:
-- github.com/fluxcd/kustomize-controller/config//crd?ref=v0.0.1
-- github.com/fluxcd/kustomize-controller/config//manager?ref=v0.0.1
+- github.com/fluxcd/kustomize-controller/config//crd?ref=v0.0.2
+- github.com/fluxcd/kustomize-controller/config//manager?ref=v0.0.2
+patchesJson6902:
+- target:
+    group: apps
+    version: v1
+    kind: Deployment
+    name: kustomize-controller
+  path: patch.yaml

manifests/bases/kustomize-controller/patch.yaml

@@ -0,0 +1,3 @@
+- op: add
+  path: /spec/template/spec/containers/0/args/0
+  value: --events-addr=http://notification-controller/

manifests/bases/notification-controller/kustomization.yaml

@@ -0,0 +1,5 @@
+apiVersion: kustomize.config.k8s.io/v1beta1
+kind: Kustomization
+resources:
+- github.com/fluxcd/notification-controller/config//crd?ref=v0.0.1-alpha.2
+- github.com/fluxcd/notification-controller/config//manager?ref=v0.0.1-alpha.2

manifests/install/kustomization.yaml

@@ -5,6 +5,7 @@ resources:
   - namespace.yaml
   - ../bases/source-controller
   - ../bases/kustomize-controller
+  - ../bases/notification-controller
   - ../rbac
   - ../policies
 transformers:

manifests/rbac/role.yaml

@@ -9,6 +9,9 @@ rules:
 - apiGroups: ['kustomize.fluxcd.io']
   resources: ['*']
   verbs: ['*']
+- apiGroups: ['notification.fluxcd.io']
+  resources: ['*']
+  verbs: ['*']
 - apiGroups:
   - ""
   resources:

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