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

Document missing image-updater command flags

XMLWordPrintable

    • GitOps Tangerine Sprint 16

      Story (Required)

      As described in the GitHub issue:

      https://argocd-image-updater.readthedocs.io/en/latest/install/reference/ documents all command flags. Some command flags are currently not included, for ex, {}argocd-namespace{-}{}, -warmup-cache.

      Will need to compare it with the help message produced by argocd-image-updater run -h, and update accordingly.

      https://github.com/argoproj-labs/argocd-image-updater/issues/1130

       

      This will improve user experience by ensuring information is accurate and consistent across various documentation. 

      After discussion, we decided to also document the rest of the commands which caused there to be some reorganization of the documentation for the CLI reference. 

      Background and Approach (Required)

      • Will compare with the programs help command and then update the documentation accordingly.

      Out of Scope

      • <Defines what is not included in this story.>

      Dependencies

      • <Describes what this story depends on. Dependent stories and EPICs should be linked to the story.>

      Acceptance Criteria (Mandatory)

      • <Describe edge cases to consider when implementing the story and defining tests.>
      • <Provides a required and minimum list of acceptance tests for this story. More is expected as the engineer implements this story.>

      Definition of Done

      • Code Complete:
        • All code has been written, reviewed, and approved.
      • Tested:
        • Unit tests have been written and passed.
        • Ensure code coverage is not reduced with the changes.
        • Integration tests have been automated.
        • System tests have been conducted, and all critical bugs have been fixed.
        • Tested and merged on OpenShift either upstream or downstream on a local build.
      • Documentation:
        • User documentation or release notes have been written (if applicable).
      • Build:
        • Code has been successfully built and integrated into the main repository / project.
        • Midstream changes (if applicable) are done, reviewed, approved and merged.
      • Review:
        • Code has been peer-reviewed and meets coding standards.
        • All acceptance criteria defined in the user story have been met.
        • Tested by reviewer on OpenShift.
      • Deployment:
        • The feature has been deployed on OpenShift cluster for testing.

              rh-ee-ccoco Christopher Coco (Inactive)
              rh-ee-ccoco Christopher Coco (Inactive)
              Votes:
              0 Vote for this issue
              Watchers:
              1 Start watching this issue

                Created:
                Updated:
                Resolved: