Chapter 1. Installing OpenShift Pipelines

Procedure

1. In the Administrator perspective of the web console, navigate to Operators OperatorHub.
2. Use the Filter by keyword box to search for Red Hat OpenShift Pipelines Operator in the catalog. Click the Red Hat OpenShift Pipelines Operator tile.
3. Read the brief description about the Operator on the Red Hat OpenShift Pipelines Operator page. Click Install.

4. On the Install Operator page:

   1. Select All namespaces on the cluster (default) for the Installation Mode. This mode installs the Operator in the default openshift-operators namespace, which enables the Operator to watch and be available to all namespaces in the cluster.
   2. Select Automatic for the Approval Strategy. This ensures that the Operator Lifecycle Manager (OLM) automatically handles future upgrades to the Operator. If you select the Manual approval strategy, OLM creates an update request. As a cluster administrator, you must then manually approve the OLM update request to update the Operator to the new version.

   3. Select an Update Channel.

      • The latest channel enables installation of the most recent stable version of the Red Hat OpenShift Pipelines Operator. Currently, it is the default channel for installing the Red Hat OpenShift Pipelines Operator.

      • To install a specific version of the Red Hat OpenShift Pipelines Operator, cluster administrators can use the corresponding pipelines-<version> channel. For example, to install the Red Hat OpenShift Pipelines Operator version 1.8.x, you can use the pipelines-1.8 channel.

        Note

        Starting with OpenShift Container Platform 4.11, the preview and stable channels for installing and upgrading the Red Hat OpenShift Pipelines Operator are not available. However, in OpenShift Container Platform 4.10 and earlier versions, you can use the preview and stable channels for installing and upgrading the Operator.

5. Click Install. You will see the Operator listed on the Installed Operators page.

   Note

   The Operator installs automatically into the openshift-operators namespace.

6. Verify that the Status displays Succeeded Up to date to confirm successful installation of Red Hat OpenShift Pipelines Operator.

   Warning

   The success status might show as Succeeded Up to date even if installation of other components is in-progress. Therefore, it is important to verify the installation manually in the terminal.

7. Verify that the Red Hat OpenShift Pipelines Operator installed all components successfully. Login to the cluster on the terminal, and run the following command:

   $ oc get tektonconfig config

   Copy to Clipboard Toggle word wrap

   Example output

   NAME     VERSION                          READY   REASON
   config   1.20.0     True

   Copy to Clipboard Toggle word wrap

   If the READY condition is True, the Operator and its components installed successfully.

   Additionally, check the components' versions by running the following command:

   $ oc get tektonpipeline,tektontrigger,tektonchain,tektonaddon,pac

   Copy to Clipboard Toggle word wrap

   Example output

   NAME                                                             VERSION   READY   REASON
   tektonpipeline.operator.tekton.dev/pipeline                      v0.47.0   True
   
   NAME                                                             VERSION   READY   REASON
   tektontrigger.operator.tekton.dev/trigger                        v0.23.1   True
   
   NAME                                                             VERSION   READY   REASON
   tektonchain.operator.tekton.dev/chain                            v0.16.0   True
   
   NAME                                                             VERSION   READY   REASON
   tektonaddon.operator.tekton.dev/addon                            1.11.0     True
   
   NAME                                                             VERSION   READY   REASON
   openshiftpipelinesascode.operator.tekton.dev/pipelines-as-code   v0.19.0   True

   Copy to Clipboard Toggle word wrap

Procedure

1. Create a Subscription object YAML file to subscribe a namespace to the Red Hat OpenShift Pipelines Operator, for example, sub.yaml:

   apiVersion: operators.coreos.com/v1alpha1
   kind: Subscription
   metadata:
     name: openshift-pipelines-operator
     namespace: openshift-operators
   spec:
     channel:  <channel_name>
     name: openshift-pipelines-operator-rh
     source: redhat-operators
     sourceNamespace: openshift-marketplace

   Copy to Clipboard Toggle word wrap

   spec.channel

   Name of the channel that you want to subscribe. The pipelines-<version> channel is the default channel. For example, the default channel for Red Hat OpenShift Pipelines Operator version 1.7 is pipelines-1.7. The latest channel enables installation of the most recent stable version of the Red Hat OpenShift Pipelines Operator.

   spec.name

   Name of the Operator to subscribe to.

   spec.source

   Name of the CatalogSource object that provides the Operator.

   spec.sourceNamespace

   Namespace of the CatalogSource object. Use openshift-marketplace for the default OperatorHub catalog sources.

2. Create the Subscription object by running the following command:

   $ oc apply -f sub.yaml

   Copy to Clipboard Toggle word wrap

   The subscription installs the Red Hat OpenShift Pipelines Operator into the openshift-operators namespace. The Operator automatically installs OpenShift Pipelines into the default openshift-pipelines target namespace.