$ oc get tektonconfig config
This guide walks cluster administrators through the process of installing the Red Hat OpenShift Pipelines Operator to an OpenShift Container Platform cluster.
You have access to an OpenShift Container Platform cluster using an account with
You have installed
You have installed OpenShift Pipelines (
tkn) CLI on your local system.
Your cluster has the Marketplace capability enabled or the Red Hat Operator catalog source configured manually.
You can install Red Hat OpenShift Pipelines using the Operator listed in the OpenShift Container Platform OperatorHub. When you install the Red Hat OpenShift Pipelines Operator, the custom resources (CRs) required for the pipelines configuration are automatically installed along with the Operator.
The default Operator custom resource definition (CRD)
config.operator.tekton.dev is now replaced by
tektonconfigs.operator.tekton.dev. In addition, the Operator provides the following additional CRDs to individually manage OpenShift Pipelines components:
If you have OpenShift Pipelines already installed on your cluster, the existing installation is seamlessly upgraded. The Operator will replace the instance of
config.operator.tekton.dev on your cluster with an instance of
tektonconfigs.operator.tekton.dev and additional objects of the other CRDs as necessary.
If you manually changed your existing installation, such as, changing the target namespace in the
The Red Hat OpenShift Pipelines Operator now provides the option to choose the components that you want to install by specifying profiles as part of the
TektonConfig custom resource (CR). The
TektonConfig CR is automatically installed when the Operator is installed.
The supported profiles are:
Lite: This installs only Tekton Pipelines.
Basic: This installs Tekton Pipelines, Tekton Triggers, and Tekton Chains.
All: This is the default profile used when the
TektonConfig CR is installed. This profile installs all of the Tekton components, including Tekton Pipelines, Tekton Triggers, Tekton Chains, Pipelines as Code, and Tekton Addons. Tekton Addons includes the
In the Administrator perspective of the web console, navigate to Operators → OperatorHub.
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.
Read the brief description about the Operator on the Red Hat OpenShift Pipelines Operator page. Click Install.
On the Install Operator page:
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.
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.
Select an Update Channel.
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
Starting with OpenShift Container Platform 4.11, the
Click Install. You will see the Operator listed on the Installed Operators page.
The Operator is installed automatically into the
Verify that the Status is set to Succeeded Up to date to confirm successful installation of Red Hat OpenShift Pipelines Operator.
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.
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
NAME VERSION READY REASON config 1.11.0 True
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,tektonchain,tektonaddon,pac
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
You can install Red Hat OpenShift Pipelines Operator from the OperatorHub using the CLI.
Create a Subscription object YAML file to subscribe a namespace to the Red Hat OpenShift Pipelines Operator,
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)
|1||The channel name of the Operator. The
|2||Name of the Operator to subscribe to.|
|3||Name of the CatalogSource that provides the Operator.|
|4||Namespace of the CatalogSource. Use
Create the Subscription object:
$ oc apply -f sub.yaml
The Red Hat OpenShift Pipelines Operator is now installed in the default target namespace
The Red Hat OpenShift Pipelines Operator enables support for installation of pipelines in a restricted network environment.
The Operator installs a proxy webhook that sets the proxy environment variables in the containers of the pod created by tekton-controllers based on the
cluster proxy object. It also sets the proxy environment variables in the
Operator Proxy Webhook resources.
By default, the proxy webhook is disabled for the
openshift-pipelines namespace. To disable it for any other namespace, you can add the
operator.tekton.dev/disable-proxy: true label to the
You can modify the fields under the
.spec.pipeline.performance parameter in the
TektonConfig custom resource (CR) to change high availability (HA) support and performance configuration for the OpenShift Pipelines controller.
apiVersion: operator.tekton.dev/v1alpha1 kind: TektonConfig metadata: name: config spec: pipeline: performance: disable-ha: false buckets: 1 threads-per-controller: 2 kube-api-qps: 5.0 kube-api-burst: 10
The fields are optional. If you set them, the Red Hat OpenShift Pipelines Operator includes most of the fields as arguments in the
openshift-pipelines-controller deployment under the
openshift-pipelines-controller container. The OpenShift Pipelines Operator also updates the
buckets field in the
config-leader-election configuration map under the
If you do not specify the values, the OpenShift Pipelines Operator does not update those fields and applies the default values for the OpenShift Pipelines controller.
If you modify or remove any of the performance fields, the OpenShift Pipelines Operator updates the
|Name||Description||Default value for the OpenShift Pipelines controller|
Enable or disable the high availability (HA) support. By default, the HA support is enabled.
The number of buckets used to partition the key space for each reconciler.
Each of the replicas uses these buckets. The instance that owns a bucket reconciles the keys partitioned into that bucket. The maximum value is
The number of threads (workers) to use when the work queue of the OpenShift Pipelines controller is processed.
The maximum queries per second (QPS) to the cluster master from the REST client.
The maximum burst for a throttle.
The OpenShift Pipelines Operator does not control the number of replicas of the OpenShift Pipelines controller. The
You can learn more about installing Operators on OpenShift Container Platform in the adding Operators to a cluster section.
To install Tekton Chains using the Red Hat OpenShift Pipelines Operator, see Using Tekton Chains for Red Hat OpenShift Pipelines supply chain security.
To install and deploy in-cluster Tekton Hub, see Using Tekton Hub with Red Hat OpenShift Pipelines.
For more information on using pipelines in a restricted environment, see: