Skip to content

Commit 3ab40d5

Browse files
jeana-redhatjeana-redhat
authored
Merge pull request #28480 from Preeticp/WTO
Web terminal docs
2 parents edeb8e2 + a04cc64 commit 3ab40d5

File tree

7 files changed

+194
-1
lines changed

7 files changed

+194
-1
lines changed

‎_topic_map.yml‎

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -443,6 +443,8 @@ Topics:
443443
Distros: openshift-enterprise,openshift-webscale,openshift-origin
444444
- Name: Developer perspective
445445
File: odc-about-developer-perspective
446+
- Name: Web terminal
447+
File: odc-about-web-terminal
446448
- Name: Disabling the web console
447449
File: disabling-web-console
448450
Distros: openshift-enterprise,openshift-webscale,openshift-origin

‎images/odc-wto-icon.png‎

846 Bytes
Loading

‎modules/odc-accessing-developer-perspective.adoc‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -3,7 +3,7 @@
33
// web_console/odc-about-developer-perspective.adoc
44

55
[id="accessing-developer-perspective_{context}"]
6-
= Accessing Developer Perspective
6+
= Accessing the Developer perspective
77

88
The *Developer* perspective in the {product-title} web console provides workflows specific to developer use cases.
99

‎modules/odc-installing-web-terminal.adoc‎

Lines changed: 26 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,26 @@
1+
// Module included in the following assemblies:
2+
//
3+
// web_console/odc-about-web-terminal.adoc
4+
5+
[id="odc-installing-web-terminal_{context}"]
6+
= Installing the web terminal
7+
8+
You can install the web terminal using the Web Terminal Operator listed in the {product-title} OperatorHub. When you install the Web Terminal Operator, the custom resource definitions (CRDs) that are required for the command line configuration, such as the `DevWorkspace` CRD, are automatically installed. The web console creates the required resources when you open the web terminal.
9+
10+
.Prerequisites
11+
* Access to an {product-title} cluster using an account with `cluster-admin` permissions.
12+
13+
.Procedure
14+
. In the *Administrator* perspective of the web console, navigate to *Operators -> OperatorHub*.
15+
. Use the *Filter by keyword* box to search for the `Web Terminal` Operator in the catalog, and then click the *Web Terminal* tile.
16+
. Read the brief description about the Operator on the *Web Terminal* page, and then click *Install*.
17+
. On the *Install Operator* page, retain the default values for all fields.
18+
19+
** The *alpha* option in the *Update Channel* menu enables installation of the latest release of the Web Terminal Operator.
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+
** The *openshift-operators* option in the *Installed Namespace* menu installs the Operator in the default `openshift-operators` namespace.
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+
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.
26+
. After the Operator is installed, refresh your page to see the command line terminal icon on the upper right of the console.

‎modules/odc-uninstalling-web-terminal.adoc‎

