1. Release Notes
    1. Release Notes - 2.0.2Latest
    1. Release Notes - 2.0.1
    1. Release Notes - 2.0.0
  1. Introduction
    1. Introduction
    1. Features
    1. Architecture
    1. Advantages
    1. Glossary
  1. Installation
    1. Intruction
      1. Intro
      2. Port Requirements
    1. Install on Linux
      1. All-in-One Installation
      2. Multi-Node Installation
      3. Installing HA Master and Etcd Cluster
      4. Storage Configuration Instruction
    1. Install on Kubernetes
      1. Prerequisites
      2. Online Installation
      3. Offline Installation
    1. Related Tools
      1. Integrating Harbor Registry
    1. Cluster Operation
      1. Adding New Nodes
      2. High Risk Operation
      3. Uninstalling KubeSphere
  1. Quick Start
    1. Getting Started with Multitenancy
    1. Exposing your APP using Ingress
    1. Deploying a MySQL Application
    1. Deploying a Wordpress Website
    1. Job to compute π to 2000 places
    1. Deploying Grafana using APP Template
    1. Creating Horizontal Pod Autoscaler
    1. S2i: Publish your app without Dockerfile
    1. Canary Release of Microservice APP
    1. CI/CD based on Spring Boot Project
    1. Building a Pipeline in a Graphical Panel
    1. CI/CD based on GitLab and Harbor
    1. Ingress-Nginx for Grayscale Release
  1. Cluster Admin Guide
    1. Multi-tenant Management
      1. Overview of Multi-tenant Management
      2. Overview of Role Management
    1. Platform Management
      1. Account Management
      2. Platform Roles Management
    1. Infrastructure
      1. Service Components
      2. Nodes
      3. Storage Classes
    1. Monitoring Center
      1. Physical Resources
      2. Application Resources
    1. Application Repository
    1. Jenkins System Settings
  1. User Guide
    1. Application Template
    1. Workloads
      1. Deployments
      2. StatefulSets
      3. DaemonSets
      4. Jobs
      5. CronJobs
    1. Storage
      1. Volumes
    1. Network & Services
      1. Services
      2. Routes
    1. Configuration Center
      1. Secret
      2. ConfigMap
      3. Image Registry
    1. Project Settings
      1. Basic Information
      2. Member Roles
      3. Project Members
      4. Internet Access
    1. DevOps Project
      1. DevOps Project Management
      2. DevOps Project Management
      3. DevOps Project Management
      4. DevOps Project Management
      5. DevOps Project Management
  1. Development Guide
    1. Preparing the Development Environment
    1. Development Workflow
  1. API Documentation
    1. API Guide
    1. How to invoke KubeSphere API
KubeSphere®️ 2020 All Rights Reserved.


As an enterprise container platform, KubeSphere provides an easy-to-use console with awesome user experience that allows you to quickly get started with various functions.

KubeSphere provides rich features ranging from the workload management, microservice governance (Service Mesh), DevOps projects (CI/CD), Source to Image (S2I), multi-tenancy management, multi-dimensional monitoring, log query and collection, alerting and notification, service and network, application management, infrastructure management, image registry management, application management and so on. It also supports a various of open source storage and network solutions, as well as high-performance cloud storage services, business products regarding storage and network.

We are also developing Porter, the open source load balancer plugin which is suitable for Kubernetes installed on bare metal.

The following modules elaborate on the KubeSphere services from a professional point of view.

Kubernetes Resource Management

KubeSphere provides easy-to-use visual wizard UI for various Kubernetes resources so as to manage workloads, image registry, service and application router as well as the key configuration. It also provides Horizontal Pod Autoscaler (HPA) and container check, and supports millions of container resource configuration to ensure businesses’ high availability under the peak concurrent.

Microservice Governance (Service Mesh)

  • Flexible microservice framework: Based on the Istio microservice framework, KubeSphere provides a visualized microservice governance function to manage Kubernete’s services in fine-grained control.
  • Complete governance functions: Support microservice governance such as circuit breaker, gray release, traffic control, current limitation, link tracking and the intelligent routing. At the same time, the system supports microservice governance without modifying your source code.

