feat: Introduce a new CR for managing Notifications Configuration

api/v1alpha1/notificationsconfiguration_types.go

@@ -0,0 +1,66 @@
+/*
+Copyright 2021.
+
+Licensed under the Apache License, Version 2.0 (the "License");
+you may not use this file except in compliance with the License.
+You may obtain a copy of the License at
+
+    http://www.apache.org/licenses/LICENSE-2.0
+
+Unless required by applicable law or agreed to in writing, software
+distributed under the License is distributed on an "AS IS" BASIS,
+WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+See the License for the specific language governing permissions and
+limitations under the License.
+*/
+
+package v1alpha1
+
+import metav1 "k8s.io/apimachinery/pkg/apis/meta/v1"
+
+func init() {
+	SchemeBuilder.Register(&NotificationsConfiguration{}, &NotificationsConfigurationList{})
+}
+
+//+kubebuilder:object:root=true
+
+// NotificationsConfiguration is the Schema for the NotificationsConfiguration API
+// +k8s:openapi-gen=true
+// +kubebuilder:subresource:status
+// +operator-sdk:csv:customresourcedefinitions:resources={{NotificationsConfiguration,v1beta1,""}}
+// +operator-sdk:csv:customresourcedefinitions:resources={{ConfigMap,v1,""}}
+type NotificationsConfiguration struct {
+	metav1.TypeMeta   `json:",inline"`
+	metav1.ObjectMeta `json:"metadata,omitempty"`
+
+	Spec   NotificationsConfigurationSpec   `json:"spec,omitempty"`
+	Status NotificationsConfigurationStatus `json:"status,omitempty"`
+}
+
+//+kubebuilder:object:root=true
+
+// NotificationsConfigurationList contains a list of NotificationsConfiguration
+type NotificationsConfigurationList struct {
+	metav1.TypeMeta `json:",inline"`
+	metav1.ListMeta `json:"metadata,omitempty"`
+	Items           []NotificationsConfiguration `json:"items"`
+}
+
+// NotificationsConfigurationSpec allows users to define the triggers, templates, services, context and
+// subscriptions for the notifications
+type NotificationsConfigurationSpec struct {
+	// Triggers define the condition when the notification should be sent and list of templates required to generate the message
+	// Recipients can subscribe to the trigger and specify the required message template and destination notification service.
+	Triggers map[string]string `json:"triggers,omitempty"`
+	// Templates are used to generate the notification template message
+	Templates map[string]string `json:"templates,omitempty"`
+	// Services are used to deliver message
+	Services map[string]string `json:"services,omitempty"`
+	// Subscriptions contain centrally managed global application subscriptions
+	Subscriptions map[string]string `json:"subscriptions,omitempty"`
+}
+
+// NotificationsConfigurationStatus defines the observed state of NotificationsConfiguration
+type NotificationsConfigurationStatus struct {
+	NotificationsConfiguration string `json:"notificationsconfiguration,omitempty"`
+}

bundle/manifests/argocd-operator.clusterserviceversion.yaml

@@ -1507,6 +1507,93 @@ spec:
         x-descriptors:
         - urn:alm:descriptor:com.tectonic.ui:text
       version: v1beta1
