Chapter 2. Argo CD custom resource and component properties

Procedure

1. In the Administrator perspective of the OpenShift Container Platform web console, expand Operators Installed Operators.
2. From the list of Installed Operators, select the Red Hat OpenShift GitOps Operator, and then click on the NotificationsConfiguration tab.
3. On the NotificationsConfigurations page, click default-notifications-configuration.

4. On the default-notifications-configuration page, click YAML and add the configuration for any supported resources such as templates, triggers, services, and subscriptions. For example, under templates in the code, add the following sample configuration:

   Example template configuration:

     template.my-custom-template: |
       message: |
       Application details: {{.context.argocdUrl}}/applications/{{.app.metadata.name}}.

5. Click Save.

6. Verify that the configuration changes made in the NotificationsConfiguration CR are reflected in the argocd-notifications-cm config map:

   1. Go to Workloads ConfigMaps.
   2. Click argocd-notifications-cm and select the YAML tab.
   3. Scroll through the page in the YAML tab to verify the sample configuration added for the supported resources.

Procedure

1. Edit the default NotificationsConfiguration CR in the cluster by running the following command:

   $ oc edit notificationsconfiguration default-notifications-configuration -n <namespace>

   where:

   default-notifications-configuration

   Specifies the name of the default NotificationsConfiguration CR.

   <namespace>

   Specifies the name of the namespace.

2. Under the templates section of the CR, add a configuration similar to the following example:

   Example template configuration:

     template.my-custom-template: |
       message: |
       Application details: {{.context.argocdUrl}}/applications/{{.app.metadata.name}}.

3. Verify the contents of the argocd-notifications-cm config map by running the following command:

   $ oc edit cm argocd-notifications-cm -n <namespace>

   The changes made in the existing configuration of the NotificationsConfiguration CR are reflected in the argocd-notifications-cm config map.

Procedure

1. Log in to the OpenShift Container Platform web console.

2. In the Administrator perspective of the web console, click Operators Installed Operators.

   • In the Project list, create or select the project where you want to install the user-defined Argo CD instance.
3. Select Red Hat OpenShift GitOps from the installed Operators list and click the Argo CD tab.

4. To create two Argo CD instances, click Create ArgoCD and create two YAML files similar to the following examples:

   Example first Argo CD instance with an annotation label:

   apiVersion: argoproj.io/v1beta1
   kind: ArgoCD
   metadata:
     name: argocd-instance-demo-1
     namespace: argocd-test-demo-1
   spec:
     installationID: "instance-demo-1"
     resourceTrackingMethod: "annotation+label"

   where:

   metadata.name

   Specifies the name of the first Argo CD instance.

   metadata.namespace

   Specifies the namespace used for the first Argo CD instance.

   spec.installationID

   Specifies the name of the installationID object for the first Argo CD instance.

   Example second Argo CD instance with an annotation label:

   apiVersion: argoproj.io/v1beta1
   kind: ArgoCD
   metadata:
     name: argocd-instance-demo-2
     namespace: argocd-test-demo-2
   spec:
     installationID: "instance-demo-2"
     resourceTrackingMethod: "annotation+label"

   where:

   metadata.name

   Specifies the name of the second Argo CD instance.

   metadata.namespace

   Specifies the namespace used for the second Argo CD instance.

   spec.installationID

   Specifies the name of the installationID object for the second Argo CD instance.

5. Configure and label target namespaces to associate namespaces with their Argo CD instances.

   1. Navigate to Administration Namespaces.
   2. Create namespaces for application deployments, app-ns-1 and app-ns-2.

   3. Associate each namespace with their respective Argo CD instance:

      1. Associate the app-ns-1 namespace with the argocd-test-demo-1 Argo CD instance by running the following command:

         Example command:

         $ oc label namespace app-ns-1 argocd.argoproj.io/managed-by=argocd-test-demo-1

      2. Associate the app-ns-2 namespace with the argocd-test-demo-2 Argo CD instance by running the following command:

         Example command:

         $ oc label namespace app-ns-2 argocd.argoproj.io/managed-by=argocd-test-demo-2

6. Create two applications in Argo CD.

   1. In the OpenShift Container Platform web console, go to Operators Installed Operators OpenShift GitOps Operator.
   2. Select Argo CD and navigate to the Applications tab.
   3. Click Create Application.

   4. Enter the following YAML snippet to create two applications in Argo CD.

      Example first application using Argo CD:

      apiVersion: argoproj.io/v1alpha1
      kind: Application
      metadata:
        name: sprint-petclinic
        namespace: argocd-test-demo-1
      spec:
        project: default
        source:
          repoURL: https://github.com/redhat-developer/gitops-operator
          path: test/examples/nginx
          targetRevision: HEAD
        destination:
          server: https://kubernetes.default.svc
          namespace: app-ns-1
        syncPolicy:
          automated: {}

      where:

      metadata.name

      Specifies the name of the first application.

      metadata.namespace

      Specifies the namespace used for the first application.

      Example second application using Argo CD:

      apiVersion: argoproj.io/v1alpha1
      kind: Application
      metadata:
        name: sprint-petclinic
        namespace: argocd-test-demo-2
      spec:
        project: default
        source:
          repoURL: https://github.com/redhat-developer/gitops-operator
          path: test/examples/nginx
          targetRevision: HEAD
        destination:
          server: https://kubernetes.default.svc
          namespace: app-ns-2
        syncPolicy:
          automated: {}

      where:

      metadata.name

      Specifies the name of the second application that is created with the same name as the first application.

      metadata.namespace

      Specifies the namespace used for the second application.

Verification

1. Navigate to Workloads Pods in the OpenShift Container Platform web console.
2. Ensure that the pods for Argo CD instances argocd-instance-demo-1 and argocd-instance-demo-2 are running.
3. Check the application synchronization status in the Argo CD Applications YAML tab.
4. Navigate to the argocd-cm config map in argocd-test-demo-1 and argocd-test-demo-2 namespaces and verify that the installationID object is configured successfully.