Skip to content

Commit d8c0630

Browse files
committed
Update WTO uninstall docs to remove all CRDs
Update WTO uninstall process doc to * Make sure new CRDs added to the operator are removed as well * Mention that some resources may not be present, depending on the installation * Ensure all CRDs are removed during uninstallation Signed-off-by: Angel Misevski <[email protected]>
1 parent 0b29ce1 commit d8c0630

File tree

1 file changed

+29
-7
lines changed

1 file changed

+29
-7
lines changed

modules/odc-uninstalling-web-terminal.adoc

Lines changed: 29 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -31,7 +31,7 @@ Prior to {product-title} 4.8, the Web Terminal Operator used different CRDs to p
3131
.. Click the Options menu {kebab} for the Web Terminal Operator, and then select *Uninstall Operator*.
3232
.. In the *Uninstall Operator* confirmation dialog box, click *Uninstall* to remove the Operator, Operator deployments, and pods from the cluster. The Operator stops running and no longer receives updates.
3333
+
34-
. Run the following commands to ensure that all `DevWorkspace` CRs created for the Web Terminals are removed.
34+
. Remove the CRDs used by the Operator.
3535
+
3636
[source,terminal]
3737
----
@@ -55,7 +55,7 @@ The DevWorkspace Operator functions as a standalone Operator and may be required
5555
====
5656

5757
.Procedure
58-
. Run the following commands to ensure that all `DevWorkspace` CRs are removed along with their related Kubernetes objects, such as deployments.
58+
. Remove the `DevWorkspace` custom resources used by the Operator, along with any related Kubernetes objects, such as deployments.
5959
+
6060
[source,terminal]
6161
----
@@ -72,7 +72,12 @@ $ oc delete devworkspaceroutings.controller.devfile.io --all-namespaces --all --
7272
If this step is not complete, finalizers make it difficult to fully uninstall the Operator easily.
7373
====
7474
+
75-
. Run the following commands to remove the CRDs:
75+
. Remove the CRDs used by the Operator:
76+
+
77+
[WARNING]
78+
====
79+
The DevWorkspace Operator provides custom resource definitions (CRDs) that use conversion webhooks. Failing to remove these CRDs can cause issues on the cluster.
80+
====
7681
+
7782
[source,terminal]
7883
----
@@ -84,7 +89,24 @@ $ oc delete customresourcedefinitions.apiextensions.k8s.io devworkspaceroutings.
8489
$ oc delete customresourcedefinitions.apiextensions.k8s.io devworkspaces.workspace.devfile.io
8590
----
8691
+
87-
. Remove the `DevWorkspace-Webhook-Server` deployment, mutating, and validating webhooks:
92+
[source,terminal]
93+
----
94+
$ oc delete customresourcedefinitions.apiextensions.k8s.io devworkspacetemplates.workspace.devfile.io
95+
----
96+
+
97+
[source,terminal]
98+
----
99+
$ oc delete customresourcedefinitions.apiextensions.k8s.io devworkspaceoperatorconfigs.controller.devfile.io
100+
----
101+
+
102+
. Verify that all involved custom resource definitions are removed. The following command should not display any result.
103+
+
104+
[source,terminal]
105+
----
106+
$ oc get customresourcedefintions | grep "devfile.io"
107+
----
108+
+
109+
. Remove the `devworkspace-webhook-server` deployment, mutating, and validating webhooks:
88110
+
89111
[source,terminal]
90112
----
@@ -103,14 +125,14 @@ $ oc delete validatingwebhookconfigurations controller.devfile.io
103125
+
104126
[NOTE]
105127
====
106-
If you remove the `devworkspace-webhook-server` deployment without removing the mutating and validating webhooks, you will not be able use `oc exec` commands to run commands in a container on the cluster. After you remove the webhooks you will be able to use the `oc exec` commands again.
128+
If you remove the `devworkspace-webhook-server` deployment without removing the mutating and validating webhooks, you will not be able to use `oc exec` commands to run commands in a container on the cluster. After you remove the webhooks you will be able to use the `oc exec` commands again.
107129
====
108130
+
109-
. Run the following commands to remove any lingering services, secrets, and config maps:
131+
. Remove any remaining services, secrets, and config maps. Depending on the installation, some resources included in the following command may not exist on the cluster.
110132
+
111133
[source,terminal]
112134
----
113-
$ oc delete all --selector app.kubernetes.io/part-of=devworkspace-operator,app.kubernetes.io/name=devworkspace-webhook-server
135+
$ oc delete all --selector app.kubernetes.io/part-of=devworkspace-operator,app.kubernetes.io/name=devworkspace-webhook-server -n openshift-operators
114136
----
115137
+
116138
[source,terminal]

0 commit comments

Comments
 (0)