Merge pull request #6 from fluxcd/alert-wildcard-selector

Add wildcard support

Author: stefanprodan

config/samples/notification_v1alpha1_alert.yaml

@@ -9,8 +9,6 @@ spec:
   eventSeverity: info
   eventSources:
     - kind: GitRepository
-      name: webapp
+      name: '*'
     - kind: Kustomization
-      name: webapp-frontend
-    - kind: Kustomization
-      name: webapp-backend
+      name: '*'

docs/spec/README.md

@@ -76,7 +76,7 @@ spec:
   eventSeverity: info
   eventSources:
     - kind: GitRepository
-      name: webapp
+      name: '*'
     - kind: Kustomization
       name: webapp-frontend
     - kind: Kustomization

docs/spec/v1alpha1/alert.md

@@ -47,3 +47,47 @@ const (
 	ReadyCondition string = "Ready"
 )
 ```
+
+## Example
+
+```yaml
+apiVersion: notification.fluxcd.io/v1alpha1
+kind: Alert
+metadata:
+  name: webapp
+  namespace: gitops-system
+spec:
+  providerRef: 
+    name: on-call-slack
+  eventSeverity: info
+  eventSources:
+    - kind: GitRepository
+      name: webapp
+    - kind: Kustomization
+      name: webapp-backend
+    - kind: Kustomization
+      name: webapp-frontend
+```
+
+The event severity can be set to `info` or `error`. 
+
+To target all resources of a particular kind in a namespace, you can use the `*` wildcard:
+
+```yaml
+apiVersion: notification.fluxcd.io/v1alpha1
+kind: Alert
+metadata:
+  name: all-kustomizations
+  namespace: gitops-system
+spec:
+  providerRef: 
+    name: dev-msteams
+  eventSeverity: error
+  eventSources:
+    - kind: Kustomization
+      namespace: gitops-system
+      name: '*'
+  suspend: false
+```
+
+If you don't specify an event source namespace, the alert namespace will be used.

docs/spec/v1alpha1/provider.md

@@ -58,3 +58,35 @@ const (
 	ReadyCondition string = "Ready"
 )
 ```
+
+## Example
+
+```yaml
+apiVersion: notification.fluxcd.io/v1alpha1
+kind: Provider
+metadata:
+  name: slack
+  namespace: gitops-system
+spec:
+  type: slack
+  channel: general
+  # webhook address (ignored if secretRef is specified)
+  address: https://hooks.slack.com/services/YOUR/SLACK/WEBHOOK
+  # secret containing the webhook address (optional)
+  secretRef:
+    name: webhook-url
+```
+
+Webhook URL secret:
+
+```sh
+kubectl -n gitops-system create secret generic webhook-url \
+--from-literal=address=https://hooks.slack.com/services/YOUR/SLACK/WEBHOOK
+```
+
+Note that the secret must contain an `address` field.
+
+The provider type can be: `slack`, `msteams`, `rocket`, `discord` or `webhook`. 
+
+When type `webhook` is specified, the notification controller will post the
+incoming [event](event.md) in JSON format to the webhook address. 

internal/server/handlers.go

@@ -73,7 +73,7 @@ func (s *HTTPServer) handleEvent() func(w http.ResponseWriter, r *http.Request)
 				if source.Namespace == "" {
 					source.Namespace = alert.Namespace
 				}
-				if event.InvolvedObject.Name == source.Name &&
+				if (source.Name == "*" || event.InvolvedObject.Name == source.Name) &&
 					event.InvolvedObject.Namespace == source.Namespace &&
 					event.InvolvedObject.Kind == source.Kind {
 					if event.Severity == alert.Spec.EventSeverity ||
@@ -88,7 +88,7 @@ func (s *HTTPServer) handleEvent() func(w http.ResponseWriter, r *http.Request)
 		alertProviders := make([]notifier.Interface, 0)
 		if len(alerts) == 0 {
 			s.logger.Info("Discarding event, no alerts found for the involved object",
-				"object", event.InvolvedObject.Name)
+				"object", event.InvolvedObject.Namespace+"/"+event.InvolvedObject.Name)
 			w.WriteHeader(http.StatusAccepted)
 			return
 		}
@@ -101,7 +101,7 @@ func (s *HTTPServer) handleEvent() func(w http.ResponseWriter, r *http.Request)
 			err = s.kubeClient.Get(ctx, providerName, &provider)
 			if err != nil {
 				s.logger.Error(err, "failed to read provider",
-					"provider", providerName.Name)
+					"provider", providerName)
 				w.WriteHeader(http.StatusBadRequest)
 				return
 			}
@@ -114,7 +114,7 @@ func (s *HTTPServer) handleEvent() func(w http.ResponseWriter, r *http.Request)
 				err = s.kubeClient.Get(ctx, secretName, &secret)
 				if err != nil {
 					s.logger.Error(err, "failed to read secret",
-						"provider", providerName.Name,
+						"provider", providerName,
 						"secret", secretName.Name)
 					w.WriteHeader(http.StatusBadRequest)
 					return
@@ -124,7 +124,7 @@ func (s *HTTPServer) handleEvent() func(w http.ResponseWriter, r *http.Request)
 					webhook = string(address)
 				} else {
 					s.logger.Error(err, "secret does not contain an address",
-						"provider", providerName.Name,
+						"provider", providerName,
 						"secret", secretName.Name)
 					w.WriteHeader(http.StatusBadRequest)
 					return
@@ -133,7 +133,7 @@ func (s *HTTPServer) handleEvent() func(w http.ResponseWriter, r *http.Request)
 
 			if webhook == "" {
 				s.logger.Error(nil, "provider has no address",
-					"provider", providerName.Name)
+					"provider", providerName)
 				w.WriteHeader(http.StatusBadRequest)
 				return
 			}
@@ -142,7 +142,7 @@ func (s *HTTPServer) handleEvent() func(w http.ResponseWriter, r *http.Request)
 			sender, err := factory.Notifier(provider.Spec.Type)
 			if err != nil {
 				s.logger.Error(err, "failed to initialise provider",
-					"provider", providerName.Name,
+					"provider", providerName,
 					"type", provider.Spec.Type)
 				w.WriteHeader(http.StatusBadRequest)
 				return
@@ -151,6 +151,10 @@ func (s *HTTPServer) handleEvent() func(w http.ResponseWriter, r *http.Request)
 			alertProviders = append(alertProviders, sender)
 		}
 
+		s.logger.Info("Dispatching event",
+			"object", event.InvolvedObject.Namespace+"/"+event.InvolvedObject.Name,
+			"message", event.Message)
+
 		// send notifications in the background
 		for _, provider := range alertProviders {
 			go func(p notifier.Interface, e recorder.Event) {