updated installation steps

openshift · Jan 2, 2025 · d15cff3 · d15cff3
1 parent 9baf7cd
commit d15cff3
Show file tree

Hide file tree

Showing 4 changed files with 112 additions and 50 deletions.
diff --git a/installing/installing-openshift-builds.adoc b/installing/installing-openshift-builds.adoc
@@ -24,11 +24,7 @@ As a dependency component, the {pipelines-operator} is automatically installed a
 
 include::modules/ob-installing-builds-with-operator.adoc[leveloffset=+1]
 
-include::modules/ob-creating-a-shipwright-build-resource-console.adoc[leveloffset=+2]
-
-include::modules/ob-installing-builds-using-CLI.adoc[leveloffset=+1]
-
-include::modules/ob-creating-a-shipwright-build-resource-cli.adoc[leveloffset=+2]
+include::modules/ob-installing-builds-using-cli.adoc[leveloffset=+1]
 
 
 [role="_additional-resources"]

diff --git a/modules/ob-installing-builds-using-CLI.adoc b/modules/ob-installing-builds-using-CLI.adoc
diff --git a/modules/ob-installing-builds-using-cli.adoc b/modules/ob-installing-builds-using-cli.adoc
@@ -0,0 +1,89 @@
+// This module is included in the following assembly:
+//
+// * installing/installing-openshift-builds.adoc
+
+:_mod-docs-content-type: PROCEDURE
+[id="installing-builds-using-CLI_{context}"]
+= Installing {builds-shortname} by using the CLI
+
+You can also install {builds-shortname} by using the command-line interface (CLI).
+
+.Procedure
+
+. Create a `sub.yaml` subscription object file to subscribe a namespace to the {builds-operator}, as shown in the following example:
++
+[source,yaml]
+----
+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:
++
+[source,terminal]
+----
+$ oc apply -f sub.yml
+----
++
+The {builds-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:
++
+[source,terminal]
+----
+$ oc get openshiftbuilds
+----
++
+
+. Run the following command to ensure that the `ShipwrightBuilds` resource is created:
++
+[source,terminal]
+----
+$ 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
++
+[source,terminal]
+----
+$ oc get pods -n openshift-builds
+----
++
+
+The list of pods is displayed as shown in the following example:
++
+[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
+tekton-operator-webhook-756f5dfdc7-c99mc             1/1     Running   0          3d13h
+----
diff --git a/modules/ob-installing-builds-with-operator.adoc b/modules/ob-installing-builds-with-operator.adoc
@@ -6,7 +6,7 @@
 [id="installing-builds-with-operator_{context}"]
 = Installing {builds-shortname} by using the web console
 
-You can install the {builds-operator} from the OperatorHub by using the {ocp-product-title} web console. Installing this Operator enables you to install and use build components.
+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.
 
 .Procedure
 . In the *Administrator* perspective of the web console, navigate to the *Operators* -> *OperatorHub* page.
@@ -19,19 +19,36 @@ You can install the {builds-operator} from the OperatorHub by using the {ocp-pro
 
 . 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 *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-operators` by default.
+.. 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-operator}.
-** To install a specific version of the {builds-operator}, cluster administrators can use the corresponding `openshift-builds-<version>` channel. For example, to install the {builds-operator} version `0.11.0`, you can use the `openshift-builds-0.11.0` channel.
+** 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.1`, you can use the `builds-1.1` channel.
 
 . Click *Install*.
 
 .Verification
 
-* On the *Installed Operators* page, verify that the {builds-operator} is listed and its *Status* is set to *Succeeded* to confirm successful installation.
+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` & `ShipwrightBuild` instances are listed. Alternatively, you can also click the Open Shift Build and Shipwright Build tabs.
+
+. 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