Use the terminal window within the Red Hat OpenShift web console

In this lesson, you will learn how to access the terminal window within the Red Hat OpenShift web console and use it to work with various OpenShift and Kubernetes resources that are available in the OpenShift cluster to which the web console is bound.

What you need to know

In order to get full benefit from taking this lesson, you need to:

• Have a basic understanding of the nature and use of Kubernetes as a container orchestration framework.
• Understand the relationship between OpenShift and Kubernetes.
• Have a basic understanding of the nature and purpose of the kubectl CLI tool.
• Know how to access your dedicated instance of the Developer Sandbox.

What you will learn

In this lesson you will learn:

• How to access the terminal window that’s embedded within the OpenShift web console.
• How to use the kubectl and oc CLI tools to interact with the various Kubernetes resources within the OpenShift cluster.

Access the terminal window

To reach the OpenShift terminal window within your no-cost Developer Sandbox cluster:

1. Using your web browser, navigate here (Figure 1, Callout 1).

2. Select Start your sandbox for free (Figure 1, Callout 2). 

   

3. Once you're in the OpenShift web console, click the terminal prompt icon in the upper right corner of the web page (Figure 2, Callout 1) to display the command-line terminal (Figure 2, Callout 2). You can use the terminal window to interact directly with the underlying Kubernetes cluster powering the OpenShift instance. 

   

Work with the oc and kubectl CLI tools from within the terminal window

The terminal window that’s embedded within the OpenShift web console is a full blown instance of a Linux terminal. There, you can do the same command-line activities you would normally run in a standalone terminal. Also, the OpenShift web console terminal window allows you to work easily with the OpenShift and its underlying Kubernetes cluster.

OpenShift has both the oc and kubectl  CLI tools pre-installed and configured to access the underlying Kubernetes cluster within the OpenShift instance. Thus, you can interact with OpenShift and the underlying Kubernetes from the command line.

The oc CLI tool has much of the same functionality that kubectl provides. However, oc can go a bit further and allow you to execute behavior that is special to OpenShift. For example, you can use oc to install an application into OpenShift without having to negotiate the complexities of application deployment in Kubernetes.

The following exercises demonstrate how to use the oc and kubectl CLI tools to execute basic tasks from the terminal window’s command line. The exercises also demonstrate the close relationship between OpenShift and Kubernetes.

Get version information

Run the following command in the OpenShift terminal to get version information about oc CLI tool:

oc version

You will see output similar to the following:

Client Version: 4.10.6

Server Version: 4.10.28

Kubernetes Version: v1.23.5+012e945

The results of the oc version command display the version numbers of the oc CLI client, the server powering the current OpenShift instance and as well as the version number of the underlying instance of Kubernetes used by the cluster.

View resources using oc or kubectl

Run the following command in the OpenShift terminal to get a list of pods running in the current instance of OpenShift using the oc CLI tool: 

oc get pods

You will receive output similar to the following:

NAME                                        READY   STATUS    RESTARTS   AGE

workspace1e8db31dd59c43ef-8585ff4cc-24ww6   2/2     Running   0          22s

Run the following command in the OpenShift terminal to get a list of pods running in the current instance of OpenShift using the kubectl CLI tool: 

kubectl get pods

You will receive output similar to the following:

NAME                                        READY   STATUS    RESTARTS   AGE

workspace1e8db31dd59c43ef-8585ff4cc-24ww6   2/2     Running   0          22s

Notice that the output from executing oc get pods and kubectl get pods is identical. This is because both oc and kubectl are querying the same underlying Kubernetes cluster to get a list of pods. This is direct evidence of the tight relationship between OpenShift and Kubernetes. 

Remember, OpenShift is a layer of components that “sit on top” of an underlying Kubernetes cluster. The important thing to understand is that the oc CLI tool provides functionality available in the kubectl CLI tool. In many cases, you can use oc and kubectl interchangeably.

Summary

In this lesson, you learned how to access the terminal window that’s embedded in the OpenShift web console. Also, you learned how to use the terminal window to execute commands using the oc and kubectl CLI tools. You executed both oc get pods and kubectl get pods to list the same set of pods running in the Kubernetes cluster that’s foundational to OpenShift.

Next

This is the last of a set of lessons intended to introduce you to OpenShift, the OpenShift web console, and the oc CLI tool for OpenShift. The lessons that follow in the Foundations of OpenShift learning path will demonstrate how to use the OpenShift web console to install, configure, and maintain applications from source code or container image. Also, there will be a set of lessons that demonstrate how to install and maintain applications from source code or a container image using the oc CLI tool at the command line.