1
0
mirror of https://github.com/openshift/openshift-docs.git synced 2026-02-05 12:46:18 +01:00

Clean up web terminal docs and add new config section

This commit is contained in:
Ashleigh Brennan
2023-05-18 14:54:08 -05:00
committed by openshift-cherrypick-robot
parent e483705f1c
commit 6613a14d8b
24 changed files with 377 additions and 223 deletions

View File

@@ -1,18 +0,0 @@
:_content-type: ASSEMBLY
[id="odc-using-web-terminal"]
= Using the web terminal
include::_attributes/common-attributes.adoc[]
:context: odc-using-web-terminal
toc::[]
You can launch an embedded command line terminal instance in the web console. You must first install the {web-terminal-op} to use the web terminal.
This terminal instance is preinstalled with common CLI tools for interacting with the cluster, such as `oc`, `kubectl`,`odo`, `kn`, `tkn`, `helm`, `kubens`, `subctl`, and `kubectx`. It also has the context of the project you are working on and automatically logs you in using your credentials.
:FeatureName: Web terminal
include::modules/odc-installing-web-terminal.adoc[leveloffset=+1]
include::modules/odc-access-web-terminal.adoc[leveloffset=+1]
include::modules/odc-uninstalling-web-terminal.adoc[leveloffset=+1]

View File

@@ -24,6 +24,6 @@ include::modules/odc-accessing-perspectives.adoc[leveloffset=+1]
* xref:../web_console/using-dashboard-to-get-cluster-information.adoc#using-dashboard-to-get-cluster-info[Viewing cluster information]
* xref:../web_console/configuring-web-console.adoc#configuring-web-console[Configuring the web console]
* xref:../web_console/customizing-the-web-console.adoc#customizing-web-console[Customizing the web console]
* xref:../web_console/odc-using-web-terminal.adoc#odc-using-web-terminal[Using the web terminal]
* xref:../web_console/web_terminal/odc-using-web-terminal.adoc#odc-using-web-terminal[Using the web terminal]
* xref:../web_console/creating-quick-start-tutorials.adoc#creating-quick-start-tutorials[Creating quick start tutorials]
* xref:../web_console/disabling-web-console.adoc#disabling-web-console[Disabling the web console]

View File

@@ -0,0 +1 @@
../_attributes/

View File

@@ -0,0 +1,17 @@
:_content-type: ASSEMBLY
[id="configuring-web-terminal"]
= Configuring the web terminal
include::_attributes/common-attributes.adoc[]
:context: configuring-web-terminal
toc::[]
You can configure timeout and image settings for the web terminal, either for your current session or for all user sessions if you are a cluster administrator.
include::modules/odc-configure-web-terminal-timeout-session.adoc[leveloffset=+1]
include::modules/configure-web-terminal-timeout-admin.adoc[leveloffset=+1]
include::modules/odc-configure-web-terminal-image-session.adoc[leveloffset=+1]
include::modules/configure-web-terminal-image-admin.adoc[leveloffset=+1]

View File

@@ -0,0 +1 @@
../images/

View File

@@ -0,0 +1,40 @@
:_content-type: ASSEMBLY
[id="installing-web-terminal"]
= Installing the web terminal
include::_attributes/common-attributes.adoc[]
:context: installing-web-terminal
toc::[]
You can install the web terminal by using the {web-terminal-op} listed in the {product-title} OperatorHub. When you install the {web-terminal-op}, 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.
[discrete]
[id="prerequisites_installing-web-terminal"]
== Prerequisites
* You are logged into the {product-title} web console.
* You have cluster administrator permissions.
[discrete]
[id="installing-web-terminal-procedure"]
== Procedure
. In the *Administrator* perspective of the web console, navigate to *Operators -> OperatorHub*.
. Use the *Filter by keyword* box to search for the {web-terminal-op} in the catalog, and then click the *Web Terminal* tile.
. Read the brief description about the Operator on the *Web Terminal* page, and then click *Install*.
. On the *Install Operator* page, retain the default values for all fields.
** The *fast* option in the *Update Channel* menu enables installation of the latest release of the {web-terminal-op}.
** 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.
** The *openshift-operators* option in the *Installed Namespace* menu installs the Operator in the default `openshift-operators` namespace.
** The *Automatic* option in the *Approval Strategy* menu ensures that the future upgrades to the Operator are handled automatically by the Operator Lifecycle Manager.
. Click *Install*.
. In the *Installed Operators* page, click the *View Operator* to verify that the Operator is listed on the *Installed Operators* page.
+
[NOTE]
====
The {web-terminal-op} installs the DevWorkspace Operator as a dependency.
====
. After the Operator is installed, refresh your page to see the command line terminal icon (image:odc-wto-icon.png[title="web terminal icon"]) in the masthead of the console.

View File

@@ -0,0 +1 @@
../modules/

View File

@@ -0,0 +1,11 @@
:_content-type: ASSEMBLY
[id="odc-using-web-terminal"]
= Using the web terminal
include::_attributes/common-attributes.adoc[]
:context: odc-using-web-terminal
toc::[]
You can launch an embedded command line terminal instance in the web console. This terminal instance is preinstalled with common CLI tools for interacting with the cluster, such as `oc`, `kubectl`,`odo`, `kn`, `tkn`, `helm`, `kubens`, `subctl`, and `kubectx`. It also has the context of the project you are working on and automatically logs you in using your credentials.
include::modules/odc-access-web-terminal.adoc[leveloffset=+1]

View File

@@ -0,0 +1 @@
../snippets

View File

@@ -0,0 +1,14 @@
:_content-type: ASSEMBLY
[id="troubleshooting-web-terminal"]
= Troubleshooting the web terminal
include::_attributes/common-attributes.adoc[]
:context: troubleshooting-web-terminal
toc::[]
[id="troubleshooting-web-terminal-network-policies"]
== 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.
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.

View File

@@ -0,0 +1,17 @@
:_content-type: ASSEMBLY
[id="uninstalling-web-terminal"]
= Uninstalling the web terminal
include::_attributes/common-attributes.adoc[]
:context: uninstalling-web-terminal
toc::[]
Uninstalling the {web-terminal-op} does not remove any of the custom resource definitions (CRDs) or managed resources that are created when the Operator is installed. For security purposes, you must manually uninstall these components. By removing these components, you save cluster resources because terminals do not idle when the Operator is uninstalled.
Uninstalling the web terminal is a two-step process:
. Uninstall the {web-terminal-op} and related custom resources (CRs) that were added when you installed the Operator.
. Uninstall the DevWorkspace Operator and its related custom resources that were added as a dependency of the {web-terminal-op}.
include::modules/removing-web-terminal-operator.adoc[leveloffset=+1]
include::modules/removing-devworkspace-operator.adoc[leveloffset=+1]