Multi-tenant Management

  • Multi-tenancy: Provides unified authentication based on fine-grained roles and three-tier authorization management.
  • Unified authentication: Supports integration with enterprise centralized authentication system that is based on LDAP/AD protocol. And support single sign-on (SSO) to realize the unified authentication of tenant identity.
  • Authorization management: The authorization hierarchy is divided into three levels, namely, cluster, workspace and project. From high to low, we ensure the resource sharing as well as the isolation among different roles at multiple levels with resource security fully guaranteed.

DevOps Project (CI/CD)

  • Out-of-the-box DevOps: Supports visual CI/CD Jenkins-based pipeline editing with no Jenkins configuration required, and provides rich CI/CD pipeline plug-ins.
  • CI/CD graphical pipelining provides mail notification and adds multiple execution conditions
  • End-to-end pipeline setup: Supports end-to-end pipeline setup from repository (GitHub/SVN/Git), code compiling, container image generating, image security scanning, pushing to repository, release, and scheduled pipeline trigger.
  • Security management: Support code static analysis scanning to manage the security of code quality in DevOps project.
  • Logging: The logs record the whole process of CI/CD pipeline running.

Source to Image

Source to Image (S2i) provides the ability to pull source code from code repository, compile the code, make container image and push the image to a target repository. The whole process of S2I will be completed in the form of task (Job).

Multidimensional Monitoring

  • fully monitoring dashboard can be operated through a visual interface, while at the same time, the open standard interface is easy to connect with the enterprise operation and maintenance system, so as to unify the operation and maintenance entry to realize centralized operation and maintenance.
  • Three-dimensional second-level monitoring: Instruct the three-dimensional monitoring with second-level frequency and dual-dimensions for 16 indicators.
  • In the cluster resource dimension, we provide multiple indicators such as CPU utilization, memory utilization, CPU load average, disk usage, inode utilization, disk throughput, IOPS, network card rate, Pod running state, ETCD monitoring, API Server monitoring.
  • In the dimension of application resources, we provide five monitoring indicators such as CPU consumption, memory consumption, number of container clusters, network outflow rate and network inflow rate for the application. Besides, we support the query by the amount of sorting and custom time range as well as fast location of exceptions.
  • Provide resource usage ranking by node, enterprise space, project, etc.
  • Provide service component monitoring to quickly locate component failures.

Alerting and Notification System

  • Provides monitor metrics and alert polices based on multiple tenancy and multiple dimensions. Currently, the alerting policy supports two levels. One is node level for the cluster administrator and the other is workload level for a tenant.
  • Flexible alerting policy: You can customize an alerting policy that contains multiple alerting rules, and you can specify notification rules and repeat alerting rules.
  • Rich alerting polices: Provide monitoring metrics and alerting polices at both node level and workload level. It includes many monitoring metrics such as Pod, CPU, memory, disk, network, etc.
  • Flexible alerting rules: You can customize time period and consecutive times of the probe, and configure how serious the alert is.
  • Flexible notification delivery rules: You can customize the notification delivery period and notification list. Mail notification is currently supported only.
  • Custom repeat alerting rules: Support to set the repeat alerting cycle, maximum repeat times, and the alerting level

Log Query and Collection

  • Provides multi-tenant log management. In KubeSphere's log search system, different tenants can only see their own log information.
  • Contains multi-level log queries (project/workload/Pod/container and keywords) as well as flexible and convenient log collection configuration options.
  • Supports a variety of log collection platforms such as Elasticsearch, Kafka, Fluentd.

Application management and orchestration

  • Use open source OpenPitrix to provide app store and app repository services to provide users with the management of the application lifecycle.
  • Users can quickly and easily deploy all the services of a complete application based on application templates.

Infrastructure Management

KubeSphere provides the ability to operate infrastructure including storage management, host management and monitoring, resource quota management, image registry management, authorization management and image security scanning. KubeSphere also supports adding public Docker hub and private Harbor as external image registries in addition to shipping built-in Harbor image registry.

Multiple Storage Solutions Support

  • Supports GlusterFS, CephRBD, NFS and other open source storage.
  • Provides NeonSAN CSI plug-in to leverage QingStor NeonSAN storage with lower latency, more resilient, higher performance to meet enterprise core business requirements.
  • Provides QingCloud CSI plug-in to use various block storage services in QingCloud.

Multiple Network Solutions Support

  • Supports Calico, Flannel and other open source network solutions.
  • Load balancer Porter developed for Kubernetes deployed on bare metal environment.