From 0cad5de86400fc27352fea59304bca00ff470a77 Mon Sep 17 00:00:00 2001 From: Leif Madsen Date: Tue, 28 Nov 2023 12:48:35 -0500 Subject: [PATCH] Add removal instructions for COO (#516) * Add removal instructions for COO Add removal instructions for Cluster Observability Operator, pointing at the existing product documentation. Closes: STF-1643 * Update based on editor feedback --- ...ng-stf-from-the-openshift-environment.adoc | 2 ++ ...f_removing-the-observability-operator.adoc | 34 +++++++++++++++++++ 2 files changed, 36 insertions(+) create mode 100644 doc-Service-Telemetry-Framework/modules/ref_removing-the-observability-operator.adoc diff --git a/doc-Service-Telemetry-Framework/assemblies/assembly_removing-stf-from-the-openshift-environment.adoc b/doc-Service-Telemetry-Framework/assemblies/assembly_removing-stf-from-the-openshift-environment.adoc index 35e17644..b9bce473 100644 --- a/doc-Service-Telemetry-Framework/assemblies/assembly_removing-stf-from-the-openshift-environment.adoc +++ b/doc-Service-Telemetry-Framework/assemblies/assembly_removing-stf-from-the-openshift-environment.adoc @@ -15,12 +15,14 @@ ifeval::["{build}" == "upstream"] . Remove the catalog source. endif::[] . Remove the cert-manager Operator. +. Remove the {ObservabilityOperator}. include::../modules/proc_deleting-the-namespace.adoc[leveloffset=+1] ifeval::["{build}" == "upstream"] include::../modules/proc_removing-the-catalogsource.adoc[leveloffset=+1] endif::[] include::../modules/proc_removing-the-cert-manager-operator.adoc[leveloffset=+1] +include::../modules/ref_removing-the-observability-operator.adoc[leveloffset=+1] //reset the context ifdef::parent-context[:context: {parent-context}] diff --git a/doc-Service-Telemetry-Framework/modules/ref_removing-the-observability-operator.adoc b/doc-Service-Telemetry-Framework/modules/ref_removing-the-observability-operator.adoc new file mode 100644 index 00000000..aac76fef --- /dev/null +++ b/doc-Service-Telemetry-Framework/modules/ref_removing-the-observability-operator.adoc @@ -0,0 +1,34 @@ +// Module included in the following assemblies: +// +// + +// This module can be included from assemblies using the following include statement: +// include::/proc_removing-the-cert-manager-operator.adoc[leveloffset=+1] + +// The file name and the ID are based on the module title. For example: +// * file name: proc_doing-procedure-a.adoc +// * ID: [id='proc_doing-procedure-a_{context}'] +// * Title: = Doing procedure A +// +// The ID is used as an anchor for linking to the module. Avoid changing +// it after the module has been published to ensure existing links are not +// broken. +// +// The `context` attribute enables module reuse. Every module's ID includes +// {context}, which ensures that the module has a unique ID even if it is +// reused multiple times in a guide. +// +// Start the title with a verb, such as Creating or Create. See also +// _Wording of headings_ in _The IBM Style Guide_. + +[id="removing-the-observability-operator_{context}"] += Removing the {ObservabilityOperator} + +[role="_abstract"] +If you are not using the {ObservabilityOperator} for any other applications, delete the Subscription, ClusterServiceVersion, and CustomResourceDefinitions. + +For more information about removing the {ObservabilityOperator}, see link:https://docs.openshift.com/container-platform/{NextSupportedOpenShiftVersion}/monitoring/cluster_observability_operator/installing-the-cluster-observability-operator.html#uninstalling-the-cluster-observability-operator-using-the-web-console_installing_the_cluster_observability_operator[Uninstalling the Cluster Observability Operator using the web console] in the _OpenShift Container Platform Documentation_. + +.Additional resources + +* link:https://docs.openshift.com/container-platform/{NextSupportedOpenShiftVersion}/operators/admin/olm-deleting-operators-from-cluster.html[Deleting Operators from a cluster].