Added how to uninstall service brokers

bergerhoffer · bergerhoffer · commit 796f8eb2eaa6 · 2019-04-03T10:44:22.000-04:00
diff --git a/_topic_map.yml b/_topic_map.yml
@@ -100,16 +100,20 @@ Topics:
   Topics:
   - Name: Installing the service catalog
     File: installing-service-catalog
-  - Name: Installing the template service broker
+  - Name: Installing the Template service Broker
     File: installing-template-service-broker
   - Name: Provisioning template applications
     File: provisioning-template-application
+  - Name: Uninstalling the Template Service Broker
+    File: uninstalling-template-service-broker
   - Name: Installing the OpenShift Ansible Broker
     File: installing-ansible-service-broker
   - Name: Configuring the OpenShift Ansible Broker
     File: configuring-ansible-service-broker
   - Name: Provisioning service bundles
     File: provisioning-service-bundle
+  - Name: Uninstalling the OpenShift Ansible Broker
+    File: uninstalling-ansible-service-broker
 - Name: Deployments
   Dir: deployments
   Topics:
diff --git a/applications/service_brokers/configuring-ansible-service-broker.adoc b/applications/service_brokers/configuring-ansible-service-broker.adoc
@@ -5,8 +5,12 @@ include::modules/common-attributes.adoc[]
 
 toc::[]
 
-IMPORTANT: The {asb-name} is deprecated in this release. Equivalent and better functionality is present in the Operator Framework and
-Operator Lifecycle Manager (OLM).
+[IMPORTANT]
+====
+The {asb-name} is deprecated in {product-title} 4. Equivalent and better
+functionality is present in the Operator Framework and Operator Lifecycle
+Manager (OLM).
+====
 
 // Configuring the {asb-name} Operator
 include::modules/sb-configuring-ansible-service-broker.adoc[leveloffset=+1]
diff --git a/applications/service_brokers/installing-ansible-service-broker.adoc b/applications/service_brokers/installing-ansible-service-broker.adoc
@@ -8,8 +8,12 @@ toc::[]
 You can install the {asb-name} to gain access to the service bundles that it
 provides.
 
-IMPORTANT: The {asb-name} is deprecated in this release. Equivalent and better functionality is present in the Operator Framework and
-Operator Lifecycle Manager (OLM).
+[IMPORTANT]
+====
+The {asb-name} is deprecated in {product-title} 4. Equivalent and better
+functionality is present in the Operator Framework and Operator Lifecycle
+Manager (OLM).
+====
 
 .Prerequisites
 
diff --git a/applications/service_brokers/installing-service-catalog.adoc b/applications/service_brokers/installing-service-catalog.adoc
@@ -5,8 +5,12 @@ include::modules/common-attributes.adoc[]
 
 toc::[]
 
-IMPORTANT: The service catalog is deprecated in this release. Equivalent and better functionality is present in the Operator Framework and
-Operator Lifecycle Manager (OLM).
+[IMPORTANT]
+====
+The service catalog is deprecated in {product-title} 4. Equivalent and better
+functionality is present in the Operator Framework and Operator Lifecycle
+Manager (OLM).
+====
 
 // About the service catalog
 include::modules/modules/sb-about-service-catalog.adoc[leveloffset=+1]
diff --git a/applications/service_brokers/installing-template-service-broker.adoc b/applications/service_brokers/installing-template-service-broker.adoc
@@ -1,25 +1,29 @@
 [id="sb-installing-tsb"]
-= Installing the template service broker
+= Installing the {tsb-name}
 include::modules/common-attributes.adoc[]
 :context: sb-installing-tsb
 
 toc::[]
 
-You can install the template service broker to gain access to the template
+You can install the {tsb-name} to gain access to the template
 applications that it provides.
 
-IMPORTANT: The template service broker is deprecated in this release. Equivalent and better functionality is present in the Operator Framework and
-Operator Lifecycle Manager (OLM).
+[IMPORTANT]
+====
+The {tsb-name} is deprecated in {product-title} 4. Equivalent and better
+functionality is present in the Operator Framework and Operator Lifecycle
+Manager (OLM).
+====
 
 .Prerequisites
 
 * xref:../../applications/service_brokers/installing-service-catalog.adoc#sb-install-service-catalog-sb-installing-service-catalog[Install the service catalog]
 
-// About the service template service broker
+// About the service {tsb-name}
 include::modules/modules/sb-about-template-service-broker.adoc[leveloffset=+1]
 
-// Installing the template service broker Operator
+// Installing the {tsb-name} Operator
 include::modules/sb-install-tsb-operator.adoc[leveloffset=+1]
 
-// Starting the template service broker
+// Starting the {tsb-name}
 include::modules/sb-start-tsb.adoc[leveloffset=+1]
diff --git a/applications/service_brokers/uninstalling-ansible-service-broker.adoc b/applications/service_brokers/uninstalling-ansible-service-broker.adoc
@@ -0,0 +1,19 @@
+[id="sb-uninstalling-asb"]
+= Uninstalling the {asb-name}
+include::modules/common-attributes.adoc[]
+:context: sb-uninstalling-asb
+
+toc::[]
+
+You can uninstall the {asb-name} if you no longer need access to the service
+bundles that it provides.
+
+[IMPORTANT]
+====
+The {asb-name} is deprecated in {product-title} 4. Equivalent and better
+functionality is present in the Operator Framework and Operator Lifecycle
+Manager (OLM).
+====
+
+// Uninstalling the {asb-name}
+include::modules/modules/sb-uninstall-asb.adoc[leveloffset=+1]
diff --git a/applications/service_brokers/uninstalling-template-service-broker.adoc b/applications/service_brokers/uninstalling-template-service-broker.adoc
@@ -0,0 +1,19 @@
+[id="sb-uninstalling-tsb"]
+= Uninstalling the {tsb-name}
+include::modules/common-attributes.adoc[]
+:context: sb-uninstalling-tsb
+
+toc::[]
+
+You can uninstall the {tsb-name} if you no longer need access to the template
+applications that it provides.
+
+[IMPORTANT]
+====
+The {tsb-name} is deprecated in {product-title} 4. Equivalent and better
+functionality is present in the Operator Framework and Operator Lifecycle
+Manager (OLM).
+====
+
+// Uninstalling the {tsb-name}
+include::modules/modules/sb-uninstall-tsb.adoc[leveloffset=+1]
diff --git a/modules/common-attributes.adoc b/modules/common-attributes.adoc
@@ -10,3 +10,4 @@
 :op-system-first: Red Hat Enterprise Linux CoreOS (RHCOS)
 :op-system: RHCOS
 :asb-name: OpenShift Ansible Broker
+:tsb-name: Template Service Broker
diff --git a/modules/sb-about-template-service-broker.adoc b/modules/sb-about-template-service-broker.adoc
@@ -3,16 +3,16 @@
 // * applications/service_brokers/installing-template-service-broker.adoc
 
 [id="sb-about-template-service-broker-{context}"]
-= About the template service broker
+= About the {tsb-name}
 
-The _template service broker_ gives the service catalog visibility into the
+The _{tsb-name}_ gives the service catalog visibility into the
 default Instant App and Quickstart templates that have shipped with
-{product-title} since its initial release. The template service broker can also
+{product-title} since its initial release. The {tsb-name} can also
 make available as a service anything for which an {product-title} template has
 been written, whether provided by Red Hat, a cluster administrator or user, or a third-party vendor.
 
-By default, the template service broker shows objects that are globally
+By default, the {tsb-name} shows objects that are globally
 available from the `openshift` project. It can also be configured to watch any
 other project that a cluster administrator chooses.
 
-The template service broker is not installed by default in {product-title} 4.
+The {tsb-name} is not installed by default in {product-title} 4.
diff --git a/modules/sb-configuring-ansible-service-broker.adoc b/modules/sb-configuring-ansible-service-broker.adoc
@@ -16,7 +16,7 @@ The following procedure customizes the settings for your {asb-name}.
 This procedure assumes that you used `ansible-service-broker` both as the {asb-name} name and the project that it was installed into.
 
 . Navigate in the web console to *Catalog* -> *Installed Operators* and select the `ansible-service-broker` project.
-// TODO: Change to *OpenShift Ansible Service Broker Operator* by GA (3 of 3)
+// TODO: Change to *OpenShift Ansible Service Broker Operator* by GA (3 of 5)
 . Select the *Automation Broker Operator*.
 . On the *Automation Broker* tab, select `ansible-service-broker`.
 . On the *YAML* tab, add or update any {asb-name} configuration options under the `spec` field.
diff --git a/modules/sb-install-asb-operator.adoc b/modules/sb-install-asb-operator.adoc
@@ -26,7 +26,7 @@ The following procedure installs the {asb-name} Operator using the web console.
  *Subject Name* field.
 .. Click *Create*.
 . Navigate to the *Catalog* -> *OperatorHub* page. Verify that the `ansible-service-broker` project is selected.
-// TODO: Change to *OpenShift Ansible Service Broker Operator* by GA (1 of 3)
+// TODO: Change to *OpenShift Ansible Service Broker Operator* by GA (1 of 5)
 . Select *Automation Broker Operator*.
 +
 A pop-up window appears, warning you that you are installing a Community
diff --git a/modules/sb-install-service-catalog.adoc b/modules/sb-install-service-catalog.adoc
@@ -5,7 +5,7 @@
 [id="sb-install-service-catalog-{context}"]
 = Installing service catalog
 
-You must install the service catalog by completing the following steps if you plan on using any of the services from the {asb-name} or template service broker.
+If you plan on using any of the services from the {asb-name} or {tsb-name}, you must install the service catalog by completing the following steps.
 
 .Procedure
 
diff --git a/modules/sb-install-tsb-operator.adoc b/modules/sb-install-tsb-operator.adoc
@@ -3,15 +3,15 @@
 // * applications/service_brokers/installing-template-service-broker.adoc
 
 [id="sb-install-tsb-operator-{context}"]
-= Installing the template service broker Operator
+= Installing the {tsb-name} Operator
 
 .Prerequisites
 
 * You have installed the service catalog.
 
 .Procedure
 
-The following procedure installs the template service broker Operator using the
+The following procedure installs the {tsb-name} Operator using the
 web console.
 
 . Create a project.
@@ -30,5 +30,5 @@ This Operator will be available under the *Red Hat* category in the GA release.
 . Read the information about the Operator and click *Install*.
 . Review the default selections and click *Subscribe*.
 
-Next, you must start the template service broker in order to access the template
+Next, you must start the {tsb-name} in order to access the template
 applications it provides.
diff --git a/modules/sb-provision-service-bundle.adoc b/modules/sb-provision-service-bundle.adoc
@@ -10,8 +10,8 @@ that was made available by the {asb-name}.
 
 .Prerequisites
 
-* You have installed the service catalog.
-* You have installed and started the {asb-name}.
+* The service catalog is installed.
+* The {asb-name} is installed.
 
 .Procedure
 
diff --git a/modules/sb-provision-template-application.adoc b/modules/sb-provision-template-application.adoc
@@ -6,12 +6,12 @@
 = Provisioning template applications
 
 The following procedure provisions an example PostgreSQL template application
-that was made available by the template service broker.
+that was made available by the {tsb-name}.
 
 .Prerequisites
 
-* You have installed the service catalog.
-* You have installed and started the template service broker.
+* The service catalog is installed.
+* The {tsb-name} is installed.
 
 .Procedure
 
diff --git a/modules/sb-start-asb.adoc b/modules/sb-start-asb.adoc
@@ -16,7 +16,7 @@ using the following procedure.
 .Procedure
 
 . Navigate in the web console to *Catalog* -> *Installed Operators* and select the `ansible-service-broker` project.
-// TODO: Change to *OpenShift Ansible Service Broker Operator* by GA (1 of 3)
+// TODO: Change to *OpenShift Ansible Service Broker Operator* by GA (2 of 5)
 . Select the *Automation Broker Operator*.
 . Under *Provided APIs*, click *Create New* for *Automation Broker*.
 . Review the default YAML, set any additional {asb-name} configuration options,
@@ -33,8 +33,8 @@ following items:
 
 * {asb-name} Pod status
 ** From the *Workloads* -> *Pods* page for the *ansible-service-broker* project,
-** verify that the Pod that starts with `asb-` has a status of *Running* and
-** readiness of *Ready*.
+verify that the Pod that starts with `asb-` has a status of *Running* and
+readiness of *Ready*.
 
 * Cluster service broker status
 ** From the *Catalog* -> *Broker Management* -> *Service Brokers* page, verify
diff --git a/modules/sb-start-tsb.adoc b/modules/sb-start-tsb.adoc
@@ -3,34 +3,34 @@
 // * applications/service_brokers/installing-template-service-broker.adoc
 
 [id="sb-start-tsb-{context}"]
-= Starting the template service broker
+= Starting the {tsb-name}
 
-After you have installed the template service broker Operator, you can start the
-template service broker using the following procedure.
+After you have installed the {tsb-name} Operator, you can start the
+{tsb-name} using the following procedure.
 
 .Prerequisites
 
 * You have installed the service catalog.
-* You have installed the template service broker Operator.
+* You have installed the {tsb-name} Operator.
 
 .Procedure
 
 . Navigate in the web console to *Catalog* -> *Installed Operators* and select the `template-service-broker` project.
 . Select the *Template Service Broker Operator*.
 . Under *Provided APIs*, click *Create New* for *Template Service Broker*.
 . Review the default YAML and click *Create*.
-. Verify that the template service broker has started.
+. Verify that the {tsb-name} has started.
 +
-After the template service broker has started, you can view the available
+After the {tsb-name} has started, you can view the available
 template applications by navigating to *Catalog* -> *Developer Catalog* and
 selecting the *Service Class* checkbox. Note that it may take a few minutes for
-the template service broker to start and the template applications to be
+the {tsb-name} to start and the template applications to be
 available.
 +
 If you do not yet see these Service classes, you can check the status of the
 following items:
 
-* Template service broker Pod status
+* {tsb-name} Pod status
 ** From the *Workloads* -> *Pods* page for the *template-service-broker*
 project, verify that the Pod that starts with `apiserver-` has a status of
 *Running* and readiness of *Ready*.
diff --git a/modules/sb-uninstall-asb.adoc b/modules/sb-uninstall-asb.adoc
@@ -0,0 +1,47 @@
+// Module included in the following assemblies:
+//
+// * applications/service_brokers/uninstalling-ansible-service-broker.adoc
+
+[id="sb-uninstall-asb-{context}"]
+= Uninstalling the {asb-name}
+
+The following procedure uninstalls the {asb-name} and its Operator using the
+web console.
+
+WARNING: Do not uninstall the {asb-name} if there are any provisioned services from it in your cluster, otherwise you might encounter errors when trying to manage the services.
+
+.Prerequisites
+
+* The {asb-name} is installed.
+
+.Procedure
+
+This procedure assumes that you installed the {asb-name} into the
+`ansible-service-broker` project.
+
+. Uninstall the {asb-name}.
+.. Navigate to *Catalog* -> *Installed Operators* and select the
+*ansible-service-broker* project from the drop-down menu.
+// TODO: Change to *OpenShift Ansible Service Broker Operator* by GA (4 of 5)
+.. Click *Automation Broker Operator*.
+.. Select the *Automation Broker* tab.
+.. Click *ansible-service-broker*.
+.. From the *Actions* drop-down menu, select *Delete Automation Broker*.
+.. Click *Delete* from the confirmation pop-up window.
++
+The {asb-name} is now uninstalled, and service bundles will soon be removed
+from the Developer Catalog.
+
+. Uninstall the {asb-name} Operator.
+.. Navigate to *Catalog* -> *Operator Management* and select the
+*ansible-service-broker* project from the drop-down menu.
+// TODO: Change to *OpenShift Ansible Service Broker Operator* by GA (5 of 5)
+.. Click *View subscription* for the *Automation Broker Operator*.
+.. Select *automationbroker*.
+.. From the *Actions* drop-down menu, select *Remove Subscription*.
+.. Verify that the checkbox is checked next to *Also completely remove the automationbroker Operator from the selected namespace* and click *Remove*.
++
+The {asb-name} Operator is no longer installed in your cluster.
+
+After the {asb-name} is uninstalled, users will no longer have access to the
+service bundles provided by the {asb-name}.
diff --git a/modules/sb-uninstall-tsb.adoc b/modules/sb-uninstall-tsb.adoc
diff --git a/modules/templates-exposing-object-fields.adoc b/modules/templates-exposing-object-fields.adoc
diff --git a/modules/templates-marking-as-bindable.adoc b/modules/templates-marking-as-bindable.adoc
diff --git a/modules/templates-waiting-for-readiness.adoc b/modules/templates-waiting-for-readiness.adoc
