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.


KubeSphere is an enterprise-grade multi-tenant container management platform that built on Kubernetes. It provides an easy-to-use UI enables creation of computing resources with a few clicks and one-click deployment, which reduces the learning curve and empower the DevOps teams. It greatly reduces the complexity of the daily work of development, testing, operation and maintenance, aiming to solve the pain spots of Kubernetes' storage, network, security and ease of use, etc.

Installing KubeSphere on Linux

KubeSphere installation supports all-in-one and multi-node.

All-in-one means a single host that includes the master, node, etcd, and other components, thus multi-node means multiple hosts with all components included on each (master, node, etcd, and other components).

In addition, you can choose to integrate Harbor image registry into cluster (optional). By default, Harbor will not be installed, users need to pre-configure the conf/vars.yml to install harbor, see Integrate Harbor Installation.


  • The external network must be accessible because of installation is required to update the OS and pull images and dependencies from the external source.
  • There are two roles in the architecture of KubeSphere cluster, i.e. Master and Node. The master node consists of three components, namely, kube-apiserver for exposing the Kubernetes API, kube-scheduler for scheduling decisions, and kube-controller-manager for running controllers.
  • Etcd as the consistent and highly-available key value store used as Kubernetes’ backing store for all cluster data.
  • All-in-one is used for a single-node installation, the node is both a management and a working node.
  • When you start multi-node installation, you can set the roles of the cluster nodes in the configuration file.
  • Notice that select OpenSSH Server from the Software Selection step if your host(s) is a newly installed system,.


All-in-One is single-node installation that supports one-click installation, it's only recommended to test and experienc the features of 2.0.2, see All-in-One. By contrast, the multi-node installation is recommended in a formal environment.


Multi-node is used for installing KubeSphere on multiple instances, supports for installing a highly available master and etcd cluster which is able to use in a formal environment, see Multi-Node.

Components Version

Components Version
KubeSphere v2.0.2
Kubernetes v1.13.5
Istio v1.1.1
etcd v3.2.18
OpenPitrix v0.3.5
Elasticsearch v6.7.0
Prometheus v2.3.1
Jenkins v2.138
SonarQube v7.4
GitLab v11.8.1
Harbor v1.7.5

Storage Configuration Instruction

Storage Configuration Instruction explains how to configure different types of persistent storage services as following, see Storage Configuration Instruction.

Creating HA Master and Etcd Cluster

Multi-node installation can help uses to deploy KubeSphere to a cluster. However, we also need to consider the high availability of the master and etcd in a production environment. This page uses the Load balancer as an example, walk you through how to configure highly available Master and etcd nodes installation, see Creating Highly Available Master and Etcd Cluster.

Adding new node

After you install KubeSphere, you may run out of server capacity in a formal environment and need to add a new node, then scale the cluster horizontally to complete the system expansion, see Add new node.

Installing KubeSphere on Kubernetes

In addition to supporting deploy on VM and BM, KubeSphere also supports installing on cloud-hosted and on-premises Kubernetes clusters.


Uninstall will remove KubeSphere from the machine, this operation is irreversible, see Uninstall.