What is the Web Terminal Operator?

This operator integrates with the OpenShift, allowing users to open a Command line terminal drawer within the console and interact with the cluster, without installing any tools locally.  

Why do I need the Web Terminal Operator?

With Web Terminal Operator, your developers no longer need to download client packages on your local machine to interact with your OpenShift cluster.  Command line tools can be used directly from the OpenShift Command line terminal within the OpenShift Console. CLIs are pre-installed and fully authenticated when you need them.

Here’s a list of some of the available CLIs:

  • oc
  • odo
  • helm
  • kn
  • tkn
  • rhoas
  • subctl
  • jq
  • kubectl

Setup Guide

To install the Web Terminal Operator, follow these steps:

  1. Login to your OpenShift Console (If you don’t have an OpenShift cluster, click here to try it!)
  2. In the Admin perspective, Click on OperatorHub in the Operators navigation section.
  3. Search for Web Terminal & click on the Web Terminal card
  4. The side panel is displayed showing you information about the Web Terminal.  Click Install to get started.
  5. In the Install Operator form, take all defaults and click Install to install the Web Terminal operator.
  6. A loading screen will be shown with the installation status
  7. Wait for the UI to show that it is ready for use. Click on View Operator.
  8. View the status of the Web Terminal Operator.  You should see the new icon in the top banner, to the left of the Help icon.  If it is not yet there, try refreshing your browser.  As soon as the icon appears, it’s available for use!

Using the OpenShift command line terminal in the OpenShift Console

Now that the Web Terminal Operator is installed on your cluster, users can easily access it!  Just click on the icon in the banner to open the terminal drawer.

Available features

The shell history command works to recall previous commands with the up and down arrow keys and other bash mechanics, but this information is not preserved between terminal sessions.  You can use all the basic commands from here:

oc new-project <project-name>

: to create a new project

oc new-app <app url>

: to pull an existing image

oc get pods

: Will list all the pods

oc describe pod -l deployment=<name of pod>

: The describe command will give you more information on the details of a pod

oc get services

: To see the current list of services in a project

If you wish to know more about pods and services please look here.

What’s coming in OpenShift 4.11

  • Multiple tabs in the Terminal drawer.

What’s coming next?

  • Preserving history between tabs.

Categories

How-tos, Operators, OpenShift 4.10

< Back to the blog