Updated on 2024-06-26 GMT+08:00

web-terminal (EOM)

The web-terminal add-on is a lightweight terminal server that allows you to use kubectl on the web UI. It provides a remote command-line interface (CLI) via web browser and HTTP, and can be easily integrated into an independent system. You can directly access the add-on as a service to obtain information and log in to a server through cmdb.

web-terminal can run on all operating systems supported by Node.js and does not depend on local modules. It is fast and easy to install and supports multiple sessions.

Open source community: https://github.com/rabchev/web-terminal

Constraints

  • This add-on can be installed only in clusters of v1.21 or earlier. Arm clusters are not supported.
  • web-terminal is no longer evolved. Use CloudShell instead.
  • When installing web-terminal to use kubectl, you must log in using your cloud account or as an IAM user with the CCE Administrator permission. For details about how to control the kubectl permission, see Controlling web-terminal Permissions.
  • The web-terminal add-on can be used only after CoreDNS is installed in a cluster.

Precautions

The web-terminal add-on can be used to manage CCE clusters. Keep the login password secure to prevent unexpected operation.

Installing the Add-on

  1. Log in to the CCE console and click the cluster name to access the cluster console. Choose Add-ons in the navigation pane, locate web-terminal on the right, and click Install.
  2. Configure the following parameters:

    • Access Mode: The value is fixed to NodePort. The web-terminal add-on is accessed in the NodePort mode by default and can be used only if any node in the cluster has an EIP. If this access type is selected, an EIP must be bound to the cluster where web-terminal will be installed.
    • Username: The default value is root and cannot be changed.
    • Password: password for logging in to web-terminal. Keep secure the password. The web-terminal add-on can be used to manage CCE clusters. Keep the login password secure to prevent unexpected operation.
    • Confirm Password: Enter the password again.

  3. Click Install.

Connecting to a Cluster Using the web-terminal Add-on

  1. Log in to the CCE console and click the cluster name to access the cluster console. Choose Add-ons in the navigation pane.
  2. Find web-terminal on the right and click Access.

Controlling web-terminal Permissions

After web-terminal is installed, kubectl uses the ClusterRole cluster-admin by default and can operate Kubernetes resources in the cluster. To manually change to another ClusterRole, you can run kubectl edit clusterrolebinding web-terminal to modify the web-terminal ServiceAccount.

For details about ClusterRole and ClusterRoleBinding, see Namespace Permissions (Kubernetes RBAC-based).

  • Manually configured web-terminal permissions could be reset after the web-terminal add-on is upgraded. You are advised to back up the configurations before the upgrade.
  • Before using kubectl to modify ClusterRoleBindings, ensure that kubectl has been configured with the required permissions.

Change History

Table 1 Release history

Add-on Version

Supported Cluster Version

New Feature

Community Version

1.1.12

v1.15

v1.17

v1.19

v1.21

  • CCE clusters 1.21 are supported.

0.6.6

1.1.6

v1.15

v1.17

v1.19

  • Adds the default seccomp profile.

0.6.6

1.1.5

v1.15

v1.17

v1.19

  • CCE clusters 1.15 are supported.

0.6.6

1.1.3

v1.17

v1.19

  • CCE clusters 1.19 are supported.

0.6.6

1.0.6

v1.15

v1.17

  • Adds pod security policies.

0.6.6

1.0.5

v1.9

v1.11

v1.13

v1.15

v1.17

  • Clusters 1.17 are supported.

0.6.6