Chapter 1. Installing Builds As a cluster administrator, you can install Builds on an OpenShift Container Platform cluster. 1.1. Prerequisites You have access to the OpenShift Container Platform web console. You have installed the oc CLI. You are logged in to the OpenShift Container Platform cluster as an administrator. Your cluster has the Marketplace capability enabled or the Red Hat Operator catalog source configured manually. Note As a dependency component, the Red Hat OpenShift Pipelines Operator is automatically installed along with the Builds for Red Hat OpenShift Operator during installation. If you have already installed the Red Hat OpenShift Pipelines Operator, Builds uses that Operator for its functioning. 1.2. Installing Builds by using the web console You can install the Builds for Red Hat OpenShift Operator from the OperatorHub by using the builds for Red Hat OpenShift web console. Installing this Operator enables you to install and use build components. Procedure In the Administrator perspective of the web console, navigate to the Operators OperatorHub page. Use the Filter by keyword box to search for Builds for Red Hat OpenShift Operator in the catalog. Click the Builds for Red Hat OpenShift Operator tile. Read the brief description about the Operator and click Install . On the Install Operator page: Check that the Installation Mode is set to All namespaces on the cluster (default) . This mode installs the Operator in the default openshift-builds namespace to watch and be made available to all namespaces in the cluster. Check that the Installed Namespace is set to openshift-builds by default. 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 : The Update Channel is set to latest by default. The latest channel enables installation of the most recent stable version of the Builds for Red Hat OpenShift Operator. To install a specific version of the Builds for Red Hat OpenShift Operator, cluster administrators can use the corresponding builds-<version> channel. For example, to install the Builds for Red Hat OpenShift Operator version 1.3 , you can use the builds-1.3 channel. Click Install . Verification After installing the Builds for Red Hat OpenShift Operator, you must verify that the required resources are created to ensure proper functioning of the controllers. Procedure In the Administrator perspective of the web console, select the project as openshift-builds. Navigate to the Operators Installed Operators page. Click the All instances tab. On the All instances tab, verify that the OpenShiftBuild and ShipwrightBuild instances are listed. Now, navigate to the Workloads Pods page. On the Pods page, verify that the following pods are listed: The openshift-builds operator pod Build controller and build webhook pods SharedResource daemonset and SharedResource webhook pods 1.3. Installing Builds by using the CLI You can also install Builds by using the command-line interface (CLI). Procedure Create a sub.yaml subscription object file to subscribe a namespace to the Builds for Red Hat OpenShift Operator, as shown in the following example: apiVersion: operators.coreos.com/v1alpha1 kind: Subscription metadata: name: openshift-builds-operator namespace: openshift-builds spec: channel: <channel-name> 1 name: openshift-builds-operator 2 source: redhat-operators 3 sourceNamespace: openshift-marketplace 4 1 The channel name from where you want to subscribe the 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. Apply the subscription object by runninng the following command: USD oc apply -f sub.yml The Builds for Red Hat OpenShift Operator is now installed in the default target namespace openshift-builds . Verification After installing the Builds for Red Hat OpenShift Operator, you must verify that the following resources are created to ensure proper functioning of the Operator: Run the following command to ensure that the OpenshiftBuild resource is created: USD oc get openshiftbuilds Run the following command to ensure that the ShipwrightBuilds resource is created: USD oc get shipwrightbuilds Run the following command to ensure that the following pods are created in the openshift-builds namespace: openshift-builds operator pod Build controller and build webhook pods SharedResource daemonset and SharedResource webhook pods USD oc get pods -n openshift-builds The list of pods is displayed as shown in the following example: USD oc get pods -n openshift-builds NAME READY STATUS RESTARTS AGE openshift-builds-operator-6f5c48c6b5-cvp2w 2/2 Running 0 13d openshift-pipelines-operator-64d8c4969c-952cc 2/2 Running 0 3d13h shared-resource-csi-driver-node-gbkqs 2/2 Running 0 13d shared-resource-csi-driver-node-kcqxc 2/2 Running 0 13d shared-resource-csi-driver-node-sbsvg 2/2 Running 0 13d shared-resource-csi-driver-webhook-9d9bd48f4-d5ln6 1/1 Running 0 13d shipwright-build-controller-5454475b85-mmm6w 1/1 Running 0 13d shipwright-build-webhook-7fbd49c6bb-2n77s 1/1 Running 0 13d tekton-operator-webhook-756f5dfdc7-c99mc 1/1 Running 0 3d13h 1.4. Disabling ShipwrightBuilds build controller and webhook pod You can disable the ShipwrightBuilds Custom Resource (CR) without disabling the shared-resources Container Storage Interface (CSI) driver component and the ShipwrightBuilds Custom Resource Definition (CRD). Disabling the ShipwrightBuilds CR removes the ShipwrightBuilds build controller and ShipwrightBuilds build webhook pod from the openshift-builds namespace. Procedure Disable the ShipwrightBuilds controller and webhook by running the following command: USD oc patch openshiftbuild cluster --type=merge -p '{"spec":{"shipwright":{"build":{"state":"Disabled"}}}}' This command disables the build controller and webhook but does not affect the ShipwrightBuilds CRD. 1.5. Additional resources Adding Operators to a cluster

Commands:
apiVersion: operators.coreos.com/v1alpha1 kind: Subscription metadata: name: openshift-builds-operator namespace: openshift-builds spec: channel: <channel-name> 1 name: openshift-builds-operator 2 source: redhat-operators 3 sourceNamespace: openshift-marketplace 4
oc apply -f sub.yml
oc get openshiftbuilds
oc get shipwrightbuilds
oc get pods -n openshift-builds
oc get pods -n openshift-builds NAME READY STATUS RESTARTS AGE openshift-builds-operator-6f5c48c6b5-cvp2w 2/2 Running 0 13d openshift-pipelines-operator-64d8c4969c-952cc 2/2 Running 0 3d13h shared-resource-csi-driver-node-gbkqs 2/2 Running 0 13d shared-resource-csi-driver-node-kcqxc 2/2 Running 0 13d shared-resource-csi-driver-node-sbsvg 2/2 Running 0 13d shared-resource-csi-driver-webhook-9d9bd48f4-d5ln6 1/1 Running 0 13d shipwright-build-controller-5454475b85-mmm6w 1/1 Running 0 13d shipwright-build-webhook-7fbd49c6bb-2n77s 1/1 Running 0 13d tekton-operator-webhook-756f5dfdc7-c99mc 1/1 Running 0 3d13h
oc patch openshiftbuild cluster --type=merge -p '{"spec":{"shipwright":{"build":{"state":"Disabled"}}}}'