v4.2.0

中文文档

Product Introduction

Product Introduction
Product Architecture
Application Scenarios
Version Differences

Community Edition

Quick Start

Install and Use Extensions
Controlling User Permissions
Install an App from the App Store
Create and Deploy WordPress
Deploy and Access Bookinfo
Canary Release Practice
Accessing Services from Outside the Cluster
Modify Interface Language

Installation Guide

Preparation

Environment Requirements
Configure High Availability

Configure Kubernetes High Availability

Configure External Persistent Storage

Configure Cloud Storage Devices
Configure NeonSAN CSI
Configure NFS
Configure Open Source Storage Systems

Install KubeSphere

Online Installation of Kubernetes and KubeSphere
Activate KubeSphere Community Edition
Activate KubeSphere Enterprise
Configure KubeSphere High Availability
Appendix: Advanced Configuration of KubeSphere Core

Upgrade KubeSphere

Online Upgrade from KubeSphere Enterprise v4.1.x to v4.2.0
Offline Upgrade from KubeSphere Enterprise v4.1.x to v4.2.0
Upgrade KubeSphere to Community Edition v4.2.0

Uninstall KubeSphere

Uninstall KubeSphere Only
Uninstall Kubernetes and KubeSphere

Add and Remove Cluster Nodes

Add Cluster Nodes
Remove Cluster Nodes

Platform Management

Platform Introduction
Navigation and Shortcut Functions

Component Dock
Quick Access
Left Navigation Pane

Platform Settings

View and Customize Platform Information
License

View License Information
Add License

Quota

View Resource Quotas

External Authentication

Configure External Authentication
LDAP/LDAPS Authentication
OIDC Authentication
CAS Authentication

As an OIDC Identity Provider

User and Role Management

User

Create a User
View User List
View User Details
Edit User Information
Edit Current User Information
Change User Password
Reset User Password
Set Password Expiration
Enable and Disable Two-Factor Authentication
Enable and Disable Users
Delete Users

Platform Roles

Create Platform Roles
View Platform Role List
View Platform Role Details
Edit Platform Role Information
Edit Platform Role Permissions
Delete Platform Roles

Extension Management

Install Extensions
Manage Extensions

Configuring Extensions
Configuring Cluster Agent
Disable an Extension

Upgrade Extensions
Uninstall Extensions

Cluster Management

Entering a Cluster

Log In and Access a Cluster

Overview

View Cluster Overview Information

Nodes

View Node List
View Node Details
Block and Allow Pod Scheduling
Using Node Terminal
Edit Node Taints
Edit Node Labels

Project

Create a Project
View Project List
View Project Details
Edit Project Information
Edit Project Annotations
Edit Project Quotas
Edit Default Container Quotas
Delete a Project

Application Workloads

Workloads

Create a Workload
View Workload List
View Workload Details
Edit Workload Information
Recreate a Workload
Adjust the Number of Pod Replicas
Stop Workloads
Roll Back Workload Settings
Edit Workload Settings
Generate Workload Template
Delete Workloads

Jobs

Create a Job
View Job List
View Job Details
Edit Job Information
Rerun a Job
Pause a CronJob
Delete a Job

Pods

View Pod List
View Pod Details
View Container Details
Access Container Terminal
Delete Pods

Services

Create a Service
View Service List
View Service Details
Edit Service Information
Edit Service Settings
Edit Service External Access Settings
Delete Services

Ingress

Create an Ingress
View Application Routing List
View Application Route Details
Access the Backend Service of an Ingress
Edit Ingress Information
Edit Routing Rules
Edit Application Route Annotations
Delete Ingress

Workload Templates

Create Workload Template
View Template List
Edit Template Settings
Create a Workload from a Template
Delete Workload Templates

Configuration

Secrets

Create a Secret
View Secret List
View Secret Details
Edit Secret Information
Edit Secret Settings
Delete a Secret

ConfigMaps

Create a ConfigMap
View ConfigMap List
View ConfigMap Details
Edit ConfigMap Information
Edit ConfigMap Settings
Delete a ConfigMap

Service Accounts

Create a Service Account
View Service Account List
View Service Account Details
Edit Service Account Information
Modify Service Account Role
Delete Service Accounts

Custom Resource Definitions

View Custom Resource Definition List
View Custom Resource Definition Details
Edit Custom Resources
Delete Custom Resources

Storage

Storage Class

Create a Storage Class
View Storage Class List
View Storage Class Details
Set Default Storage Class
Enable and Disable Volume Operations
Edit Storage Class Information
Delete Storage Class

Persistent Volume Claim

Create a Persistent Volume Claim
View Persistent Volume Claim List
View Persistent Volume Claim Details
Clone a Persistent Volume Claim
Expand a Persistent Volume Claim
Edit Persistent Volume Claim Information
Delete Persistent Volume Claim
Create Persistent Volume
View Persistent Volume List
View Persistent Volume Details
Edit Persistent Volume Information
Delete Persistent Volume

Cluster Settings

Basic Information

View Cluster Basic Information
Edit Cluster Basic Information

Cluster Visibility

View Cluster Visibility
Edit Cluster Visibility

Cluster Members

Invite Users to a Cluster
View Cluster Member List
Modify Cluster Member Roles
Remove Cluster Members

Cluster Roles

View Cluster Role List
View Cluster Role Details

Multi-cluster Management

Multi-cluster Management

Add a Member Cluster

Add a Member Cluster via Direct Connection

View Cluster List
Edit Cluster Information
Add Cluster Labels
Edit Member Cluster Configuration
Update kubeconfig
Remove Member Cluster
Re-adopt Member Clusters to Another Host Cluster

Cluster Labels

Create Cluster Labels
Edit Cluster Labels
Add Labels to Clusters
Remove Labels from Clusters
Delete Cluster Labels

Workspace and Project Management

Enter Workspace

Log In and Enter Workspace

Manage Workspaces

Create Workspace
View Workspace List
Edit Workspace Information
Delete Workspace

Workspace Overview

View Resource Usage
View Cluster Information

Application Management

App Repository

Add Application Repository
View App Repository List
Edit App Repository
Delete an App Repository

Workspace Settings

Basic Information

View Workspace Basic Information
Edit Workspace Information
Delete Workspace

Workspace Quotas

Edit Workspace Quota
View Workspace Quotas

Workspace Members

Invite Users to a Workspace
View Workspace Member List
View Workspace Member Details
Modify Workspace Member Roles
Remove Workspace Members

Workspace Roles

Create Workspace Role
View Workspace Role List
View Workspace Role Details
Edit Workspace Role Information
Edit Workspace Role Permissions
Delete Workspace Role

Project Management

Project List

Create a Project
View Project List
Edit Project Information
Edit Project Annotations
Edit Project Labels
Edit Project Quotas
Delete Project
Assign a Project to Another Workspace

Project Roles

Create Project Role
View Project Role List
View Project Role Details
Edit Project Role Information
Edit Project Role Permissions
Delete Project Role

Project Members

Invite Users to a Project
View Project Member List
Modify Project Member Roles
Remove Project Members

Project Quotas

Edit Default Container Quotas
Edit Project Quotas
View Project Quota

Service Accounts

Create a Service Account
View Service Accounts List
View Service Account Details
Edit Service Account Information
Modify Service Account Role
Delete Service Accounts

Application Workloads

Applications

Install Apps from the App Store
Install an App from an App Template
View Application List
View Details of Template-Based Application
Edit App Information
Edit App Settings
Delete an Application

Composed Apps

Create a Composed App
View Composed App List
View Composed App Details
Edit Composed App Information
Add a Service to a Composed App
Add an Ingress for a Composed App
Delete Composed App

Services

Create a Service

Create a Stateful or Stateless Service
Create External Service
Create a Service from an Existing Workload

View Service List
View Service Details
Edit Service Information
Edit Service Settings
Edit Service External Access Settings
Delete a Service

Workloads

Create a Workload
View Workload List
View Workload Details
Edit Workload Information
Recreate a Workload
Adjust the Number of Pod Replicas
Stop Workloads
Roll Back Workload Settings
Edit Workload Settings
Generate Workload Template
Delete Workloads

Jobs

Create a Job
View Job List
View Job Details
Edit Job Information
Rerun a Job
Pause a CronJob
Delete a Job

Ingress

Create an Ingress
Viewing Application Route List
View Application Route Details
Access Backend Services of an Ingress
Edit Application Routing Information
Edit Routing Rules
Edit Ingress Annotations
Delete Ingress

Pods

Viewing Pod Lists
View Pod Details
View Container Details
Access Container Terminal
Delete a Pod

Workload Templates

Create a Workload Template
View Template List
Edit Template Settings
Create a Workload from a Template
Delete Workload Template

Configurations

Secrets

Create a Secret
View Secret List
View Secret Details
Edit Secret Information
Edit Secret Settings
Delete Secret