Lines changed: 120 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,120 @@
1+
// Module included in the following assemblies:
2+
//
3+
// web_console/odc-about-web-terminal.adoc
4+
5+
[id="odc-uninstalling-web-terminal_{context}"]
6+
= Uninstalling the web terminal
7+
8+
Uninstalling the web terminal is a two-step process:
9+
10+
. Delete the components and custom resources (CRs) that were added when you installed the Operator.
11+
. Uninstall the Web Terminal Operator.
12+
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+
15+
.Prerequisites
16+
* Access to an {product-title} cluster using an account with `cluster-admin` permissions.
17+
18+
== Deleting the web terminal components and custom resources
19+
20+
Use the CLI to delete the CRs that are created during installation of the Web Terminal Operator.
21+
22+
.Procedure
23+
. Run the following commands to ensure that all `DevWorkspace` CRs are removed along with their related Kubernetes objects, such as deployments.
24+
+
25+
[source,terminal]
26+
----
27+
$ oc delete devworkspaces.workspace.devfile.io --all-namespaces --all --wait
28+
----
29+
+
30+
[source,terminal]
31+
----
32+
$ oc delete workspaceroutings.controller.devfile.io --all-namespaces --all --wait
33+
----
34+
+
35+
[source,terminal]
36+
----
37+
$ oc delete components.controller.devfile.io --all-namespaces --all --wait
38+
----
39+
+
40+
[WARNING]
41+
====
42+
If this step is not complete, finalizers make it difficult to fully uninstall the Operator easily.
43+
====
44+
+
45+
. Run the following commands to remove the CRDs:
46+
+
47+
[source,terminal]
48+
----
49+
$ oc delete customresourcedefinitions.apiextensions.k8s.io workspaceroutings.controller.devfile.io
50+
----
51+
+
52+
[source,terminal]
53+
----
54+
$ oc delete customresourcedefinitions.apiextensions.k8s.io components.controller.devfile.io
55+
----
56+
+
57+
[source,terminal]
58+
----
59+
$ oc delete customresourcedefinitions.apiextensions.k8s.io devworkspaces.workspace.devfile.io
60+
----
61+
+
62+
. Remove the `DevWorkspace-Webhook-Server` deployment:
63+
+
64+
[source,terminal]
65+
----
66+
$ oc delete deployment/devworkspace-webhook-server -n openshift-operators
67+
----
68+
+
69+
[NOTE]
70+
====
71+
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.
72+
====
73+
+
74+
. Run the following commands to remove any lingering services, secrets, and config maps:
75+
+
76+
[source,terminal]
77+
----
78+
$ oc delete all --selector app.kubernetes.io/part-of=devworkspace-operator,app.kubernetes.io/name=devworkspace-webhook-server
79+
----
80+
+
81+
[source,terminal]
82+
----
83+
$ oc delete serviceaccounts devworkspace-webhook-server -n openshift-operators
84+
----
85+
+
86+
[source,terminal]
87+
----
88+
$ oc delete configmap devworkspace-controller -n openshift-operators
89+
----
90+
+
91+
[source,terminal]
92+
----
93+
$ oc delete clusterrole devworkspace-webhook-server
94+
----
95+
+
96+
[source,terminal]
97+
----
98+
$ oc delete clusterrolebinding devworkspace-webhook-server
99+
----
100+
+
101+
. Run the following commands to remove mutating or validating webhook configurations:
102+
+
103+
[source,terminal]
104+
----
105+
$ oc delete mutatingwebhookconfigurations controller.devfile.io
106+
----
107+
+
108+
[source,terminal]
109+
----
110+
$ oc delete validatingwebhookconfigurations controller.devfile.io
111+
----
112+
113+
== 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.

‎modules/odc-using-web-terminal.adoc‎

Lines changed: 21 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,21 @@
1+
// Module included in the following assemblies:
2+
//
3+
// web_console/odc-about-web-terminal.adoc
4+
5+
[id="odc-using-web-terminal_{context}"]
6+
= Using the web terminal
7+
8+
After the Web Terminal Operator is installed, you can use the web terminal as follows:
9+
10+
. To launch the web terminal, click the command line terminal icon (image:odc-wto-icon.png[title="wto icon"]) on the upper right of the console. A web terminal instance is displayed in the *Command line terminal* pane. This instance is automatically logged in with your credentials.
11+
. Select the project where the `DevWorkspace` CR must be created from the *Project* drop-down list. By default, the current project is selected.
12+
+
13+
[NOTE]
14+
====
15+
* The `DevWorkspace` CR is created only if it does not already exist.
16+
* The `openshift-terminal` project is the default project used for cluster administrators. They do not have the option to choose another project.
17+
====
18+
+
19+
. Click *Start* to initialize the web terminal using the selected project.
20+
21+
After the web terminal is initialized, you can use the preinstalled CLI tools like `oc`, `kubectl`, `odo`, `kn`, `tkn`, `helm`, `kubens`, and `kubectx` in the web terminal.

‎web_console/odc-about-web-terminal.adoc‎

Lines changed: 24 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,24 @@
1+
[id="odc-about-web-terminal"]
2+
= About the web terminal in the web console
3+
include::modules/common-attributes.adoc[]
4+
:context: odc-about-web-terminal
5+
6+
toc::[]
7+
8+
You can launch an embedded command line terminal instance in the OpenShift web console. You must first install the Web Terminal Operator to use the web terminal.
9+
10+
[NOTE]
11+
====
12+
Cluster administrators can access the web terminal in {product-title} 4.7 and later.
13+
====
14+
15+
This terminal instance is preinstalled with common CLI tools for interacting with the cluster, such as `oc`, `kubectl`,`odo`, `kn`, `tkn`, `helm`, `kubens`, and `kubectx`. It also has the context of the project you are working on and automatically logs you in using your credentials.
16+
17+
:FeatureName: Web terminal
18+
include::modules/technology-preview.adoc[leveloffset=+1]
19+
20+
include::modules/odc-installing-web-terminal.adoc[leveloffset=+1]
21+
22+
include::modules/odc-using-web-terminal.adoc[leveloffset=+1]
23+
24+
include::modules/odc-uninstalling-web-terminal.adoc[leveloffset=+1]

0 commit comments

Comments
 (0)