About the web terminal in the web console

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.

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.

Installing the web terminal

You can install the web terminal using the Web Terminal Operator listed in the OKD 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.

Prerequisites

• Access to an OKD cluster using an account with cluster-admin permissions.

Procedure

1. In the Administrator perspective of the web console, navigate to Operators → OperatorHub.

2. Use the Filter by keyword box to search for the Web Terminal Operator in the catalog, and then click the Web Terminal tile.

3. Read the brief description about the Operator on the Web Terminal page, and then click Install.

4. On the Install Operator page, retain the default values for all fields.

   • The alpha option in the Update Channel menu enables installation of the latest release of the Web Terminal Operator.

   • 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.

5. Click Install.

6. In the Installed Operators page, click the View operator to verify that the Operator is listed on the Installed Operators page.

7. After the Operator is installed, refresh your page to see the command line terminal icon on the upper right of the console.

Using the web terminal

After the Web Terminal Operator is installed, you can use the web terminal as follows:

1. To launch the web terminal, click the command line terminal 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.

2. Select the project where the DevWorkspace CR must be created from the Project drop-down list. By default, the current project is selected.

   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.

3. 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, and kubectx in the web terminal.

Uninstalling the web terminal

Uninstalling the web terminal is a two-step process:

1. Delete the components and custom resources (CRs) that were added when you installed the Operator.

2. Uninstall the Web Terminal Operator.

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.

Prerequisites

• Access to an OKD cluster using an account with cluster-admin permissions.

Deleting the web terminal components and custom resources

Use the CLI to delete the CRs that are created during installation of the Web Terminal Operator.

Procedure

1. Run the following commands to ensure that all DevWorkspace CRs are removed along with their related Kubernetes objects, such as deployments.

   $ oc delete devworkspaces.workspace.devfile.io --all-namespaces --all --wait

   $ oc delete workspaceroutings.controller.devfile.io --all-namespaces --all --wait

   $ oc delete components.controller.devfile.io --all-namespaces --all --wait

   If this step is not complete, finalizers make it difficult to fully uninstall the Operator easily.

2. Run the following commands to remove the CRDs:

   $ oc delete customresourcedefinitions.apiextensions.k8s.io workspaceroutings.controller.devfile.io

   $ oc delete customresourcedefinitions.apiextensions.k8s.io components.controller.devfile.io

   $ oc delete customresourcedefinitions.apiextensions.k8s.io devworkspaces.workspace.devfile.io

3. Remove the DevWorkspace-Webhook-Server deployment:

   $ oc delete deployment/devworkspace-webhook-server -n openshift-operators

   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.

4. Run the following commands to remove any lingering services, secrets, and config maps:

   $ oc delete all --selector app.kubernetes.io/part-of=devworkspace-operator,app.kubernetes.io/name=devworkspace-webhook-server

   $ oc delete serviceaccounts devworkspace-webhook-server -n openshift-operators

   $ oc delete configmap devworkspace-controller -n openshift-operators

   $ oc delete clusterrole devworkspace-webhook-server

   $ oc delete clusterrolebinding devworkspace-webhook-server

5. Run the following commands to remove mutating or validating webhook configurations:

   $ oc delete mutatingwebhookconfigurations controller.devfile.io

   $ oc delete validatingwebhookconfigurations controller.devfile.io

Uninstalling the Operator using the web console

Procedure

1. In the Administrator perspective of the web console, navigate to Operators → Installed Operators.

2. Scroll the filter list or type a keyword into the Filter by name box to find the Web Terminal Operator.

3. Click the Options menu for the Web Terminal Operator, and then select Uninstall Operator.

4. 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.