ConfigMaps

Create a ConfigMap
View ConfigMap List
View ConfigMap Details
Edit ConfigMap Information
Edit ConfigMap Settings
Delete a ConfigMap

Storage

Persistent Volume Claim

Create a PersistentVolumeClaim
View Persistent Volume Claim List
View Persistent Volume Claim Details
Clone a Persistent Volume Claim
Expand Persistent Volume Claim
Edit Persistent Volume Claim Information
Delete Persistent Volume Claim

Toolbox

Running Commands via kubectl
View and Download kubeconfig File

Extension User Guide

Overview
DevOps

Overview
DevOps Project Management

DevOps Project

Create a DevOps Project
View DevOps Project List
Edit DevOps Project Information
Delete DevOps Project

DevOps Project Roles

Create Project Role
View Project Role List
View Project Role Details
Edit Project Role Information
Edit Project Role Permissions
Delete Project Role

DevOps Project Members

Invite Users to a Project
View Project Member List
Modify Project Member Roles
Remove Project Members

Pipeline

Create a Pipeline Using the Graphical Editing Panel
Creating a Pipeline Using Jenkinsfile
Create a Pipeline Using a Pipeline Template
Creating a Multi-branch Pipeline Using GitLab
Setting Up a Pipeline
Triggering a Pipeline Using Webhook
Log in to Jenkins Dashboard
Configure Jenkins System
Using Jenkins Shared Libraries in Pipelines
Setting up Email Server for Pipelines
Select Jenkins Agent
Customize Jenkins Agent
Setting Up CI Nodes for Dependency Caching

Continuous Deployment

Implementing Continuous Deployment for Applications Using GitOps
Add Continuous Deployment Whitelist

Resource Management

Synchronize Resource Files to Code Repository
View and Download Resource Files

Code Repository

Import Code Repository
View and Manage Code Repositories

Credentials

Credential Management

Tool Integration

Integrate SonarQube into Pipelines
Integrate Harbor into Pipeline

Image Builder

Create Image Builder

Create an Image Builder Using Source Code
Create an Image Builder Using Artifacts

View Image Builder List
View Image Builder Details
Edit Image Builder Information
Run an Image Builder
Configure S2I and B2I Webhooks
Delete Image Builder

KubeSphere App Store Management

Application Management

Application Templates

Create Application Template
View Application Template List
View Application Template Details
Edit Application Template Information
Installing Apps Using App Templates
Upload Application Version
Delete App Version
Download Helm Chart Archive
Publish an App Version to the App Store
Delete an App Template

App Store Management

Applications

View App Template List
View Application Template Details
Edit App Template
Publish an App Template
Unpublish an App Version
Delete App Version
Unpublish App Template
Delete an App Template

Application Categories

Manage App Categories
Set Application Category

Application Review

Review Application Versions
View Application Version Review Records

App Repository

Add Application Repository
View App Repository List
Edit App Repository
Delete App Repository

Deployment Management

View Application List
View Application Details
Edit Application Information
Delete an Application
Deploy Applications from the App Store
Deploy an App from an App Template

KubeSphere Service Mesh

Composed App

Create a Composed App
View Composed App List
View Composed App Details
Edit Composed App Information
Add a Service to a Composed App
Add an Ingress for a Composed App
Delete Composed App

Canary Release

Create a Canary Release Task
View Grayscale Release Task List
View Grayscale Release Job Details
Switch Online Version (Blue-Green Deployment)
Adjust Traffic Distribution Ratio (Canary Release)
Edit Grayscale Release Task Settings
Delete a Grayscale Release Job

Application Management for Cluster Federation

Accessing a Federated Project

Log in and Enter a Federated Project

Managing Federated Projects

Create a Federated Project
View Federated Project List
Edit Federated Project Information
Edit Federated Project Annotations
Add Clusters to a Federated Project
Delete Federated Project

Overview

View Federated Project Overview Information

Application Workloads

Applications

Create a Composed App
View Composed App List
View Composed App Details
Delete Composed App

Services

Create Stateful or Stateless Services
View Service List
View Service Details
Edit Service Information
Edit Service Settings
Edit Service External Access Settings
Delete Service

Workloads

Create a Workload
View Workload List
View Workload Details
Edit Workload Information
Adjust the Number of Pod Replicas
Stop Workloads
Edit Workload Settings
Delete Workloads

Ingress

Create an Ingress
View Ingress List
View Application Route Details
Edit Ingress Information
Edit Routing Rules
Edit Ingress Annotations
Delete Ingress

Persistent Volume Claim

Create a PersistentVolumeClaim
View Persistent Volume Claim List
View Persistent Volume Claim Details
Edit Persistent Volume Claim Information
Delete Persistent Volume Claim

Configuration

Secrets

Create a Secret
View Secret List
View Secret Details
Edit Secret Information
Edit Secret Settings
Delete Secret

ConfigMaps

Create a ConfigMap
View ConfigMap List
View ConfigMap Details
Edit ConfigMap Information
Edit ConfigMap Settings
Delete ConfigMaps

Project Settings

Basic Information

View Project Basic Information
Edit Project Information
Edit Project Annotations
Add Project Clusters
Edit Default Container Quotas
Delete Project

Project Quotas

Edit Project Quotas
View Project Quota

WizTelemetry Observability Platform

WizTelemetry Data Pipeline

Vector Log ETL Solution - From Kafka to OpenSearch

Step 1: Write Data to Kafka Using Vector
Step 2: Use Vector to Read Data from Kafka
Step 3: Configure WizTelemetry Platform Service

WizTelemetry Platform Service

WizTelemetry Logging

Configure Logging
Log Receivers

Add Log Receiver
View Log Receiver List
View Log Receiver Details
Edit Log Receiver Settings
Enable and Disable Log Receivers
Delete Log Receiver

Log Query
Log Collection

Enable Log Collection
Enable Log Collection in a Project
Enable Collection of Logs on Volumes

WizTelemetry Events

Query Resource Events

WizTelemetry Auditing

Query Audit Logs

WizTelemetry Monitoring

Overview

View Cluster Monitoring Overview
View Workspace Monitoring Overview

Cluster Monitoring

View Cluster Status Overview
View Physical Resource Status
View etcd Database Status
View Kubernetes API Server Status
View Scheduler Status
View Node Resource Usage Ranking

Application Monitoring

View Application Resource Usage
View Project Resource Usage Rankings

Custom Monitoring

Create a Custom Monitoring Dashboard
View Custom Monitoring Dashboards
Edit Custom Monitoring Dashboard Information
Edit a Custom Monitoring Dashboard
Delete Custom Monitoring Dashboard

Edit Monitoring Exporter

WizTelemetry Alerting

Rule Groups

Create a Rule Group
View Rule Group List
View Rule Group Details
Edit Rule Group Information
Edit Alerting Rules
Disable and Enable Rule Groups
Delete Rule Groups
Reset Built-in Rule Groups

Alerting

View Alert List

WizTelemetry Global Monitoring

Enable WizTelemetry Global Monitoring
Global Monitoring

Global Overview
Configure Extension
View Cluster Key Metrics Ranking
View Cluster Monitoring Details
View Node Key Metrics Ranking
View Node Monitoring Details
View Workspace Key Metrics Ranking
View Workspace Monitoring Details
View Project Key Metrics Ranking
View Project Monitoring Details
View Pod Key Metrics Ranking
View Pod Monitoring Details

Global Alerting

Rule Groups

Create a Rule Group
View Rule Group List
View Rule Group Details
Edit Rule Group Information
Edit Alerting Rules
Disable and Enable Rule Groups
Delete Custom Rule Groups
Reset Built-in Rule Groups

Alerting

View Alert List

WizTelemetry Events Alerting

Create Alerting Rules for Events/Auditing
Event/Auditing Alert Rule Examples
Create Log Alerting Rules

WizTelemetry Notification

Notification Channels

Set Email Notification
Configure Feishu Notification
Configure DingTalk Notification
Configure WeCom Notification
Set Up Slack Notifications
Set Webhook Notification

Notification Subscriptions

Create Notification Subscription
View Notification Subscriptions
Edit Notification Subscription
Delete Notification Subscriptions

Notification Settings

Create a Silence Policy
Edit Muting Policy Information
Edit Silence Conditions
Edit Mute Duration
Delete a Silence Policy
Modify Notification Language

Notification History

View Notification History

User Notification Settings

Set Email Notification
Configure Feishu Notification
Set DingTalk Notifications
Configure WeCom Notification
Set Slack Notifications
Set Webhook Notification

Notification Message Configuration

Configure WeCom Notification Message Template

WizTelemetry Network Observability

Network Topology

View Network Topology

Service Topology

View Service Topology
View Service Monitoring Details

HTTP Traffic

Traffic Logs
Traffic Monitoring

