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

Argo Agent : Documentation for installation/configuration of Agent component

XMLWordPrintable

    • Icon: Story Story
    • Resolution: Done
    • Icon: Major Major
    • 1.18.0
    • None
    • None
    • None
    • GitOps Crimson Sprint 19, GitOps Crimson Sprint 20

      Story (Required)

      • As an OpenShift admin, trying to use the agent component on the workload clusters, I want easy to follow instructions in a single document, so that I can follow the steps and install the agent component and get started with the agent based Application management.

      Background and Approach (Required)

      • <Describes the context or background related to this story. Include deeper motivation of user/persona if relevant (5 whys)>
      • <Description of the general technical path on how to achieve the goal of the story. Include details like JSON schema, class definitions.>

      Out of Scope

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

      Approach

      Need a single document for the basic setup and configuration for the agent component which can be included in openshift doc.
      Here are the docs I have been referring to:
      https://github.com/argoproj-labs/argocd-agent/blob/main/docs/hack/quickstart.md
      https://github.com/argoproj-labs/argocd-agent/blob/main/docs/hack/argocd-agent-with-operator.md
      https://github.com/argoproj-labs/argocd-agent/blob/main/hack/dev-env/README.md

      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-ansingh Anand Singh
              rh-ee-anjoseph Anand Francis Joseph
              Votes:
              0 Vote for this issue
              Watchers:
              2 Start watching this issue

                Created:
                Updated:
                Resolved: