Uploaded image for project: 'Helm'
  1. Helm
  2. HELM-451

Modify List Releases endpoint to return all kind of releases

XMLWordPrintable

    • Icon: Story Story
    • Resolution: Done
    • Icon: Undefined Undefined
    • None
    • None
    • Helm
    • AppSvc Sprint 228

      Owner: Architect:

      Kartikey Mamgain

      Story (Required)

      As an OpenShift user i  should be able to list releases which are pending-install, failed state and not just deployed releases. Currently the list releases endpoint returns only deployed releases but the endpoint can be modified to return releases of all kinds.

      Background (Required)

      Helm ODC frontend makes call to the helm backend and waits for the install call to finish. We would be modifying the install/upgrade endpoint to return the secret name while installation proceeds asynchronously. In order to show status of a release in pending-install state endpoint api/helm/releases GET endpoint has to be modified.

      Glossary

      <List of new terms and definition used in this story>

      Out of scope

      Frontend Changes

      In Scope

      Backend code changes

      • Unit Test on actions package and handlers
      • api change on list release endpoint

       

      Approach(Required)

      In order to list releases other than deployed state we can modify the StateMask on list releases action. By default the state mask is pointed to `ListDeployed | ListFailed` state. In order to show the pending-install releases we should point the flag for list releases to ListAll StateMask. The ListAll constant holds the following states:
      ListDeployed | ListUninstalled | ListUninstalling | ListPendingInstall | ListPendingRollback | ListPendingUpgrade | ListSuperseded | ListFailed.
      Existing unit test need to be modified for list releases endpoint.

      Demo requirements(Required)

      None

      Dependencies

      None

      Edge Case

      _<Describe edge cases to consider when implementing the story and defining
      tests>_

      Acceptance Criteria

      • We should be able to list releases which are in pending-install state. Try to install https://artifacthub.io/packages/helm/gitlab/gitlab/6.5.4 Helm chart which takes over a few minutes to install. The status for this release should be returned as Pending-Install.
      • The release should be moving to the deployed state from pending-install state.
      • We should be able to demo the above mentioned scenario of a release changing getting listed as Pending install and moving to the deployed state. We can use gitlab Helm Chart for reference.
      • Verify the changes with oc helm plugin.

      Development:Yes

      QE:
      Documentation: No

      Upstream:Not
      Applicable

      Downstream:  Not
      Applicable

      Release Notes Type: <New Feature/Enhancement/Known Issue/Bug
      fix/Breaking change/Deprecated Functionality/Technology Preview>

      INVEST Checklist

      Dependencies identified

      Blockers noted and expected delivery timelines set

      Design is implementable

      Acceptance criteria agreed upon

      Story estimated

      v

      Legend

      Unknown

      Verified

      Unsatisfied

            kmamgain@redhat.com Kartikey Mamgain
            kmamgain@redhat.com Kartikey Mamgain
            Votes:
            0 Vote for this issue
            Watchers:
            1 Start watching this issue

              Created:
              Updated:
              Resolved: