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

Implement the SSO package

XMLWordPrintable

    • Icon: Story Story
    • Resolution: Obsolete
    • Icon: Major Major
    • None
    • None
    • Operator
    • None
    • 8
    • False
    • Hide

      None

      Show
      None
    • False
    • GITOPS Sprint 3245, GITOPS Sprint 3246, GITOPS Sprint 3253, GITOPS Sprint 3254, GitOps Crimson - Sprint 3260

      Story (Required)

      The purpose of this story is to implement the new SSO package. We need it because it will bring the SSO code into alignment with the described operator redesign. This story will represent the end-to-end effort involved in writing the SSO package, including unit tests and kuttl tests (potentially)

      Background (Required)

      The idea behind this story is to create a self-contained sub-controller package for SSO, that can be developed independently of the rest of the operator codebase. This package will be built upon the dex and keycloak packages. This package should provide an abstraction towards the underlying SSO implementation (dex vs keycloak vs any others in the fiuture) that is present within the operator. This story captures the end-to-end effort in setting up the new SSO abstraction layer, this includes unit and e2e tests

      Out of scope

      implementation of dex or keycloak packages

      Approach (Required)

      • set-up SSO sub-controller with apt sso-controller log context
      • consolidate helper functions related to controller resources into appropriate util.go/resource file
      • Set up apt functions to determine which SSO provider to invoke and plug the appropriate reconciler into SSOReconciler
      • Set up functions to initiate proper teardown of resources when switching between providers 

      Use best practices outlined in design doc to make error handling & logging decisions 

      Dependencies

      https://issues.redhat.com/browse/GITOPS-3117

      https://issues.redhat.com/browse/GITOPS-3118

      https://issues.redhat.com/browse/GITOPS-3119

      https://issues.redhat.com/browse/GITOPS-3120

      https://issues.redhat.com/browse/GITOPS-3121

      https://issues.redhat.com/browse/GITOPS-3122

      Acceptance Criteria (Mandatory)

      • SSO package is implemented end-to-end
      • unit tests added for each function
      • kuttl tests added for SSO specific scenarios that don't involve other controllers

      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

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

                Created:
                Updated:
                Resolved: