Merge pull request #60213 from abrennan89/5264

RHDEVDOCS-5264 + RHDEVDOCS-5304 + RHDEVDOCS-5349: Clean up web terminal docs and add new config section

Author: abrennan89

_attributes/common-attributes.adoc

@@ -178,5 +178,7 @@ endif::[]
 :ztp: GitOps ZTP
 :3no: three-node OpenShift
 :3no-caps: Three-node OpenShift
-:web-terminal-op: Web Terminal Operator
 :run-once-operator: Run Once Duration Override Operator
+// Web terminal
+:web-terminal-op: Web Terminal Operator
+:devworkspace-op: DevWorkspace Operator

_topic_maps/_topic_map.yml

@@ -761,9 +761,20 @@ Topics:
     File: dynamic-plug-in-example
   - Name: Dynamic plugin reference
     File: dynamic-plug-ins-reference
-- Name: Using the web terminal
-  File: odc-using-web-terminal
+- Name: Web terminal
+  Dir: web_terminal
   Distros: openshift-enterprise,openshift-online
+  Topics:
+  - Name: Installing the web terminal
+    File: installing-web-terminal
+  - Name: Configuring the web terminal
+    File: configuring-web-terminal    
+  - Name: Using the web terminal
+    File: odc-using-web-terminal
+  - Name: Troubleshooting the web terminal
+    File: troubleshooting-web-terminal
+  - Name: Uninstalling the web terminal
+    File: uninstalling-web-terminal
 - Name: Disabling the web console
   File: disabling-web-console
   Distros: openshift-enterprise,openshift-origin

applications/working_with_helm_charts/configuring-custom-helm-chart-repositories.adoc

@@ -32,7 +32,7 @@ include::modules/odc-creating-helm-releases-using-developer-perspective.adoc[lev
 
 == Using Helm in the web terminal
 
-You can use Helm by xref:../../web_console/odc-using-web-terminal.adoc#odc-access-web-terminal_odc-using-web-terminal[Accessing the web terminal] in the *Developer* perspective of the web console.
+You can use Helm by xref:../../web_console/web_terminal/odc-using-web-terminal.adoc#odc-access-web-terminal_odc-using-web-terminal[Accessing the web terminal] in the *Developer* perspective of the web console.
 
 include::modules/helm-creating-a-custom-helm-chart-on-openshift.adoc[leveloffset=+1]
 

modules/configure-web-terminal-image-admin.adoc

@@ -0,0 +1,21 @@
+// Module is included in the following assemblies:
+//
+// * web_console/web_terminal/configuring-web-terminal.adoc
+
+:_content-type: PROCEDURE
+
+[id="configure-web-terminal-image-admin_{context}"]
+= Configuring the web terminal image for all users
+
+You can use the *Administrator* perspective of the web console to set the default web terminal image for all users.
+
+.Prerequisites
+
+* You have cluster administrator permissions and are logged in to the web console.
+* You have installed the {web-terminal-op}.
+
+include::snippets/access-cluster-configuration-console.adoc[]
+
+. Click the *Web Terminal* tab, which opens the *Web Terminal Configuration* page.
+. Enter the URL of the image that you want to use.
+. Click *Save*.

modules/configure-web-terminal-timeout-admin.adoc

@@ -0,0 +1,21 @@
+// Module is included in the following assemblies:
+//
+// * web_console/web_terminal/configuring-web-terminal.adoc
+
+:_content-type: PROCEDURE
+
+[id="configure-web-terminal-timeout-admin_{context}"]
+= Configuring the web terminal timeout for all users
+
+You can use the *Administrator* perspective of the web console to set the default web terminal timeout period for all users.
+
+.Prerequisites
+
+* You have cluster administrator permissions and are logged in to the web console.
+* You have installed the {web-terminal-op}.
+
+include::snippets/access-cluster-configuration-console.adoc[]
+
+. Click the *Web Terminal* tab, which opens the *Web Terminal Configuration* page.
+. Set a value for the timeout. From the drop-down list, select a time interval of *Seconds*, *Minutes*, *Hours*, or *Milliseconds*.
+. Click *Save*.

modules/disable-quickstarts-admin-console.adoc

@@ -11,17 +11,7 @@ You can use the *Administrator* perspective of the web console to disable one or
 
 * You have cluster administrator permissions and are logged in to the web console.
 
-.Procedure
-
-. In the *Administrator* perspective, navigate to *Administation* -> *Cluster Settings*.
-. On the *Cluster Settings* page, click the *Configuration* tab.
-. On the *Configuration* page, click the *Console* configuration resource with the description *operator.openshift.io*.
-+
-image::cluster-settings-console.png[Image of the Configuration page showing the correct Console configuration resource to select]
-
-. From the *Action* drop-down list, select *Customize*, which opens the *Cluster configuration* page.
-+
-image::cluster-configuration-general-tab.png[Cluster configuration page open on the General tab]
+include::snippets/access-cluster-configuration-console.adoc[]
 
 . On the *General* tab, in the *Quick starts* section, you can select items in either the *Enabled* or *Disabled* list, and move them from one list to the other by using the arrow buttons.
 

modules/odc-access-web-terminal.adoc

@@ -1,16 +1,23 @@
 // Module included in the following assemblies:
 //
-// web_console/odc-using-web-terminal.adoc
+// web_console/web_terminal/odc-using-web-terminal.adoc
 
 :_content-type: PROCEDURE
 [id="odc-access-web-terminal_{context}"]
 = Accessing the web terminal
 
 After the {web-terminal-op} is installed, you can access the web terminal.
+You can re-run commands by selecting them from the list of commands you have run in the terminal. These commands persist across multiple terminal sessions.
+The web terminal remains open until you close it or until you close the browser window or tab.
+
+.Prerequisites
+
+* You have access to an {product-title} cluster and are logged into the web console.
+* The {web-terminal-op} is installed on your cluster.
 
 .Procedure
 
-. 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.
+. To launch the web terminal, click the command line terminal icon (image:odc-wto-icon.png[title="wto icon"]) in the masthead of the console. A web terminal instance is displayed in the *Command line terminal* pane. This instance is automatically logged in with your credentials.
 
 . Select the project where the `DevWorkspace` CR must be created from the *Project* drop-down list. By default, the current project is selected.
 +
@@ -19,23 +26,7 @@ After the {web-terminal-op} is installed, you can access the web terminal.
 * The `DevWorkspace` CR is created only if it does not already exist.
 * The `openshift-terminal` project is the default project used for cluster administrators. They do not have the option to choose another project.
 ====
-+
-. Click *Start* to initialize the web terminal using the selected project.
-+
-After the web terminal is initialized, you can use the preinstalled CLI tools like `oc`, `kubectl`, `odo`, `kn`, `tkn`, `helm`, `kubens`, `subctl`, and `kubectx` in the web terminal.
-+
-. Click *+* to open multiple tabs within web terminal in the console.
-+
-[NOTE]
-====
-* You can re-run commands by selecting them from the list of commands you have run in the terminal. These commands persist across multiple terminal sessions.
-
-* The web terminal remains open until you close it or you close the browser window or tab.
-====
-
-[id="web-terminal-and-network-policies_{context}"]
-== Web terminal and network policies
 
-The web terminal might fail to launch if the cluster has network policies configured. To initialize a web terminal instance, the {web-terminal-op} must communicate with the web terminal's pod to verify it is running, and the {product-title} web console needs to send information to automatically log in to the cluster within the terminal. If either step fails, the web terminal fails to initialize and the terminal panel appears to be in a loading state.
+. Click *Start* to initialize the web terminal using the selected project. After the web terminal is initialized, you can use the preinstalled CLI tools like `oc`, `kubectl`, `odo`, `kn`, `tkn`, `helm`, `kubens`, `subctl`, and `kubectx` in the web terminal.
 
-To avoid this issue, ensure that the network policies for namespaces that are used for terminals allow ingress from the `openshift-console` and `openshift-operators` namespaces.
+. Click *+* to open multiple tabs within the web terminal in the console.

modules/odc-configure-web-terminal-image-session.adoc

@@ -0,0 +1,22 @@
+
+// Module is included in the following assemblies:
+//
+// * web_console/web_terminal/configuring-web-terminal.adoc
+
+:_content-type: PROCEDURE
+[id="odc-configure-web-terminal-image-session_{context}"]
+= Configuring the web terminal image for a session
+
+You can change the default image for the web terminal for your current session.
+
+.Prerequisites
+
+* You have access to an {product-title} cluster that has the {web-terminal-op} installed.
+* You are logged into the web console.
+
+.Procedure
+
+. Click the web terminal icon (image:odc-wto-icon.png[title="web terminal icon"]).
+. Click *Image* to display advanced configuration options for the web terminal image.
+. Enter the URL of the image that you want to use.
+. Click *Start* to begin a terminal instance using the specified image setting.

modules/odc-configure-web-terminal-timeout-session.adoc

@@ -0,0 +1,22 @@
+
+// Module is included in the following assemblies:
+//
+// * web_console/web_terminal/configuring-web-terminal.adoc
+
+:_content-type: PROCEDURE
+[id="odc-configure-web-terminal-timeout-session_{context}"]
+= Configuring the web terminal timeout for a session
+
+You can change the default timeout period for the web terminal for your current session.
+
+.Prerequisites
+
+* You have access to an {product-title} cluster that has the {web-terminal-op} installed.
+* You are logged into the web console.
+
+.Procedure
+
+. Click the web terminal icon (image:odc-wto-icon.png[title="web terminal icon"]).
+. Click *Timeout* to display advanced configuration options for the web terminal timeout.
+. Set a value for the timeout. From the drop-down list, select a time interval of *Seconds*, *Minutes*, *Hours*, or *Milliseconds*.
+. Click *Start* to begin a terminal instance using the specified timeout setting.