WizTelemetry Tracing

Query Trace Information
View Trace Details
View Service Topology of a Cluster

OpenSearch Distributed Search and Analytics Engine

OpenSearch Overview

Grafana for WizTelemetry

View Built-in Dashboards
Add Data Sources
Create Dashboard

Grafana Loki for WizTelemetry

Visualizing Data in Loki

Grafana Alloy for WizTelemetry

Visualizing Metrics Collected by Alloy

Grafana Tempo for WizTelemetry

Visualizing WizTelemetry Tracing Data with Tempo

KubeSphere Network

Network Policy

Create Network Policy
View Network Policy List
View Network Policy Details
Edit Network Policy Information
Edit Network Policy Configuration
Delete Network Policy

Pod IP Pool

Create Pod IP Pool
View Pod IP Pool List
View Pod IP Pool Details
Assign Pod IP Pools to Projects
Edit Pod IP Pool Information
Edit Overlay Mode
Edit Node Selection
Disable and Enable Pod IP Pools
Delete Pod IP Pools

Network Isolation

Enable Workspace Network Isolation
Enable Project Network Isolation
Configure Whitelist

KubeSphere Gateway

Project Gateway

Enable Project Gateway
View Project Gateway Information
View Project Gateway Details
Edit Project Gateway Settings
Disable Project Gateway

Workspace Gateway

Enable Workspace Gateway
View Workspace Gateway Information
View Workspace Gateway Details
Edit Workspace Gateway Settings
Disable Workspace Gateway

Cluster Gateway

Enable Cluster Gateway
View Gateway Information
View Cluster Gateway Details
Edit Cluster Gateway Settings
Disable Cluster Gateway
Appendix: Solution for No Data in Member Cluster Gateway Logs

KubeSphere Ingress Utils

Add Domain Reuse Validation
View Domain List
Edit Domain Information
Delete Domain Name Reuse Validation

KubeSphere Storage

Persistent Volume Claim

Create a NAS-Type PersistentVolumeClaim
Create a Persistent Volume Claim from a Volume Snapshot

Volume Snapshot Class

Create Volume Snapshot Class
View Volume Snapshot Class List
View Volume Snapshot Class Details
Edit Volume Snapshot Class Information
Delete Volume Snapshot Class

Volume Snapshots

Create a Volume Snapshot
View Volume Snapshot List
View Volume Snapshot Details
Create a Persistent Volume from a Volume Snapshot
Delete Volume Snapshots
View Volume Snapshot Content List
View Volume Snapshot Content Details
Edit Volume Snapshot Content Information
Delete Volume Snapshot Content

Storage Classes

Set Authorization Rules
Set Volume Auto-Expansion

RadonDB DMP

Password Handling Solution for Original Redis Sentinel Instances After Upgrade
Post-Upgrade Recommendations for Existing Redis Cluster Instances

EdgeWize

KubeSphere Spring Cloud

Microservices

Create a Deployment and Register It as a Microservice
View the Microservice List
Edit Microservice Instance Weight
Take Down and Bring Up Microservice Instances

Microservices Configuration

Create Microservice Configuration
View Microservice Configuration List
View Microservice Configuration Details
Edit Microservice Configuration
Copy Microservice Configuration
Roll Back Microservice Configuration
Delete Microservice Configuration

Microservices Gateway

Create a Microservices Gateway
View Microservices Gateway Information
View Microservices Gateway Details
Edit Microservice Gateway
Delete Microservices Gateway

KubeSphere Multi-Cluster Agent Connection

Adding Member Clusters via Proxy Connection

Gatekeeper

Constraint Templates

Create Constraint Template
View Constraint Template Details
Edit Constraint Template Configuration
Delete Constraint Template

Constraints

Create Constraint
View Constraint List
View Constraint Details
Edit Constraint Configuration
Delete Constraint

Example Operations

Disallow Creation of Privileged Containers in Non-Exempted Projects

OAuth2-Proxy

Configure and Access Services

NVIDIA GPU Operator

Overview

Cert Manager

Overview

Metrics Server

Edit Auto-scaling Settings

Release Notes

KubeSphere v4.2.0 Release Notes

Improvement Plan

User Experience Improvement Program

Glossary

Glossary

KubeSphere
Workspace and Project Management
Enter Workspace

Enter Workspace

Time updated：2025-12-22 09:26:17

Page Catalog

This section describes how to log in to the KubeSphere web console and enter a workspace.

Page Catalog