【WIP】v3.0.0 Documentation Catalogue

[FeynmanZhou]

Documentation Assignment

KubeSphere Documentation v3.0 (Left Part)

Cluster Administration

Node Management

Kubernetes Resources Global Management

Storage

• Volumes
• Snapshots

• StorageClass

  • Ceph RBD
  • GlusterFS
  • QingCloud CSI
  • Custom StorageClass

Cluster Status Monitoring

Application Resources Monitoring

Cluster-wide Alerting and Notification

Cluster Settings

• Cluster Visibility and Authorization

• Log Collections

  • Add Elasticsearch as Collector
  • Add Kafka as Collector
  • Add Fluentd as Collector

Workspace Administration

Upload Helm-based Application

Import Helm Repositories

Enable Network Policy in Workspace

Role and Member Management in Workspace

Project User Guide

Application

• Deploy Applications from App Store
• Deploy Applications from App Template
• Deploy Applications from App Repository
• Composing an Application

Application Workloads

• Deployment
• StatefulSets
• DaemonSets
• Services
• Jobs, CronJobs
• Routes

Storage

• Volumes
• Snapshots

Configurations

• Secrets
• Create Secret to connect Image Registries
• ConfigMaps

Grayscale Release

• Grayscale Release - Blue-green Deployment
• Grayscale Release - Canary Release
• Grayscale Release - Traffic Mirroring

Image Builder

• Image Builder: Source-to-Image
• Image Builder: Binary-to-Image
• Customize Image Build Template

Project-wide Alerting and Notification

Custom Application-level Monitoring

• Get started
• Expose Application Metrics
• Customize Monitoring Dashboard for ES, MySQL, Redis
• Use Grafana template
• How to write and use Exporter

Project Administration

Project and Multi-cluster Projecrt

Configure Default Request and Limit

Project-wide Network Isolation

Roles and Members Management in Project

Gateway Settings for Internet Access

Disk Log Collection

DevOps User Guide & Administration

Create a Pipeline using Graphical Editing Panel

Create a Pipeline using Jenkinsfile

Integrating GitLab, Harbor, SonarQube in Pipeline

Credentials

Roles and Members Management in DevOps

Artifactory Management

···

App Store & App Store Management

Basic Guide for each Application

• GitLab App
• Harbor App
• Redis App
• ···

App Lifecycle Management

Toolbox

Log Search

Events Search

Auditing Operating

Web kubectl

Access Control, Account Management

Overview: Multi-tenancy in KubeSphere

Configuring OAuth Server

Syncing LDAP/AD

Best Practice for enterprise multi-tenancy

Backup and Recovery

etcd Backup

Restore Cluster to a Previous State

Shuting Down and Restarting Cluster Gracefully

Best Practices

Kubernetes Production Best Practices

Deploy an App Cross Multiple Clusters

API Documentation

Overview

Invoke KubeSphere API

Glossary in API Documentation

Monitoring Metrics Specification

Troubleshooting

Contribution

Declaration

[rayzhou2017]

No hands-on labs?

[FeynmanZhou]

No hands-on labs?

There is a quick-start chapter in the outline. The former hands-on lab will be separated into different chapters, we will provide a learning path to stitch some hands-on lab tutorials.

[duanjiong]

Looks like QingCloud load balancing is missing.

[FeynmanZhou]

Looks like QingCloud load balancing is missing.

Yes, let me add it.

[FeynmanZhou]

Let us know if you have any idea: ) please add your comments on this issue.

[shaowenchen]

Introduction

Create a Pipeline - using Graphical Editing Panel

Create a Pipeline - using Jenkinsfile

Pipeline Management （including webhook、Timing trigger，etc.）

Credentials Management

Roles and Members Management

Artifactory Management

Add new types of pod for pipeline

How to Integrate

Integrating SonarQube in Pipeline

Integrating Harbor in Pipeline

Integrating Nexus in Pipeline

Integrating Jrog Artifactory in Pipeline

Example

How to compile and deploy a maven project

How to compile and deploy a spring cloud project

How to compile and deploy a nodejs project

How to compile and deploy a go project

How to compile and deploy a python project

How to run automated testing

How to deploy applications cross the multi clusters

How to deploy a Micro service application based on K8s

@FeynmanZhou