Project User Guide

In KubeSphere, project users with necessary permissions are able to perform a series of tasks, such as creating different kinds of workloads, configuring volumes, Secrets, and ConfigMaps, setting various release strategies, monitoring app metrics, and creating alerting policies. As KubeSphere features great flexibility and compatibility without any code hacking into native Kubernetes, it is very convenient for users to get started with any feature required for their testing, development and production environments.

Applications

App Templates

Understand the concept of app templates and how they can help to deploy applications within enterprises.

Deploy Apps from App Templates

Learn how to deploy an application from a Helm-based template.

Deploy Apps from the App Store

Learn how to deploy an application from the App Store.

Create a Microservices-based App

Learn how to compose a microservice-based application from scratch.

Application Workloads

Deployments

Learn basic concepts of Deployments and how to create Deployments in KubeSphere.

StatefulSets

Learn basic concepts of StatefulSets and how to create StatefulSets on KubeSphere.

DaemonSets

Learn basic concepts of DaemonSets and how to create DaemonSets in KubeSphere.

Services

Learn basic concepts of Services and how to create Services in KubeSphere.

Jobs

Learn basic concepts of Jobs and how to create Jobs on KubeSphere.

CronJobs

Learn basic concepts of CronJobs and how to create CronJobs on KubeSphere.

Routes

Learn basic concepts of Routes (i.e. Ingress) and how to create Routes in KubeSphere.

Pod Settings

Learn different properties on the dashboard in detail as you set Pods for your workload.

Kubernetes HPA (Horizontal Pod Autoscaling) on KubeSphere

How to configure Kubernetes Horizontal Pod Autoscaling on KubeSphere.

Volume Management

Persistent Volume Claims

Learn how to create, edit, and mount a PVC on KubeSphere.

Volume Snapshots

Learn how to manage a snapshot of a persistent volume on KubeSphere.

Configuration

Secrets

Learn how to create a Secret on KubeSphere.

ConfigMaps

Learn how to create a ConfigMap in KubeSphere.

Image Registries

Learn how to create an image registry on KubeSphere.

Service Accounts

Learn how to create service accounts on KubeSphere.

Grayscale Release

Overview

Understand the basic concept of grayscale release.

Blue-Green Deployment with Kubernetes

Learn how to release a blue-green deployment on KubeSphere.

Canary Release

Learn how to deploy a canary service on KubeSphere.

Traffic Mirroring

Learn how to conduct a traffic mirroring job on KubeSphere.

Image Builder

Source to Image: Publish an App without a Dockerfile

Use S2I to import a Java sample project in KubeSphere, create an image and publish it to Kubernetes.

Binary to Image: Publish an Artifact to Kubernetes

Use B2I to import an artifact and push it to a target repository.

S2I Workflow and Logic

Understand how S2I works and why it works in the expected way.

Customize S2I Templates

Customize S2I templates and understand different template parameters.

Configure S2I and B2I Webhooks

Learn how to configure S2I and B2I webhooks.

Alerting

Alerting Policies (Workload Level)

Learn how to set alerting policies for workloads.

Alerting Messages (Workload Level)

Learn how to view alerting messages for workloads.

Custom Application Monitoring

Introduction

Introduce the KubeSphere custom monitoring feature and metric exposing, including exposing methods and ServiceMonitor CRD.

Examples

Monitor MySQL

Deploy MySQL and MySQL Exporter and create a dashboard to monitor the app.

Monitor a Sample Web Application

Use a Helm chart to deploy a sample web app and create a dashboard to monitor the app.

Visualization

Overview

Understand the general steps of creating a monitoring dashboard as well as its layout.

Charts

Explore dashboard properties and chart metrics.

Querying

Learn how to specify monitoring metrics.