Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
16 changes: 3 additions & 13 deletions installing/installing-openshift-builds.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -7,27 +7,17 @@ include::_attributes/common-attributes.adoc[]
toc::[]

[role="_abstract"]
As a cluster administrator, you can install {builds-shortname} on an {ocp-product-title} cluster.

[id="prerequisites_installing-openshift-builds"]
== Prerequisites

* You have access to the {ocp-product-title} web console.
* You have installed the `oc` CLI.
* You are logged in to the {ocp-product-title} cluster as an administrator.
* Your cluster has the link:https://docs.openshift.com/container-platform/latest/installing/overview/cluster-capabilities.html#marketplace-operator_cluster-capabilities[Marketplace capability] enabled or the Red Hat Operator catalog source configured manually.
* You have installed the {pipelines-operator}. For installation steps, see link:https://docs.redhat.com/en/documentation/red_hat_openshift_pipelines/1.15/html-single/installing_and_configuring/index[Installing {pipelines-operator}].
As a cluster administrator, you can install {builds-shortname} on an {ocp-product-title} cluster to create, manage, and run container image builds directly within the cluster.

include::modules/ob-installing-builds-by-using-the-web-console.adoc[leveloffset=+1]

include::modules/ob-installing-builds-using-cli.adoc[leveloffset=+1]

include::modules/ob-disabling-shipwrightBuilds-build-controller-and-webhook-pod.adoc[leveloffset=+1]
include::modules/ob-disabling-shipwrightBuilds-components.adoc[leveloffset=+1]

[role="_additional-resources"]
[id="additional-resources_installing-openshift-builds"]
== Additional resources

* link:https://docs.openshift.com/container-platform/latest/operators/admin/olm-adding-operators-to-cluster.html#olm-adding-operators-to-a-cluster[Adding Operators to a cluster]


* xref:../work_with_builds/using-builds.adoc[Managing Builds]

This file was deleted.

46 changes: 46 additions & 0 deletions modules/ob-disabling-shipwrightBuilds-components.adoc
Original file line number Diff line number Diff line change
@@ -0,0 +1,46 @@
// This module is included in the following assembly:
//
// * installing/installing-openshift-builds.adoc

:_mod-docs-content-type: PROCEDURE
[id="ob-disabling-shipwrightBuilds-components_{context}"]
= Disabling ShipwrightBuilds components

[role="_abstract"]
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 {ocp-product-title} cluster as an administrator.
* You have installed the {builds-title}.

.Procedure

* Run the following command to disable the `shipwright-build-controller` and `shipwright-build-webhook` pods:
+
[source,terminal]
----
$ oc patch openshiftbuild cluster --type=merge -p '{"spec":{"shipwright":{"build":{"state":"Disabled"}}}}'
----
+
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:
+
[source,terminal]
----
$ oc get pods -n openshift-builds
----
+
_Example output_
+
[source,terminal]
----
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
----
43 changes: 31 additions & 12 deletions modules/ob-installing-builds-by-using-the-web-console.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -7,7 +7,14 @@
= Installing {builds-shortname} by using the web console

[role="_abstract"]
You can install the {builds-operator} from the OperatorHub by using the {builds-title} web console. Installing this Operator enables you to install and use build components.
Use the {ocp-product-title} web console to install the {builds-title} 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 {ocp-product-title} web console.
* You are logged in to the {ocp-product-title} cluster as an administrator.
* Your cluster has the link:https://docs.openshift.com/container-platform/latest/installing/overview/cluster-capabilities.html#marketplace-operator_cluster-capabilities[Marketplace capability] enabled or the Red Hat Operator catalog source configured manually.
* You have installed the {pipelines-operator}.

.Procedure
. In the *Administrator* perspective of the web console, navigate to the *Operators* -> *OperatorHub* page.
Expand All @@ -26,7 +33,7 @@ You can install the {builds-operator} from the OperatorHub by using the {builds-

.. 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*:
.. 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-operator}.
** To install a specific version of the {builds-operator}, cluster administrators can use the corresponding `builds-<version>` channel. For example, to install the {builds-operator} version `1.3`, you can use the `builds-1.3` channel.
Expand All @@ -35,19 +42,31 @@ You can install the {builds-operator} from the OperatorHub by using the {builds-

.Verification

After installing the {builds-title}, 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.
. Go to the *Operators* -> *Installed Operators* page.

. On the *Installed Operators* page, set the namespace to `All Projects`.

. Verify that the status of {builds-operator} and {pipelines-title} is displayed as Succeeded Up to date.

. Go to the *Workloads* -> *Pods* page.

. On the *Pods* page, set the namespace to `openshift-builds`.

. 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

. On the *Installed Operators* page, click the *All instances* tab.
. Set the namespace to `openshift-operators`.

. On the *All instances* tab, verify that the status of `OpenShiftBuild` and `ShipwrightBuild` Operator is displayed as Succeeded Up to date.
. Verify that the following pods are listed:
* `openshift-pipelines-operator` pod
* `tekton-operator-webhook` pod

. Now, navigate to the *Workloads* -> *Pods* page.
[role="_additional-resources"]
.Additional resources

. 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
* link:https://docs.redhat.com/en/documentation/red_hat_openshift_pipelines/1.15/html-single/installing_and_configuring/index[Installing {pipelines-operator}]
* link:https://docs.redhat.com/en/documentation/openshift_container_platform/4.19/html/operators/understanding-operators#operator-lifecycle-manager-olm[Operator Lifecycle Manager (OLM)]
40 changes: 32 additions & 8 deletions modules/ob-installing-builds-using-cli.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -7,7 +7,14 @@
= Installing {builds-shortname} by using the CLI

[role="_abstract"]
You can also install {builds-shortname} by using the command-line interface (CLI).
Use the Command Line Interface (CLI) to install the necessary {builds-title} components in {ocp-product-title}. 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 {ocp-product-title} cluster as an administrator.
* Your cluster has the link:https://docs.openshift.com/container-platform/latest/installing/overview/cluster-capabilities.html#marketplace-operator_cluster-capabilities[Marketplace capability] enabled or the Red Hat Operator catalog source configured manually.
* You have installed the {pipelines-operator}.

.Procedure

Expand Down Expand Up @@ -42,8 +49,6 @@ The {builds-operator} is now installed in the target namespace, `openshift-build

.Verification

After installing the {builds-title}, 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:
+
[source,terminal]
Expand All @@ -53,6 +58,7 @@ $ oc get openshiftbuilds
+
_Example output_
+
[source,terminal]
----
NAME AGE
cluster 32m
Expand All @@ -67,6 +73,7 @@ $ oc get shipwrightbuilds
+
_Example output_
+
[source,terminal]
----
NAME AGE
cluster-mzrg4 33m
Expand All @@ -83,15 +90,32 @@ _Example output_
+
[source,terminal]
----
$ 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
----

. Run the following command to ensure that the required pods are created in the `openshift-operators` namespace:
+
[source,terminal]
----
$ oc get pods -n openshift-operators
----
+
_Example output_
+
[source,terminal]
----
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
----
----

[role="_additional-resources"]
.Additional resources

* link:https://docs.redhat.com/en/documentation/red_hat_openshift_pipelines/1.15/html-single/installing_and_configuring/index[Installing {pipelines-operator}]
* link:https://docs.redhat.com/en/documentation/openshift_container_platform/4.19/html/cli_tools/openshift-cli-oc[OpenShift CLI (oc)]