Skip to content

Commit 48e60fb

Browse files
author
mikemckiernan
authored
Merge pull request #31939 from neal-timpe/ossmdoc-308
OSSMDOC-308: Uninstall reorg
2 parents e317e99 + c75fb17 commit 48e60fb

File tree

7 files changed

+19
-142
lines changed

7 files changed

+19
-142
lines changed

‎_topic_map.yml‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -2612,7 +2612,7 @@ Topics:
26122612
File: ossm-deploy-production
26132613
- Name: Using the 3scale Istio adapter
26142614
File: threescale-adapter
2615-
- Name: Removing Service Mesh
2615+
- Name: Uninstalling Service Mesh
26162616
File: removing-ossm
26172617
- Name: Configuration reference
26182618
File: ossm-reference

‎modules/ossm-control-plane-remove.adoc‎

Lines changed: 3 additions & 25 deletions
Original file line numberDiff line numberDiff line change
@@ -6,18 +6,13 @@
66
[id="ossm-control-plane-remove_{context}"]
77
= Removing the {ProductName} control plane
88

9-
You can remove the {ProductShortName} control plane by using the {product-title} web console or the CLI.
10-
9+
To uninstall {ProductShortName} from an existing {product-title} instance, you must first delete the control plane and the Operators. Then, you must run commands to manually remove residual resources.
1110

1211
[id="ossm-control-plane-remove-operatorhub_{context}"]
1312
== Removing the control plane with the web console
1413

1514
You can remove the {ProductName} control plane by using the web console.
1615

17-
.Prerequisites
18-
19-
* The {ProductName} control plane must be deployed.
20-
2116
.Procedure
2217

2318
. Log in to the {product-title} web console.
@@ -34,42 +29,25 @@ You can remove the {ProductName} control plane by using the web console.
3429

3530
. Click *Delete* on the confirmation dialog window to remove the `ServiceMeshControlPlane`.
3631

37-
38-
3932
[id="ossm-control-plane-remove-cli_{context}"]
4033
== Removing the control plane from the CLI
4134

4235
You can remove the {ProductName} control plane by using the CLI.
4336

44-
.Prerequisites
45-
* The {ProductName} control plane must be deployed.
46-
* Access to the {product-title} Command-line Interface (CLI) also known as `oc`.
47-
4837
.Procedure
4938

50-
[NOTE]
51-
====
52-
When you remove the `ServiceMeshControlPlane`, {ProductShortName} tells the Operator to begin uninstalling everything it installed.
53-
====
54-
55-
[TIP]
56-
====
57-
You can use the shortened `smcp` alias in place of `servicemeshcontrolplane`.
58-
====
59-
6039
. Log in to the {product-title} CLI.
6140

6241
. Run this command to retrieve the name of the installed `ServiceMeshControlPlane`:
6342
+
6443
[source,terminal]
6544
----
66-
$ oc get servicemeshcontrolplanes -n istio-system
45+
$ oc get smcp -n istio-system
6746
----
6847

69-
+
7048
. Replace `<name_of_custom_resource>` with the output from the previous command, and run this command to remove the custom resource:
7149
+
7250
[source,terminal]
7351
----
74-
$ oc delete servicemeshcontrolplanes -n istio-system <name_of_custom_resource>
52+
$ oc delete smcp -n istio-system <name_of_custom_resource>
7553
----

‎modules/ossm-member-roll-delete.adoc‎

Lines changed: 0 additions & 9 deletions
This file was deleted.

‎modules/ossm-remove-cleanup.adoc‎

Lines changed: 2 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -6,12 +6,7 @@
66
[id="ossm-remove-cleanup_{context}"]
77
= Clean up Operator resources
88

9-
You can manually remove resources left behind after removing the {ProductName} Operator using the OpenShift console.
10-
11-
.Prerequisites
12-
13-
* An account with cluster administration access.
14-
* Access to the {product-title} Command-line Interface (CLI) also known as `oc`.
9+
Follow this procedure to manually remove resources left behind after removing the {ProductName} Operator by using the OpenShift console.
1510

1611
.Procedure
1712

@@ -21,7 +16,7 @@ You can manually remove resources left behind after removing the {ProductName} O
2116
+
2217
[NOTE]
2318
====
24-
The Operators are installed in the `openshift-operators` namespace by default. If you installed the Operators in another namespace, replace `openshift-operators` with the name of the project where the {ProductName} Operator was installed.
19+
The Openshift Elasticsearch operator is installed in `openshift-operators-redhat` by default. The other Operators are installed in the `openshift-operators` namespace by default. If you installed the Operators in another namespace, replace `openshift-operators` with the name of the project where the {ProductName} Operator was installed.
2520
====
2621
+
2722
[source,terminal]

‎modules/ossm-remove-operators.adoc‎

Lines changed: 9 additions & 92 deletions
Original file line numberDiff line numberDiff line change
@@ -6,105 +6,22 @@
66
[id="ossm-operatorhub-remove-operators_{context}"]
77
= Removing the installed Operators
88

9-
You must remove the Operators to successfully remove {ProductName}. Once you remove the {ProductName} Operator, you must remove the Kiali Operator, the Jaeger Operator, and the OpenShift Elasticsearch Operator.
9+
You must remove the Operators to successfully remove {ProductName}. Once you remove the {ProductName} Operator, you must remove the Kiali Operator, the Jaeger Operator, and the OpenShift Elasticsearch Operator.
1010

1111
[id="ossm-remove-operator-servicemesh_{context}"]
12-
== Removing the {ProductName} Operator
12+
== Removing the Operators
1313

14-
Follow this procedure to remove the {ProductName} Operator.
14+
Follow this procedure to remove the Operators that make up {ProductName}. Repeat the steps for each of the following Operators.
1515

16-
.Prerequisites
17-
18-
* Access to the {product-title} web console.
19-
* The {ProductName} Operator must be installed.
20-
21-
.Procedure
22-
23-
. Log in to the {product-title} web console.
24-
25-
. From the *Operators* → *Installed Operators* page, scroll or type a keyword into the *Filter by name* to find the {ProductName} Operator. Then, click on it.
26-
27-
. On the right-hand side of the *Operator Details* page, select *Uninstall Operator* from the *Actions* drop-down menu.
28-
29-
. When prompted by the *Remove Operator Subscription* window, optionally select the
30-
*Also completely remove the Operator from the selected namespace*
31-
check box if you want all components related to the installation to be removed.
32-
This removes the CSV, which in turn removes the pods, Deployments, CRDs, and CRs associated with the Operator.
33-
34-
[id="ossm-remove-operator-kiali_{context}"]
35-
== Removing the Kiali Operator
36-
37-
Follow this procedure to remove the Kiali Operator.
38-
39-
.Prerequisites
40-
41-
* Access to the {product-title} web console.
42-
* The Kiali Operator must be installed.
16+
* {ProductName}
17+
* Kiali
18+
* Jaeger
19+
* OpenShift Elasticsearch
4320

4421
.Procedure
4522

4623
. Log in to the {product-title} web console.
4724

48-
. From the *Operators* → *Installed Operators* page, scroll or type a keyword into
49-
the *Filter by name* to find the Kiali Operator. Then, click on it.
50-
51-
. On the right-hand side of the *Operator Details* page, select *Uninstall
52-
Operator* from the *Actions* drop-down menu.
53-
54-
. When prompted by the *Remove Operator Subscription* window, optionally select the
55-
*Also completely remove the Operator from the selected namespace*
56-
check box if you want all components related to the installation to be removed.
57-
This removes the CSV, which in turn removes the pods, Deployments, CRDs, and CRs
58-
associated with the Operator.
59-
60-
[id="ossm-remove-operator-jaeger_{context}"]
61-
== Removing the Jaeger Operator
62-
63-
Follow this procedure to remove the Jaeger Operator.
64-
65-
.Prerequisites
66-
67-
* Access to the {product-title} web console.
68-
* The Jaeger Operator must be installed.
69-
70-
.Procedure
71-
72-
. Log in to the {product-title} web console.
73-
74-
. From the *Operators* → *Installed Operators* page, scroll or type a keyword into
75-
the *Filter by name* to find the Jaeger Operator. Then, click on it.
76-
77-
. On the right-hand side of the *Operator Details* page, select *Uninstall
78-
Operator* from the *Actions* drop-down menu.
79-
80-
. When prompted by the *Remove Operator Subscription* window, optionally select the
81-
*Also completely remove the Operator from the selected namespace*
82-
check box if you want all components related to the installation to be removed.
83-
This removes the CSV, which in turn removes the pods, Deployments, CRDs, and CRs
84-
associated with the Operator.
85-
86-
[id="ossm-remove-operator-elasticsearch_{context}"]
87-
== Removing the OpenShift Elasticsearch Operator
88-
89-
Follow this procedure to remove the OpenShift Elasticsearch Operator.
90-
91-
.Prerequisites
92-
93-
* Access to the {product-title} web console.
94-
* The OpenShift Elasticsearch Operator must be installed.
95-
96-
.Procedure
97-
98-
. Log in to the {product-title} web console.
99-
100-
. From the *Operators* → *Installed Operators* page, scroll or type a keyword into
101-
the *Filter by name* to find the OpenShift Elasticsearch Operator. Then, click on it.
102-
103-
. On the right-hand side of the *Operator Details* page, select *Uninstall
104-
Operator* from the *Actions* drop-down menu.
25+
. From the *Operators* → *Installed Operators* page, scroll or type a keyword into the *Filter by name* to find each Operator. Then, click the Operator name.
10526

106-
. When prompted by the *Remove Operator Subscription* window, optionally select the
107-
*Also completely remove the Operator from the selected namespace*
108-
check box if you want all components related to the installation to be removed.
109-
This removes the CSV, which in turn removes the pods, Deployments, CRDs, and CRs
110-
associated with the Operator.
27+
. On the the *Operator Details* page, select *Uninstall Operator* from the *Actions* menu. Follow the prompts to uninstall each Operator.

‎service_mesh/v1x/removing-ossm.adoc‎

Lines changed: 1 addition & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -5,9 +5,7 @@ include::modules/ossm-document-attributes-1x.adoc[]
55

66
toc::[]
77

8-
This process allows you to remove {ProductName} from an existing {product-title} instance. Remove the control plane before removing the operators.
9-
10-
include::modules/ossm-member-roll-delete.adoc[leveloffset=+1]
8+
To remove {ProductName} from an existing {product-title} instance, remove the control plane before removing the operators.
119

1210
include::modules/ossm-control-plane-remove.adoc[leveloffset=+1]
1311

‎service_mesh/v2x/removing-ossm.adoc‎

Lines changed: 3 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -1,16 +1,14 @@
11
[id="removing-ossm"]
2-
= Removing {ProductName}
2+
= Uninstalling {ProductName}
33
include::modules/ossm-document-attributes.adoc[]
44
:context: removing-ossm
55

66
toc::[]
77

8-
This process allows you to remove {ProductName} from an existing {product-title} instance. Remove the control plane before removing the operators.
9-
10-
include::modules/ossm-member-roll-delete.adoc[leveloffset=+1]
8+
To uninstall {ProductName} from an existing {product-title} instance and remove its resources, you must delete the control plane, delete the Operators, and run commands to manually remove some resources.
119

1210
include::modules/ossm-control-plane-remove.adoc[leveloffset=+1]
1311

1412
include::modules/ossm-remove-operators.adoc[leveloffset=+1]
1513

16-
include::modules/ossm-remove-cleanup.adoc[leveloffset=+2]
14+
include::modules/ossm-remove-cleanup.adoc[leveloffset=+1]

0 commit comments

Comments
 (0)