v2.0
v1.0
  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.

Documentation

简体中文English

Architecture

Separation of front and back ends

KubeSphere adopts the separation of front and back ends, also realizes a cloud native design, the back ends' service components can communicate with external systems through the REST API, see API documentation for more details. All component are included in the architecture diagram below. KubeSphere can run anywhere from on-premise datacenter to any cloud to edge. In addition, it can be deployed on any Kubernetes distribution.

Components List

Back-end component Function description
Ks-account provides API relating to the user and the privilege management
Ks-apiserver The API interface of the entire cluster management, the communication hub between the modules within the cluster, and the cluster security control
Ks-apigateway isresponsible for handling service requests and all tasks
Ks-console offers KubeSphere console service
Ks-controller-manager implements business logic, such as creating corresponding permissions for enterprise space; Or when creating a service policy, generate the corresponding
Metrics-server Kubernetes’ monitoring component collects Metrics information from Kubelet of each node.
Prometheus provides clusters, nodes, workloads, API objects and other related monitoring data and services
Elasticsearch provides cluster log indexing, querying, data management and other services, which can also be used to reduce resource consumption at the time of installation against your existing ES
Fluent Bit enables log receiving and forwarding. Collected information can be send to ElasticSearch, Kafka
Jenkins provides CI/CD pipeline service
SonarQube is an optional installation that provides code static checking and quality analysis
source-to-image will automatically compile and package the Source code into Docker Image, which is convenient to quickly build Image
Istio provides microservice governance and traffic control, such as grayscale publishing, canary publishing, fuse, traffic mirror and so on
Jaeger collects Sidecar data and provided the distributed Tracing service
OpenPitrix provides application templates, application deployment and management services
Alert provides custom Alert service
Notification is an universal Notification service; it currently supports mail Notification
redis stores the data of ks-console and ks-account in the memory storage system
MySQL is the cluster back-end component database for monitoring, alarm, DevOps, OpenPitrix Shared MySQL service
PostgreSQL SonarQube and Harbor's back-end database
OpenLDAP is responsible for centralized storage and management of user account information and docking with external LDAP
Storage built-in CSI plug-in docking cloud platform storage services, have optional installation of open source NFS/Ceph/Gluster client
Network can optionally install Calico/Flannel and other open source network plug-ins to support docking with cloud platform SDN

3rd Party Tools

In addition to the components listed above, KubeSphere also supports Harbor and GitLab as optional installations that you can install according to your project requires.

Service Components

Each component has many service components, see Service Components for more details.

KubeSphere Docs