Chapter 1. Installing Builds


As a cluster administrator, you can install Builds on an OpenShift Container Platform cluster to create, manage, and run container image builds directly within the cluster.

1.1. Installing Builds by using the web console

Use the OpenShift Container Platform web console to install the builds for Red Hat OpenShift components. The graphical interface simplifies setting up the build infrastructure, allowing you to compile source code and create container images directly within your OpenShift cluster.

Prerequisites

  • You have access to the OpenShift Container Platform web console.
  • 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.

Procedure

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

    1. 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.
    2. Check that the Installed Namespace is set to openshift-builds by default.
    3. 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.
    4. Select 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.
  6. Click Install.

Verification

  1. In the Administrator perspective of the web console, select the project as openshift-builds.
  2. Go to the Operators Installed Operators page.
  3. On the Installed Operators page, set the namespace to All Projects.
  4. Verify that the status of Builds for Red Hat OpenShift Operator and Red Hat OpenShift Pipelines is displayed as Succeeded Up to date.
  5. Go to the Workloads Pods page.
  6. On the Pods page, set the namespace to openshift-builds.
  7. Verify that the following pods are listed:

    • openshift-builds-operator pod
    • shipwright-build-controller and shipwright-build-webhook pods
    • shared-resource-csi-driver node and shared-resource-csi-driver-webhook pod
  8. Set the namespace to openshift-operators.
  9. Verify that the following pods are listed:

    • openshift-pipelines-operator pod
    • tekton-operator-webhook pod

1.2. Installing Builds by using the CLI

Use the Command Line Interface (CLI) to install the necessary builds for Red Hat OpenShift components in OpenShift Container Platform. This CLI approach provides granular control over the configuration needed to compile source code and containerize applications within the cluster.

Prerequisites

  • You have installed the OpenShift CLI (oc).
  • 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.

Procedure

  1. 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
    Copy to Clipboard Toggle word wrap
    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 namespace for the default OperatorHub CatalogSources.
  2. Run the following command to apply the subscription object:

    $ oc apply -f sub.yml
    Copy to Clipboard Toggle word wrap

    The Builds for Red Hat OpenShift Operator is now installed in the target namespace, openshift-builds.

Verification

  1. Run the following command to ensure that the OpenshiftBuild resource is created:

    $ oc get openshiftbuilds
    Copy to Clipboard Toggle word wrap

    Example output

    NAME      AGE
    cluster   32m
    Copy to Clipboard Toggle word wrap
  2. Run the following command to ensure that the ShipwrightBuilds resource is created:

    $ oc get shipwrightbuilds
    Copy to Clipboard Toggle word wrap

    Example output

    NAME            AGE
    cluster-mzrg4   33m
    Copy to Clipboard Toggle word wrap
  3. Run the following command to ensure that the required pods are created in the openshift-builds namespace:

    $ oc get pods -n openshift-builds
    Copy to Clipboard Toggle word wrap

    Example output

    NAME                                                 READY   STATUS    RESTARTS   AGE
    openshift-builds-operator-6f5c48c6b5-cvp2w           2/2     Running   0          13d
    shared-resource-csi-driver-node-gbkqs                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
    Copy to Clipboard Toggle word wrap
  4. Run the following command to ensure that the required pods are created in the openshift-operators namespace:

    $ oc get pods -n openshift-operators
    Copy to Clipboard Toggle word wrap

    Example output

    NAME                                                 READY   STATUS    RESTARTS   AGE
    openshift-pipelines-operator-64d8c4969c-952cc        2/2     Running   0          3d13h
    tekton-operator-webhook-756f5dfdc7-c99mc             1/1     Running   0          3d13h
    Copy to Clipboard Toggle word wrap

1.3. Disabling ShipwrightBuilds components

You can disable the ShipwrightBuilds custom resource (CR). This action removes the shipwright-build-controller and shipwright-build-webhook pod from the openshift-builds namespace. It does not affect the Shared Resources Container Storage Interface (CSI) driver component or the ShipwrightBuilds custom resource definition (CRD).

Prerequisites

  • You have installed the OpenShift CLI (oc).
  • You are logged in to the OpenShift Container Platform cluster as an administrator.
  • You have installed the builds for Red Hat OpenShift.

Procedure

  • Run the following command to disable the shipwright-build-controller and shipwright-build-webhook pods:

    $ oc patch openshiftbuild cluster --type=merge -p '{"spec":{"shipwright":{"build":{"state":"Disabled"}}}}'
    Copy to Clipboard Toggle word wrap

    This command disables the shipwright-build-controller and shipwright-build-webhook pods but does not affect the ShipwrightBuilds CRD.

Verification

  • Run the following command to verify that the shipwright-build-controller and shipwright-build-webhook pods are disabled:

    $ oc get pods -n openshift-builds
    Copy to Clipboard Toggle word wrap

    Example output

    NAME                                                 READY   STATUS    RESTARTS   AGE
    openshift-builds-operator-6f5c48c6b5-cvp2w           2/2     Running   0          13d
    shared-resource-csi-driver-node-gbkqs                2/2     Running   0          13d
    shared-resource-csi-driver-webhook-9d9bd48f4-d5ln6   1/1     Running   0          13d
    Copy to Clipboard Toggle word wrap
Back to top
Red Hat logoGithubredditYoutubeTwitter

Learn

Try, buy, & sell

Communities

About Red Hat Documentation

We help Red Hat users innovate and achieve their goals with our products and services with content they can trust. Explore our recent updates.

Making open source more inclusive

Red Hat is committed to replacing problematic language in our code, documentation, and web properties. For more details, see the Red Hat Blog.

About Red Hat

We deliver hardened solutions that make it easier for enterprises to work across platforms and environments, from the core datacenter to the network edge.

Theme

© 2025 Red Hat