#Quick Start

This guide helps platform users start a cluster or node terminal after an administrator installs the web-cli plugin.

#Prerequisites

Before you start, confirm the following conditions:

• An administrator has installed web-cli on the global cluster.
• Your account has permission to use the target cluster or node.
• The terminal Pod can be created in the system namespace, cpaas-system by default.

#Open Web Terminal

Click Web CLI in the top-right corner of the platform page. Web Terminal opens as its own session page:

• The left pane lists the clusters you can access. Expand a cluster to list its nodes.
• The search box above the list filters the list by cluster name or node name.
• Selecting a cluster or a node opens a terminal in a sub-tab on the right. Each sub-tab is a separate session, so you can keep several clusters and nodes open at the same time.

#Start a Cluster Terminal

1. In the left pane, click the name of the cluster you want to operate on. A sub-tab opens on the right.

2. Run a read-only command to verify access:

   kubectl get nodes

The command output confirms that the terminal session can reach the API server of the selected cluster with your current permissions.

#Start a Node Terminal

1. In the left pane, expand the cluster that hosts the node, then click the node name. A sub-tab opens on the right.

2. The session starts inside the terminal Pod. Switch to the node's root filesystem:

   chroot /host

3. Run a shell command to verify the session:

   hostname

The output should identify the selected node.

#Expected Results

The terminal displays command output and remains available while you are active. After 15 minutes without activity, the platform closes the session and removes the associated terminal Pod, and the terminal displays a disconnection notice. Select Reconnect to start a new session in the same sub-tab. See Troubleshoot Session Timeout.

For the installation procedure, see Install.