Install
Installing Builds
Abstract
Chapter 1. Installing Builds Copy linkLink copied to clipboard!
As a cluster administrator, you can install Builds on an OpenShift Container Platform cluster.
1.1. Prerequisites Copy linkLink copied to clipboard!
- 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.
- You have installed the Red Hat OpenShift Pipelines Operator. For installation steps, see Installing Red Hat OpenShift Pipelines Operator.
1.2. Installing Builds by using the web console Copy linkLink copied to clipboard!
You can install the Builds for Red Hat OpenShift Operator from the OperatorHub by using the OpenShift Container Platform 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-operators
namespace to watch and be made available to all namespaces in the cluster. -
Check that the Installed Namespace is set to
openshift-operators
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 version1.2
, you can use thebuilds-1.2
channel.
-
Check that the Installation Mode is set to All namespaces on the cluster (default). This mode installs the Operator in the default
- Click Install.
Verification
After installing the builds for Red Hat OpenShift, perform the following steps to verify that the required resources are created to ensure proper functioning of the controllers.
- In the Administrator perspective of the web console, select the project as openshift-builds.
- Navigate to the Operators → Installed Operators page.
- On the Installed Operators page, click the All instances tab.
-
On the All instances tab, verify that the status of
OpenShiftBuild
andShipwrightBuild
Operator is displayed as Succeeded Up to date. - 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 andSharedResource
webhook pods
-
The
1.2.1. Creating a ShipwrightBuild resource by using the web console Copy linkLink copied to clipboard!
After installing the Builds for Red Hat OpenShift Operator, you must create a ShipwrightBuild
resource to enable the functioning of the build controller.
Procedure
- In the Administrator perspective of the web console, navigate to the Operators → Installed Operators page.
- Click the Builds for Red Hat OpenShift Operator link present in the list. The Operator details page opens.
- Select the Shipwright Build tab and click Create ShipwrightBuild.
Select either the Form view or YAML view to configure a new
ShipwrightBuild
resource in the following manner:On selecting the Form view or YAML view, you get to see the default values configured for the
name
andtargetNamespace
fields. If you do not want to edit those fields, click Create to configure theShipwrightBuild
resource with default values.You can view the created resource in the Shipwright Build tab.
Verification
- Build controller and build webhook pods must have been created in the mentioned target namespace.
1.3. Installing Builds by using the CLI Copy linkLink copied to clipboard!
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:Copy to Clipboard Copied! Toggle word wrap Toggle overflow Run the following command to apply the subscription object:
oc apply -f sub.yml
$ oc apply -f sub.yml
Copy to Clipboard Copied! Toggle word wrap Toggle overflow The Builds for Red Hat OpenShift Operator is now installed in the target namespace,
openshift-builds
.
Verification
After installing the builds for Red Hat OpenShift, perform the following steps to verify that the required resources are created to ensure proper functioning of the controllers.
Run the following command to ensure that the
OpenshiftBuild
resource is created:oc get openshiftbuilds
$ oc get openshiftbuilds
Copy to Clipboard Copied! Toggle word wrap Toggle overflow Example output
NAME AGE cluster 32m
NAME AGE cluster 32m
Copy to Clipboard Copied! Toggle word wrap Toggle overflow Run the following command to ensure that the
ShipwrightBuilds
resource is created:oc get shipwrightbuilds
$ oc get shipwrightbuilds
Copy to Clipboard Copied! Toggle word wrap Toggle overflow Example output
NAME AGE cluster-mzrg4 33m
NAME AGE cluster-mzrg4 33m
Copy to Clipboard Copied! Toggle word wrap Toggle overflow Run the following command to ensure that the required pods are created in the
openshift-builds
namespace:oc get pods -n openshift-builds
$ oc get pods -n openshift-builds
Copy to Clipboard Copied! Toggle word wrap Toggle overflow Example output
Copy to Clipboard Copied! Toggle word wrap Toggle overflow
1.3.1. Creating a ShipwrightBuild resource by using CLI Copy linkLink copied to clipboard!
After installing the Builds for Red Hat OpenShift Operator, you must create a ShipwrightBuild
resource to enable the functioning of the build controller.
Procedure
Create a
instance.yaml
file to create aShipwrightBuild
resource in theshipwright-builds
namespace, as shown in the following example:Copy to Clipboard Copied! Toggle word wrap Toggle overflow Apply the YAML file by runninng the following command:
oc apply -f instance.yaml
$ oc apply -f instance.yaml
Copy to Clipboard Copied! Toggle word wrap Toggle overflow
Verification
Run the following command to verify that the
ShipwrightBuild
resource is now configured:oc get pods -n shipwright-builds
$ oc get pods -n shipwright-builds
Copy to Clipboard Copied! Toggle word wrap Toggle overflow
1.4. Disabling ShipwrightBuilds build controller and webhook pod Copy linkLink copied to clipboard!
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:oc patch openshiftbuild cluster --type=merge -p '{"spec":{"shipwright":{"build":{"state":"Disabled"}}}}'
$ oc patch openshiftbuild cluster --type=merge -p '{"spec":{"shipwright":{"build":{"state":"Disabled"}}}}'
Copy to Clipboard Copied! Toggle word wrap Toggle overflow This command disables the build controller and webhook but does not affect the
ShipwrightBuilds
CRD.
Legal Notice
Copy linkLink copied to clipboard!
Copyright © 2025 Red Hat
OpenShift documentation is licensed under the Apache License 2.0 (https://www.apache.org/licenses/LICENSE-2.0).
Modified versions must remove all Red Hat trademarks.
Portions adapted from https://github.com/kubernetes-incubator/service-catalog/ with modifications by Red Hat.
Red Hat, Red Hat Enterprise Linux, the Red Hat logo, the Shadowman logo, JBoss, OpenShift, Fedora, the Infinity logo, and RHCE are trademarks of Red Hat, Inc., registered in the United States and other countries.
Linux® is the registered trademark of Linus Torvalds in the United States and other countries.
Java® is a registered trademark of Oracle and/or its affiliates.
XFS® is a trademark of Silicon Graphics International Corp. or its subsidiaries in the United States and/or other countries.
MySQL® is a registered trademark of MySQL AB in the United States, the European Union and other countries.
Node.js® is an official trademark of Joyent. Red Hat Software Collections is not formally related to or endorsed by the official Joyent Node.js open source or commercial project.
The OpenStack® Word Mark and OpenStack logo are either registered trademarks/service marks or trademarks/service marks of the OpenStack Foundation, in the United States and other countries and are used with the OpenStack Foundation’s permission. We are not affiliated with, endorsed or sponsored by the OpenStack Foundation, or the OpenStack community.
All other trademarks are the property of their respective owners.