+    - description: NotificationsConfiguration is the Schema for the notificationsconfiguration
+        API
+      displayName: NotificationsConfiguration
+      kind: NotificationsConfiguration
+      name: notificationsconfigurations.argoproj.io
+      resources:
+      - kind: ArgoCD
+        name: ""
+        version: v1alpha1
+      - kind: ArgoCDExport
+        name: ""
+        version: v1alpha1
+      - kind: NotificationsConfiguration
+        name: ""
+        version: v1alpha1
+      - kind: ConfigMap
+        name: ""
+        version: v1
+      - kind: CronJob
+        name: ""
+        version: v1
+      - kind: Deployment
+        name: ""
+        version: v1
+      - kind: Ingress
+        name: ""
+        version: v1
+      - kind: Job
+        name: ""
+        version: v1
+      - kind: PersistentVolumeClaim
+        name: ""
+        version: v1
+      - kind: Pod
+        name: ""
+        version: v1
+      - kind: Prometheus
+        name: ""
+        version: v1
+      - kind: ReplicaSet
+        name: ""
+        version: v1
+      - kind: Route
+        name: ""
+        version: v1
+      - kind: Secret
+        name: ""
+        version: v1
+      - kind: Service
+        name: ""
+        version: v1
+      - kind: ServiceMonitor
+        name: ""
+        version: v1
+      - kind: StatefulSet
+        name: ""
+        version: v1
+      specDescriptors:
+      - description: Argocd is the name of the ArgoCD instance to export.
+        displayName: ArgoCD
+        path: argocd
+        x-descriptors:
+        - urn:alm:descriptor:com.tectonic.ui:text
+      - description: Schedule in Cron format, see https://en.wikipedia.org/wiki/Cron.
+        displayName: Schedule
+        path: schedule
+        x-descriptors:
+        - urn:alm:descriptor:com.tectonic.ui:text
+      - description: Storage defines the storage configuration options.
+        displayName: Storage
+        path: storage
+      statusDescriptors:
+      - description: 'Phase is a simple, high-level summary of where the ArgoCDExport
+          is in its lifecycle. There are five possible phase values: Pending: The
+          ArgoCDExport has been accepted by the Kubernetes system, but one or more
+          of the required resources have not been created. Running: All of the containers
+          for the ArgoCDExport are still running, or in the process of starting or
+          restarting. Succeeded: All containers for the ArgoCDExport have terminated
+          in success, and will not be restarted. Failed: At least one container has
+          terminated in failure, either exited with non-zero status or was terminated
+          by the system. Unknown: For some reason the state of the ArgoCDExport could
+          not be obtained.'
+        displayName: Phase
+        path: phase
+        x-descriptors:
+        - urn:alm:descriptor:com.tectonic.ui:text
+      version: v1alpha1
   description: |
     ## Overview
 
@@ -1561,6 +1648,18 @@ spec:
     spec:
       clusterPermissions:
       - rules:
+        - apiGroups:
+          - ""
+          resources:
+          - configmaps
+          verbs:
+          - create
+          - delete
+          - get
+          - list
+          - patch
+          - update
+          - watch
         - apiGroups:
           - ""
           resources:

bundle/manifests/argoproj.io_notificationsconfigurations.yaml

@@ -0,0 +1,82 @@
+apiVersion: apiextensions.k8s.io/v1
+kind: CustomResourceDefinition
+metadata:
+  annotations:
+    controller-gen.kubebuilder.io/version: v0.6.1
+  creationTimestamp: null
+  name: notificationsconfigurations.argoproj.io
+spec:
+  group: argoproj.io
+  names:
+    kind: NotificationsConfiguration
+    listKind: NotificationsConfigurationList
+    plural: notificationsconfigurations
+    singular: notificationsconfiguration
+  scope: Namespaced
+  versions:
+  - name: v1alpha1
+    schema:
+      openAPIV3Schema:
+        description: NotificationsConfiguration is the Schema for the NotificationsConfiguration
+          API
+        properties:
+          apiVersion:
+            description: 'APIVersion defines the versioned schema of this representation
+              of an object. Servers should convert recognized schemas to the latest
+              internal value, and may reject unrecognized values. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#resources'
+            type: string
+          kind:
+            description: 'Kind is a string value representing the REST resource this
+              object represents. Servers may infer this from the endpoint the client
+              submits requests to. Cannot be updated. In CamelCase. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds'
+            type: string
+          metadata:
+            type: object
+          spec:
+            description: NotificationsConfigurationSpec allows users to define the
+              triggers, templates, services, context and subscriptions for the notifications
+            properties:
+              services:
+                additionalProperties:
+                  type: string
+                description: Services are used to deliver message
+                type: object
+              subscriptions:
+                additionalProperties:
+                  type: string
+                description: Subscriptions contain centrally managed global application
+                  subscriptions
+                type: object
+              templates:
+                additionalProperties:
+                  type: string
+                description: Templates are used to generate the notification template
+                  message
+                type: object
+              triggers:
+                additionalProperties:
+                  type: string
+                description: Triggers define the condition when the notification should
+                  be sent and list of templates required to generate the message Recipients
+                  can subscribe to the trigger and specify the required message template
+                  and destination notification service.
+                type: object
+            type: object
+          status:
+            description: NotificationsConfigurationStatus defines the observed state
+              of NotificationsConfiguration
+            properties:
+              notificationsconfiguration:
+                type: string
+            type: object
+        type: object
+    served: true
+    storage: true
+    subresources:
+      status: {}
+status:
+  acceptedNames:
+    kind: ""
+    plural: ""
+  conditions: []
+  storedVersions: []