Story (Required)

• As an OpenShift GitOps Admin user, I want to install Argo CD components that run along with the Argo CD agent component on the remote (spoke) OCP/OKC cluster, so that I can enable remote syncing of application resources via the Argo CD agent component from the central hub cluster.

Background and Approach (Required)

Verify if the steps documented works as expected. If not correct the installation steps and provide the updated steps as a document in the upstream project.
Step 1 : Create the required namespaces

oc create ns openshift-gitops-operator
oc create ns openshift-gitops-argocd-agent

Step 2: Create the Operator Group

oc apply -f <<EOF
  apiVersion: operators.coreos.com/v1alpha2
  kind: OperatorGroup
  metadata:
    name: gitops-operator-group
    namespace: openshift-gitops-operator
  spec:
    targetNamespaces:
    - openshift-gitops-argocd-agent
EOF

Step 3: Create the Subscription object via CLI

oc apply -f <<EOF
  apiVersion: operators.coreos.com/v1alpha1
  kind: Subscription
  metadata:
    name: openshift-gitops-operator
    namespace: openshift-gitops-operator
  spec:
    config:
      env:
        - name: DISABLE_DEFAULT_ARGOCD_INSTANCE
          value: "true"
    channel: stable
    installPlanApproval: Automatic
    name: openshift-gitops-operator
    source: redhat-operators
    sourceNamespace: openshift-marketplace
EOF

Step 4: Create the Argo CD Instance

oc apply -f <<EOF
apiVersion: argoproj.io/v1beta1
kind: ArgoCD
metadata:
  name: argocd-agent
  namespace: openshift-gitops-argocd-agent
spec:
  controller: 
    enabled: true
  repoServer:
    enabled: false
  applicationSet:
    enabled: false
  redis:
    enabled: false
  server:
    enabled: false
  notifications:
    enabled: false
EOF

Out of Scope

• This story covers only OpenShift compatible clusters (OCP/OKD, ROSA, ARO). For other kubernetes based clusters (xKS), which does not have an Operator Hub, it is advised to use the upstream Argo CD helm chart for the installation.

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.