Installing and configuring

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 made available to all namespaces in the cluster.
   2. Select Automatic for the Approval Strategy. This ensures that the future upgrades to the Operator are handled automatically by the Operator Lifecycle Manager (OLM). 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 pipelines-<version> channel is the default channel to install the Red Hat OpenShift Pipelines Operator. For example, the default channel to install the 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.

        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 is installed automatically into the openshift-operators namespace.

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

   Warning

   The success status may 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 all components of the Red Hat OpenShift Pipelines Operator were installed 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.9.2     True

   Copy to Clipboard Toggle word wrap

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

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

   $ oc get tektonpipeline,tektontrigger,tektonaddon,pac

   Copy to Clipboard Toggle word wrap

   Example output

   NAME                                          VERSION   READY   REASON
   tektonpipeline.operator.tekton.dev/pipeline   v0.41.1   True
   NAME                                        VERSION   READY   REASON
   tektontrigger.operator.tekton.dev/trigger   v0.22.2   True
   NAME                                    VERSION   READY   REASON
   tektonaddon.operator.tekton.dev/addon   1.9.2     True
   NAME                                                             VERSION   READY   REASON
   openshiftpipelinesascode.operator.tekton.dev/pipelines-as-code   v0.15.5   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:

   Example Subscription

   apiVersion: operators.coreos.com/v1alpha1
   kind: Subscription
   metadata:
     name: openshift-pipelines-operator
     namespace: openshift-operators
   spec:
     channel:  <channel name> 

   1

   
     name: openshift-pipelines-operator-rh 

   2

   
     source: redhat-operators 

   3

   
     sourceNamespace: openshift-marketplace 

   4

   Copy to Clipboard Toggle word wrap

   1

   The channel name of the Operator. 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.

   2

   Name of the Operator to subscribe to.

   3

   Name of the CatalogSource that provides the Operator.

   4

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

2. Create the Subscription object:

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

Procedure

1. In the Administrator perspective of the web console, navigate to Administration → Custom Resource Definition.
2. Type config.operator.tekton.dev in the Filter by name box to search for the Red Hat OpenShift Pipelines Operator CRs.
3. Click CRD Config to see the Custom Resource Definition Details page.

4. Click the Actions drop-down menu and select Delete Custom Resource Definition.

   Note

   Deleting the CRs will delete the Red Hat OpenShift Pipelines components, and all the tasks and pipelines on the cluster will be lost.

5. Click Delete to confirm the deletion of the CRs.

Procedure

1. From the Operators → OperatorHub page, use the Filter by keyword box to search for the Red Hat OpenShift Pipelines Operator.
2. Click the Red Hat OpenShift Pipelines Operator tile. The Operator tile indicates that the Operator is installed.
3. In the Red Hat OpenShift Pipelines Operator description page, click Uninstall.

Procedure

1. In the Administrator perspective of the web console, navigate to Administration → CustomResourceDefinitions.
2. Use the Search by name box to search for the tektonconfigs.operator.tekton.dev custom resource definition (CRD). Click TektonConfig to see the CRD details page.
3. Click the Instances tab.
4. Click the config instance to see the TektonConfig CR details.
5. Click the YAML tab.

6. Edit the TektonConfig YAML file based on your requirements.

   Example of TektonConfig CR with default values

   apiVersion: operator.tekton.dev/v1alpha1
   kind: TektonConfig
   metadata:
     name: config
   spec:
     pipeline:
       running-in-environment-with-injected-sidecars: true
       metrics.taskrun.duration-type: histogram
       metrics.pipelinerun.duration-type: histogram
       await-sidecar-readiness: true
       params:
         - name: enableMetrics
           value: 'true'
       default-service-account: pipeline
       require-git-ssh-secret-known-hosts: false
       enable-tekton-oci-bundles: false
       metrics.taskrun.level: task
       metrics.pipelinerun.level: pipeline
       embedded-status: both
       enable-api-fields: stable
       enable-provenance-in-status: false
       enable-custom-tasks: true
       disable-creds-init: false
       disable-affinity-assistant: true

   Copy to Clipboard Toggle word wrap