Dieser Inhalt ist in der von Ihnen ausgewählten Sprache nicht verfügbar.
Chapter 1. Installing Builds
As a cluster administrator, you can install Builds on an OpenShift Container Platform cluster.
1.1. Prerequisites Link kopierenLink in die Zwischenablage kopiert!
- 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 Link kopierenLink in die Zwischenablage kopiert!
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 version1.3
, you can use thebuilds-1.3
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.3. Installing Builds by using the CLI Link kopierenLink in die Zwischenablage kopiert!
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.4. Disabling ShipwrightBuilds build controller and webhook pod Link kopierenLink in die Zwischenablage kopiert!
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.