You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
* Update install/uninstall docs for Web Terminal Operator
* Update web terminal uninstall to handle DevWorkspaces separately
Since the Web Terminal Operator installs the DevWorkspace operator as a
dependency, and since this dependency may be used for other operators as
well, rework the uninstall doc to separate out the two cases and make it
clear that the DevWorkspace Operator should only be uninstalled if it is
no longer needed.
* Fix wording for clarity and conventions
Signed-off-by: Angel Misevski <[email protected]>
Copy file name to clipboardExpand all lines: modules/odc-installing-web-terminal.adoc
+8-2Lines changed: 8 additions & 2 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -16,11 +16,17 @@ You can install the web terminal using the Web Terminal Operator listed in the {
16
16
. Read the brief description about the Operator on the *Web Terminal* page, and then click *Install*.
17
17
. On the *Install Operator* page, retain the default values for all fields.
18
18
19
-
** The *alpha* option in the *Update Channel* menu enables installation of the latest release of the Web Terminal Operator.
19
+
** The *fast* option in the *Update Channel* menu enables installation of the latest release of the Web Terminal Operator.
20
20
** The *All namespaces on the cluster* option in the *Installation Mode* menu enables the Operator to watch and be available to all namespaces in the cluster.
21
21
** The *openshift-operators* option in the *Installed Namespace* menu installs the Operator in the default `openshift-operators` namespace.
22
22
** The *Automatic* option in the *Approval Strategy* menu ensures that the future upgrades to the Operator are handled automatically by the Operator Lifecycle Manager.
23
23
24
24
. Click *Install*.
25
-
. In the *Installed Operators* page, click the *View operator* to verify that the Operator is listed on the *Installed Operators* page.
25
+
. In the *Installed Operators* page, click the *View Operator* to verify that the Operator is listed on the *Installed Operators* page.
26
+
+
27
+
[NOTE]
28
+
====
29
+
Prior to {product-title} 4.8, the Web Terminal Operator bundled all its functionality in a single Operator. As of {product-title} 4.8, the Web Terminal Operator installs the DevWorkspace Operator as a dependency to provide the same features.
30
+
====
31
+
26
32
. After the Operator is installed, refresh your page to see the command line terminal icon on the upper right of the console.
Copy file name to clipboardExpand all lines: modules/odc-uninstalling-web-terminal.adoc
+54-34Lines changed: 54 additions & 34 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -7,34 +7,64 @@
7
7
8
8
Uninstalling the web terminal is a two-step process:
9
9
10
-
. Delete the components and custom resources (CRs) that were added when you installed the Operator.
11
-
. Uninstall the Web Terminal Operator.
10
+
. Uninstall the Web Terminal Operator and related custom resources (CRs) that were added when you installed the Operator.
11
+
. Uninstall the DevWorkspace Operator and its related custom resources that were added as a dependency of the Web Terminal Operator.
12
12
13
13
Uninstalling the Web Terminal Operator does not remove any of its custom resource definitions (CRDs) or managed resources that are created when the Operator is installed. These components must be manually uninstalled for security purposes. Removing these components also allows you to save cluster resources by ensuring that terminals do not idle when the Operator is uninstalled.
14
14
15
15
.Prerequisites
16
16
* Access to an {product-title} cluster using an account with `cluster-admin` permissions.
17
17
18
-
== Deleting the web terminal components and custom resources
18
+
== Removing the Web Terminal Operator and the custom resources that support it
19
19
20
-
Use the CLI to delete the CRs that are created during installation of the Web Terminal Operator.
20
+
Use the console and the CLI to delete any existing web terminals and CRs that were created during the installation of the Web Terminal Operator.
21
+
22
+
[NOTE]
23
+
====
24
+
Prior to {product-title} 4.8, the Web Terminal Operator used different CRDs to provide Web Terminal capabilities. To uninstall versions 1.2.1 and below of the Web Terminal Operator, refer to the documentation for {product-title} 4.7.
25
+
====
21
26
22
27
.Procedure
23
-
. Run the following commands to ensure that all `DevWorkspace` CRs are removed along with their related Kubernetes objects, such as deployments.
28
+
. Uninstall the Web Terminal Operator using the web console:
29
+
.. In the *Administrator* perspective of the web console, navigate to *Operators -> Installed Operators*.
30
+
.. Scroll the filter list or type a keyword into the *Filter by name* box to find the *Web Terminal* Operator.
31
+
.. Click the Options menu {kebab} for the Web Terminal Operator, and then select *Uninstall Operator*.
32
+
.. 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.
33
+
+
34
+
. Run the following commands to ensure that all `DevWorkspace` CRs created for the Web Terminals are removed.
Use the CLI to delete the custom resource definitions (CRDs) and additional resources that are created during installation of the Web Terminal Operator.
51
+
52
+
[IMPORTANT]
53
+
====
54
+
The DevWorkspace Operator functions as a standalone Operator and may be required as a dependency for other Operators installed on the cluster (for example, the CodeReady Workspaces Operator may depend on it). Follow the steps below only if you are sure the DevWorkspace Operator is no longer needed.
55
+
====
56
+
57
+
.Procedure
58
+
. Run the following commands to ensure that all `DevWorkspace` CRs are removed along with their related Kubernetes objects, such as deployments.
When you run this and the following steps, you cannot use the `oc exec` commands to run commands in a container. After you remove the webhooks you will be able to use the `oc exec` commands again.
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.
72
107
====
73
108
+
74
109
. Run the following commands to remove any lingering services, secrets, and config maps:
== Uninstalling the Operator using the web console
114
-
115
-
.Procedure
116
-
117
-
. In the *Administrator* perspective of the web console, navigate to *Operators -> Installed Operators*.
118
-
. Scroll the filter list or type a keyword into the *Filter by name* box to find the *Web Terminal* Operator.
119
-
. Click the Options menu {kebab} for the Web Terminal Operator, and then select *Uninstall Operator*.
120
-
. 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.
136
+
. Uninstall the Operator using the web console:
137
+
.. In the *Administrator* perspective of the web console, navigate to *Operators -> Installed Operators*.
138
+
.. Scroll the filter list or type a keyword into the *Filter by name* box to find the *DevWorkspace* Operator.
139
+
.. Click the Options menu {kebab} for the DevWorkspace Operator, and then select *Uninstall Operator*.
140
+
.. 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.
0 commit comments