v2.1
v2.0
v1.0
  1. Release Notes
    1. Release Notes - 2.1.1Latest
    1. Release Notes - 2.1.0
    1. Release Notes - 2.0.2
    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. Introduction
      1. Intro
      2. Port Requirements
      3. Kubernetes Cluster Configuration
    1. Install on Linux
      1. All-in-One Installation
      2. Multi-Node Installation
      3. High Availability Configuration
      4. Air Gapped Installation
      5. StorageClass Configuration
      6. Enable All Components
    1. Install on Kubernetes
      1. Prerequisites
      2. Install on K8s
      3. Air Gapped Installation
      4. Install on GKE
    1. Pluggable Components
      1. Pluggable Components
      2. Enable Application Store
      3. Enable DevOps System
      4. Enable Logging System
      5. Enable Service Mesh
      6. Enable Alerting and Notification
      7. Enable Metrics-server for HPA
      8. Verify Components Installation
    1. Upgrade
      1. Overview
      2. All-in-One
      3. Multi-node
    1. Third-Party Tools
      1. Configure Harbor
      2. Access Built-in SonarQube and Jenkins
      3. Enable built-in Grafana Installation
      4. Load Balancer plugin in Bare Metal - Porter
    1. Authentication Integration
      1. Configure LDAP/AD
    1. Cluster Operations
      1. Add or Cordon Nodes
      2. High Risk Operations
      3. Uninstall KubeSphere
  1. Quick Start
    1. 1. Getting Started with Multi-tenancy
    1. 2. Expose your App Using Ingress
    1. 3. Compose and Deploy Wordpress to K8s
    1. 4. Deploy Grafana Using App Template
    1. 5. Job to Compute π to 2000 Places
    1. 6. Create Horizontal Pod Autoscaler
    1. 7. S2I: Publish your App without Dockerfile
    1. 8. B2I: Publish Artifacts to Kubernete
    1. 9. CI/CD based on Spring Boot Project
    1. 10. Jenkinsfile-free Pipeline with Graphical Editing Panel
    1. 11. Canary Release of Bookinfo App
    1. 12. Canary Release based on Ingress-Nginx
    1. 13. Application Store
  1. DevOps
    1. Pipeline
    1. Create SonarQube Token
    1. Credentials
    1. Set CI Node for Dependency Cache
    1. Set Email Server for KubeSphere Pipeline
  1. User Guide
    1. Configration Center
      1. Secrets
      2. ConfigMap
      3. Configure Image Registry
  1. Logging
    1. Log Query
  1. Developer Guide
    1. Introduction to S2I
    1. Custom S2I Template
  1. API Documentation
    1. API Documentation
    1. How to Access KubeSphere API
  1. Troubleshooting
    1. Troubleshooting Guide for Installation
  1. FAQ
    1. Telemetry
KubeSphere®️ 2020 All Rights Reserved.

Glossary

Edit

This document describes some frequently used glossaries in KubeSphere as shown below:

Object Concepts
Project It is Kubernetes Namespace which provides virtual isolation for the resources in KubeSphere, see Namespace.
Pod A Pod is the smallest deployable computing unit that can be created and managed in KubeSphere, see Pods.
Deployment Deployment is used to describe a desired state in a deployment object, and the deployment controller changes the actual state to the desired state at a controlled rate, see Deployment.
StatefulSet StatefulSet is the workload object used to manage stateful applications, such as MySQL, see StatefulSet.
DaemonSet A DaemonSet ensures that all (or some) Nodes run a copy of a Pod,such as fluentd or logstash, see DaemonSet.
Job A job creates one or more pods and ensures that a specified number of them successfully terminate, see Job.
CronJob CronJob creates Jobs on a time-based schedule. A CronJob object is like one line of a crontab (cron table) file. It runs a job periodically on a given schedule, see CronJob.
Service A Kubernetes service is an abstraction object which defines a logical set of Pods and a policy by which to access them - sometimes called a micro-service. See Service.
Route It is Kubernetes Ingress, an API object that manages external access to the services in a cluster, typically HTTP. Ingress can provide load balancing, SSL termination and name-based virtual hosting, see Ingress.
Image Registry Image registry is used to store and distribute Docker Images. It could be public or private, see Image.
Volume It is Kubernetes Persistent Volume Claim (PVC). Volume is a request for storage by a user, allowing a user to consume abstract storage resources, see PVC.
Storage Classes A storage class provides a way for administrators to describe the “classes” of storage they offer, see StorageClass.
Pipeline Jenkins Pipeline is a suite of plugins which supports implementing and integrating continuous delivery pipelines into Jenkins, see Pipeline.
WorkSpace Workspace is a logical unit to organize your workload projects, DevOps projects, to manage resource access and share information within your team. It is an isolated working place for your team.
Node A node is a worker machine that may be a virtual machine or physical machine, depending on the cluster setup. Each node contains the services necessary to run pods and is managed by the master components. see Node.