Argo CD instance

Procedure

1. Log in to the OpenShift Container Platform web console.
2. In the Administrator perspective of the web console, click Operators → Installed Operators.
3. Create or select the project where you want to install the user-defined Argo CD instance from the Project list.
4. Select Red Hat OpenShift GitOps from the installed Operators list and click the Argo CD tab.

5. Click Create ArgoCD to configure the parameters:

   1. Enter the Name of the instance. By default, the Name is set to example.

   2. Create an external OS Route to access Argo CD server. Click Server → Route and check Enabled.

      Tip

      You can alternatively configure YAML to create an external OS Route as shown in the following example:

      Example Argo CD with external OS route created

      apiVersion: argoproj.io/v1beta1
      kind: ArgoCD
      metadata:
        name: example
        namespace: openshift-gitops
      spec:
        server:
          route:
            enabled: true

   3. Optional: Modify the route TLS termination policy by configuring the .spec.server.route.tls field of the Argo CD CR.
6. Click Create.
7. Go to Networking → Routes → <instance_name>-server in the project where the user-defined Argo CD instance is installed.
8. On the Details tab, click the Argo CD web UI link under Route details → Location. The Argo CD web UI opens in a separate browser window.

9. Optional: To log in with your OpenShift Container Platform credentials, ensure you are a user of the cluster-admins group and then select the LOG IN VIA OPENSHIFT option in the Argo CD user interface.

   Note

   To be a user of the cluster-admins group, use the oc adm groups new cluster-admins <user> command, where <user> is the default cluster role that you can bind to users and groups cluster-wide or locally.

10. Obtain the password for the user-defined Argo CD instance:

    1. Use the navigation panel to go to the Workloads → Secrets page.
    2. Use the Project list and select the namespace where the user-defined Argo CD instance is created.
    3. Select the <argo_CD_instance_name>-cluster instance to display the password.
    4. On the Details tab, copy the password under Data → admin.password.
11. Use admin as the Username and the copied password as the Password to log in to the Argo CD UI in the new window.

Procedure

1. In the Administrator perspective, navigate to Administration → CustomResourceDefinitions.
2. Find the Subscription CRD and click to open it.
3. Select the Instances tab and click the openshift-gitops-operator subscription.

4. Select the YAML tab and make your customization:

   • Specify the user-defined cluster roles for the CONTROLLER_CLUSTER_ROLE and SERVER_CLUSTER_ROLE environment variables:

     Example Subscription

     apiVersion: operators.coreos.com/v1alpha1
     kind: Subscription
     metadata:
       name: openshift-gitops-operator
       namespace: openshift-gitops-operator
     spec:
       config:
         env:
         - name: CONTROLLER_CLUSTER_ROLE
           value: gitops-controller-role 1
         - name: SERVER_CLUSTER_ROLE
           value: gitops-server-role 2

     1

     The name of the environment variable for the Argo CD Application Controller component.

     2

     The name of the environment variable for the Argo CD server component.

Procedure

1. In the Administrator perspective, navigate to Administration → CustomResourceDefinitions.
2. Find the Subscription CRD and click to open it.
3. Select the Instances tab and click the openshift-gitops-operator subscription.

4. Select the YAML tab and make your customization:

   • To enable or disable the Argo CD console link, edit the value of DISABLE_DEFAULT_ARGOCD_CONSOLELINK as needed:

     apiVersion: operators.coreos.com/v1alpha1
     kind: Subscription
     metadata:
       name: openshift-gitops-operator
     spec:
       config:
         env:
         - name: DISABLE_DEFAULT_ARGOCD_CONSOLELINK
           value: 'true'

1. Navigate to the Operators → Installed Operators page.
2. From the list of Installed Operators, select the Red Hat OpenShift GitOps Operator, and then click on the ArgoCD tab.
3. Select the Argo CD instance name you want to enable notifications. For example, openshift-gitops.

4. Click on the YAML tab, and then edit and set the spec.notifications.enabled parameter to true:

   Example

   apiVersion: argoproj.io/v1beta1
   kind: ArgoCD
   metadata:
     name: openshift-gitops
   spec:
     notifications:
       enabled: true
   #....

5. Click Save.