Chapter 2. Installing Red Hat OpenShift GitOps

Procedure

1. Open the Administrator perspective of the web console and go to Operators OperatorHub.
2. Search for OpenShift GitOps, click the Red Hat OpenShift GitOps tile, and then click Install.

3. On the Install Operator page:

   1. Select an Update channel.
   2. Select a GitOps Version to install.

   3. Choose an Installed Namespace. The default installation namespace is openshift-gitops-operator.

      Note

      For the GitOps version 1.10 and later, the default namespace changed from openshift-operators to openshift-gitops operator.

   4. Select the Enable Operator recommended cluster monitoring on this Namespace checkbox to enable cluster monitoring.

      Note

      You can enable cluster monitoring on any namespace by applying the openshift.io/cluster-monitoring=true label:

      $ oc label namespace <namespace> openshift.io/cluster-monitoring=true

      Example output:

      namespace/<namespace> labeled

4. Click Install to make the GitOps Operator available on the OpenShift Container Platform cluster.

   Red Hat OpenShift GitOps is installed in all namespaces of the cluster.

5. Verify that the Red Hat OpenShift GitOps Operator is listed in Operators Installed Operators. The Status should resolve to Succeeded.

Procedure

1. Create a openshift-gitops-operator namespace:

   $ oc create ns openshift-gitops-operator

   Example output:

   namespace/openshift-gitops-operator created

   Note

   You can enable cluster monitoring on openshift-gitops-operator, or any namespace, by applying the openshift.io/cluster-monitoring=true label:

   $ oc label namespace <namespace> openshift.io/cluster-monitoring=true

   Example output:

   namespace/<namespace> labeled

2. Create a OperatorGroup object YAML file, for example, gitops-operator-group.yaml:

   Example OperatorGroup:

   apiVersion: operators.coreos.com/v1
   kind: OperatorGroup
   metadata:
     name: openshift-gitops-operator
     namespace: openshift-gitops-operator
   spec:
     upgradeStrategy: Default

3. Apply the OperatorGroup to the cluster:

   $ oc apply -f gitops-operator-group.yaml

   Example output:

   operatorgroup.operators.coreos.com/openshift-gitops-operator created

4. Create a Subscription object YAML file to subscribe a namespace to the Red Hat OpenShift GitOps Operator, for example, openshift-gitops-sub.yaml:

   Example Subscription:

   apiVersion: operators.coreos.com/v1alpha1
   kind: Subscription
   metadata:
     name: openshift-gitops-operator
     namespace: openshift-gitops-operator
   spec:
     channel: latest
     installPlanApproval: Automatic
     name: openshift-gitops-operator
     source: redhat-operators
     sourceNamespace: openshift-marketplace

   where:

   metadata.name

   Specifies the specify the channel name from where you want to subscribe the Operator.

   metadata.namespace

   Specifies the specify the name of the Operator to subscribe to.

   spec.channel

   Specifies the specify the name of the CatalogSource that provides the Operator.

   spec.source (openshift-marketplace namespace)

   Specifies the namespace of the CatalogSource. Use openshift-marketplace for the default OperatorHub CatalogSources.

5. Apply the Subscription to the cluster:

   $ oc apply -f openshift-gitops-sub.yaml

   Example output:

   subscription.operators.coreos.com/openshift-gitops-operator created

6. After the installation is complete, verify that all the pods in the openshift-gitops namespace are running:

   $ oc get pods -n openshift-gitops

   Example output:

   NAME                                                      	  READY   STATUS    RESTARTS   AGE
   cluster-785cfc5f75-669wq                                      1/1     Running   0          76s
   gitops-plugin-6664c749dd-dx64s                                1/1     Running   0          76s
   openshift-gitops-application-controller-0                     1/1     Running   0          74s
   openshift-gitops-applicationset-controller-549d7f6686-wzckt   1/1     Running   0          74s
   openshift-gitops-dex-server-5d4ffdb9b9-lb7b7                  1/1     Running   0          74s
   openshift-gitops-redis-6d65c94d4b-k9l8k                       1/1     Running   0          75s
   openshift-gitops-repo-server-79db854c58-279jr                 1/1     Running   0          75s
   openshift-gitops-server-f488b848-xntbc                        1/1     Running   0          75s

7. Verify that the pods in the openshift-gitops-operator namespace are running:

   $ oc get pods -n openshift-gitops-operator

   Example output:

   NAME                                                            READY   STATUS    RESTARTS   AGE
   openshift-gitops-operator-controller-manager-6fdc5cd9dc-jr9mn   2/2     Running   0          41s

Procedure

1. In the Administrator perspective of the web console, navigate to Operators Installed Operators to verify that the Red Hat OpenShift GitOps Operator is installed.
2. Navigate to the menu OpenShift GitOps Cluster Argo CD. The login page of the Argo CD UI is displayed in a new window.

3. 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.

4. Obtain the password for the Argo CD instance:

   1. Use the navigation panel to go to the Workloads Secrets page.
   2. Use the Project drop-down list and select the namespace where the 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.
5. Use admin as the Username and the copied password as the Password to log in to the Argo CD UI in the new window.