Web Terminal

Install

The web-cli Cluster Plugin is installed once on the global cluster; it is not installed separately on each workload cluster. Installing it enables the Web CLI entry in the top-right corner of the platform page, which provides both the cluster terminal and the node terminal.

The plugin is delivered as a platform package. Installation follows the standard Cluster Plugin workflow: publish the package to the marketplace, select a version, and start the installation. For the platform-wide workflow and lifecycle definitions, see Cluster Plugin.

Use either method below. The web console is the shorter path; the YAML method applies the same workflow at the resource level.

TOC

PrerequisitesInstall from the Web ConsoleInstall with YAMLVerify the InstallationAfter Installation

Prerequisites

  • The target web-cli package version is published to the platform marketplace.
  • You can query resources and create a ModuleInfo in the global cluster.
  • The selected ModuleConfig is available in the global cluster.

Install from the Web Console

Follow the platform's standard Cluster Plugin installation workflow to upload and install web-cli. Select the published plugin version, then start the installation. The Cluster Plugins list reports the plugin as running when the installation completes.

Install with YAML

Step 1: Check Available Versions

In the global cluster, confirm that the plugin and target version are available:

kubectl get moduleplugins web-cli
kubectl get moduleconfigs -l cpaas.io/module-name=web-cli

Inspect the target ModuleConfig and confirm that its cluster affinity is global and its spec.config is empty. An empty configuration means that web-cli can be installed without dynamic form parameters.

Step 2: Create a ModuleInfo

Create the ModuleInfo resource in the global cluster. The cpaas.io/cluster-name label targets the global cluster, but it does not change where the YAML is applied.

apiVersion: cluster.alauda.io/v1alpha1
kind: ModuleInfo
metadata:
  labels:
    cpaas.io/cluster-name: global
    cpaas.io/module-name: web-cli
    cpaas.io/module-type: plugin
  name: global-web-cli
spec:
  config: {}
  version: v4.2.12

Choose a metadata.name that is stable and unique in the global cluster; the name cannot be changed after creation, and nothing rejects a second ModuleInfo for the same plugin under a different name. Installing from the web console generates its own name, so use one method consistently for a given cluster. Set spec.version to the exact version in the selected ModuleConfig.

Verify the Installation

Query the ModuleInfo resource by label:

kubectl get moduleinfo -l cpaas.io/module-name=web-cli

Continue only when the status is Running and the target and current versions match the selected version.

After Installation

  • The Web CLI entry becomes available to platform users. Terminal access remains subject to each account's permissions on the selected cluster or node. See Quick Start.
  • Terminal Pods are created on demand in the platform system namespace, cpaas-system by default, and removed when a session ends or times out. See Terminal Pods.
  • Session and capacity limits are fixed in the plugin package and cannot be changed after installation. Moving to different values requires a different plugin version through the Upgrade workflow.
  • Whether web-cli can be uninstalled is controlled by the selected ModuleConfig. Check its spec.deleteable field before planning a removal: when it is false, deleting the ModuleInfo is rejected unless the object carries the cpaas.io/force-delete: "true" annotation.