Uploaded image for project: 'OpenShift GitOps'
  1. OpenShift GitOps
  2. GITOPS-4130

Implement new custom resource for Notifications configuration

    XMLWordPrintable

Details

    • 8
    • False
    • None
    • False
    • Hide
      With this update, users will be able to set their notifications configuration in a dedicated `NotificationsConfiguration` custom resource. This mechanism replaces the pre-GA workflow to achieve this, which involved editing the `argocd-notifications-cm` config map manually. Users can now set their triggers and templates, among other settings, as first class fields in the new custom resource, which will be managed by the OpenShift GitOps operator.
      Show
      With this update, users will be able to set their notifications configuration in a dedicated `NotificationsConfiguration` custom resource. This mechanism replaces the pre-GA workflow to achieve this, which involved editing the `argocd-notifications-cm` config map manually. Users can now set their triggers and templates, among other settings, as first class fields in the new custom resource, which will be managed by the OpenShift GitOps operator.
    • GITOPS Sprint 3253

    Description

      Story (Required)

      As a user of OpenShift GitOps wanting to use GA notifications, I want to be able to configure my triggers and templates in a first class way through a strongly typed custom resource rather than editing a configmap

       

      Background (Required)

      see https://issues.redhat.com/browse/GITOPS-2304 for details on background

      Out of scope

      <Defines what is not included in this story>

      Approach (Required)

      • Design and implement a new API for notifications configuration. Should include triggers, templates, services and any other configuration currently provided by the argocd-notifications-cm
      • Implement a new notifications-configuration controller to watch the new CR
      • For fresh installations, whenever notifications is enabled, ArgoCD controller creates a new notifications configuration CR in the same namespace
      • New controller updates the notifications-cm whenever the CR is updated

      Dependencies

      none

      Acceptance Criteria (Mandatory)

      • New CRD designed and implemented
      • New controller implemented
      • Unit/e2e tests
      • updated documentation 

      INVEST Checklist

      Dependencies identified

      Blockers noted and expected delivery timelines set

      Design is implementable

      Acceptance criteria agreed upon

      Story estimated

      Legend

      Unknown

      Verified

      Unsatisfied

      Done Checklist

      • Code is completed, reviewed, documented and checked in
      • Unit and integration test automation have been delivered and running cleanly in continuous integration/staging/canary environment
      • Continuous Delivery pipeline(s) is able to proceed with new code included
      • Customer facing documentation, API docs etc. are produced/updated, reviewed and published
      • Acceptance criteria are met

      Attachments

        Issue Links

          Activity

            People

              aveerama@redhat.com Abhishek Veeramalla
              jrao@redhat.com Jaideep Rao
              Votes:
              0 Vote for this issue
              Watchers:
              5 Start watching this issue

              Dates

                Created:
                Updated:
                Resolved: