Installing Pipelines Instructions

_topic_map.yml

@@ -748,6 +748,8 @@ Topics:
 #  File: understanding-openshift-pipelines
 #- Name: Installing Pipelines
 #  File: installing-pipelines
+#- Name: Uninstalling Pipelines
+#  File: uninstalling-pipelines
 #- Name: Getting started with OpenShift Pipelines
 #  File: getting-started-with-openshift-pipelines
 #- Name: Working with Pipelines using the Developer perspective

modules/op-deleting-the-pipelines-component-and-custom-resources.adoc

@@ -0,0 +1,26 @@
+// Module included in the following assemblies:
+//
+// */openshift_pipelines/uninstalling-pipelines.adoc
+
+[id='op-deleting-the-pipelines-component-and-custom-resources_{context}']
+= Deleting the {pipelines-title} components and Custom Resources
+
+Delete the Custom Resources (CRs) created by default during installation of the {pipelines-title} Operator.
+
+[discrete]
+.Procedure
+. In the *Administrator* perspective of the web console, navigate to *Administration* -> *Custom Resource Definition*.
+
+. Type `config.operator.tekton.dev` in the *Filter by name* box to search for the {pipelines-title} Operator CRs.
+
+. Click *CRD Config* to see the *Custom Resource Definition Details* page.
+
+. Click the *Actions* drop-down menu and select *Delete Custom Resource Definition*.
+
++
+[NOTE]
+====
+Deleting the CRs will delete the {pipelines-title} components, and all the Tasks and Pipelines on the cluster will be lost.
+====
+
+. Click *Delete* to confirm the deletion of the CRs.

modules/op-installing-pipelines-operator-in-web-console.adoc

@@ -0,0 +1,44 @@
+// Module included in the following assemblies:
+//
+// */openshift_pipelines/installing-pipelines.adoc
+[id="op-installing-pipelines-operator-in-web-console_{context}"]
+= Installing the {pipelines-title} Operator in web console
+
+You can install {pipelines-title} using the Operator listed in the {product-title} OperatorHub. When you install the {pipelines-title} Operator, the Custom Resources (CRs) required for the Pipelines configuration are automatically installed along with the Operator.
+
+[discrete]
+.Procedure
+
+. In the *Administrator* perspective of the web console, navigate to *Operators* -> *OperatorHub*.
+
+. Use the *Filter by keyword* box to search for `{pipelines-title} Operator` in the catalog. Click the *OpenShift Pipelines Operator* tile.
++
+[NOTE]
+====
+Ensure that you do not select the *Community* version of the *OpenShift Pipelines Operator*.
+====
++
+//image::op-installed-tile.png[]
+//Remove the note below once the community operator is removed from OperatorHub
+
+. Read the brief description about the Operator on the *{pipelines-title} Operator* page. Click *Install*.
++
+//image::op-install-subscription.png[]
+
+. On the *Create Operator Subscription* page:
+
+  .. Select *All namespaces on the cluster (default)* for the *Installation Mode*. This mode installs the Operator in the default `openshift-operators` namespace, which enables the Operator to watch and be made available to all namespaces in the cluster.
+
+  .. Select *Automatic* for the *Approval Strategy*. This ensures that the future upgrades to the Operator are handled automatically by the 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 *ocp-<4.x>* channel enables installation of the latest stable release of the {pipelines-title} Operator.
+    *** The *preview* channel enables installation of the latest preview version of the {pipelines-title} Operator, which may contain features that are not yet available from the 4.x update channel.
++
+    . Click *Subscribe*. You will see the Operator listed on the *Installed Operators* page.
++
+[NOTE]
+====
+The Operator is installed automatically into the `openshift-operators` namespace.
+====
+
+. Verify that the *Status* is set to *Succeeded Up to date*  to confirm successful installation of {pipelines-title} Operator.

modules/op-installing-pipelines-operator-using-the-cli.adoc

@@ -0,0 +1,41 @@
+// Module included in the following assemblies:
+//
+// * openshift_pipelines/installing-pipelines.adoc
+
+[id="op-installing-pipelines-operator-using-the-cli_{context}"]
+= Installing the OpenShift Pipelines Operator using the CLI
+
+You can install {pipelines-title} Operator from the OperatorHub using the CLI.
+
+[discrete]
+.Procedure
+
+. Create a Subscription object YAML file to subscribe a namespace to the {pipelines-title} Operator,
+for example, `sub.yaml`:
++
+.Example Subscription
+[source,yaml]
+----
+apiVersion: operators.coreos.com/v1alpha1
+kind: Subscription
+metadata:
+  name: openshift-pipelines-operator
+  namespace: openshift-operators
+spec:
+  channel:  <channel name> <1>
+  name: openshift-pipelines-operator <2>
+  source: redhat-operators <3>
+  sourceNamespace: openshift-marketplace <4>
+----
+<1> Specify 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.
+
+. Create the Subscription object:
++
+----
+$ oc apply -f sub.yaml
+----
++
+The {pipelines-title} Operator is now installed in the default target namespace `openshift-operators`.

modules/op-uninstalling-the-pipelines-operator.adoc

@@ -0,0 +1,14 @@
+// Module included in the following assemblies:
+//
+// */openshift_pipelines/uninstalling-pipelines.adoc
+
+[id='op-uninstalling-the-pipelines-operator_{context}']
+= Uninstalling the {pipelines-title} Operator
+
+[discrete]
+.Procedure
+. From the *Operators* -> *OperatorHub* page, use the *Filter by keyword* box to search for `{pipelines-title} Operator`.
+
+. Click the *OpenShift Pipelines Operator* tile. The Operator tile indicates it is installed.
+
+. In the *OpenShift Pipelines Operator* descriptor page, click *Uninstall*.

openshift_pipelines/installing-pipelines.adoc

@@ -0,0 +1,32 @@
+[id="installing-pipelines"]
+= Installing OpenShift Pipelines
+include::modules/common-attributes.adoc[]
+include::modules/pipelines-document-attributes.adoc[]
+:context: installing-pipelines
+
+toc::[]
+
+// Prerequisites for installing OpenShift Operator
+[discrete]
+.Prerequisites
+
+* You have access to an {product-title} cluster using an account with `cluster-admin` permissions.
+
+* You have installed `oc` CLI.
+
+////
+* You have installed xref:../cli_reference/tkn_cli/installing-tkn.adoc[OpenShift Pipelines (`tkn`) CLI] on your local system.
+////
+
+//Installing Pipelines Operator using web console
+
+include::modules/op-installing-pipelines-operator-in-web-console.adoc[leveloffset=+1]
+
+// Installing Pipelines Operator using CLI
+
+include::modules/op-installing-pipelines-operator-using-the-cli.adoc[leveloffset=+1]
+
+
+== Additional Resources
+
+* You can learn more about installing Operators on {product-title} in the xref:../operators/olm-adding-operators-to-cluster.adoc#olm-adding-operators-to-a-cluster[adding Operators to a cluster] section.

openshift_pipelines/uninstalling-pipelines.adoc

@@ -0,0 +1,22 @@
+[id="uninstalling-pipelines"]
+= Uninstalling OpenShift Pipelines
+include::modules/common-attributes.adoc[]
+include::modules/pipelines-document-attributes.adoc[]
+:context: uninstalling-pipelines
+
+toc::[]
+
+Uninstalling the {pipelines-title} Operator is a two-step process:
+
+. Delete the Custom Resources (CRs) that were added by default when you installed the {pipelines-title} Operator.
+. Uninstall the {pipelines-title} Operator.
+
+Uninstalling only the Operator will not remove the {pipelines-title} components created by default when the Operator is installed.
+
+include::modules/op-deleting-the-pipelines-component-and-custom-resources.adoc[leveloffset=+1]
+
+include::modules/op-uninstalling-the-pipelines-operator.adoc[leveloffset=+1]
+
+== Additional Resources
+
+* You can learn more about uninstalling Operators on {product-title} in the xref:../operators/olm-deleting-operators-from-cluster.adoc#olm-deleting-operators-from-a-cluster[deleting Operators from a cluster] section.