finish task

This commit is contained in:
Ray Zhou 2024-07-13 15:20:05 -06:00
parent 1db464b052
commit 6e90ec6def
1300 changed files with 1364 additions and 91 deletions

View File

@ -10,6 +10,7 @@ section1:
title: KubeSphere Documentation
content: Learn how to build and manage cloud-native applications using KubeSphere Container Platform. Get documentation, example code, tutorials, and more.
image: /images/docs/v3.x/banner.png
version: "v3.3"
sectionLink:
docs:

View File

@ -8,6 +8,7 @@ weight: 12000
icon: "/images/docs/v3.x/docs.svg"
version: "v3.3"
---
The multi-tenant architecture of KubeSphere underlies many key components running on the container platform. Different tenants are assigned with varied roles so that they can perform related tasks. This chapter outlines the multi-tenant system of KubeSphere and demonstrates how to configure authentication for third-party login.

View File

@ -5,4 +5,6 @@ layout: "single"
linkTitle: "External Authentication"
weight: 12200
version: "v3.3"
---

View File

@ -5,6 +5,8 @@ description: "How to use an external OIDC identity provider."
linkTitle: "OIDC Identity Provider"
weight: 12221
version: "v3.3"
---
## OIDC Identity Provider

View File

@ -5,6 +5,8 @@ description: "How to set up external authentication on KubeSphere."
linkTitle: "Set Up External Authentication"
weight: 12210
version: "v3.3"
---
This document describes how to use an external identity provider such as an LDAP service or Active Directory service on KubeSphere.

View File

@ -5,6 +5,8 @@ description: "How to use an LDAP service."
linkTitle: "Use an LDAP Service"
weight: 12220
version: "v3.3"
---
This document describes how to use an LDAP service as an external identity provider, which allows you to authenticate users against the LDAP service.

View File

@ -4,6 +4,7 @@ keywords: 'Kubernetes, KubeSphere, OAuth2, Identity Provider'
description: 'How to use an external OAuth2 identity provider.'
linkTitle: "Use an OAuth 2.0 Identity Provider"
weight: 12230
version: "v3.3"
---
This document describes how to use an external identity provider based on the OAuth 2.0 protocol.

View File

@ -4,6 +4,7 @@ keywords: "Kubernetes, KubeSphere, multi-tenancy"
description: "Understand the multi-tenant architecture in KubeSphere."
linkTitle: "Multi-tenancy in KubeSphere"
weight: 12100
version: "v3.3"
---
Kubernetes helps you orchestrate applications and schedule containers, greatly improving resource utilization. However, there are various challenges facing both enterprises and individuals in resource sharing and security as they use Kubernetes, which is different from how they managed and maintained clusters in the past.

View File

@ -9,6 +9,7 @@ weight: 14000
icon: "/images/docs/v3.x/docs.svg"
version: "v3.3"
---
The KubeSphere App Store, powered by [OpenPitrix](https://github.com/openpitrix/openpitrix), an open-source platform that manages apps across clouds, provides users with enterprise-ready containerized solutions. You can upload your own apps through app templates or add app repositories that serve as an application tool for tenants to choose the app they want.

View File

@ -1,6 +1,7 @@
---
linkTitle: "Application Developer Guide"
weight: 14400
version: "v3.3"
_build:
render: false

View File

@ -4,6 +4,7 @@ keywords: 'Kubernetes, KubeSphere, helm, development'
description: 'Develop your own Helm-based app.'
linkTitle: "Helm Developer Guide"
weight: 14410
version: "v3.3"
---
You can upload the Helm chart of an app to KubeSphere so that tenants with necessary permissions can deploy it. This tutorial demonstrates how to prepare Helm charts using NGINX as an example.

View File

@ -4,6 +4,7 @@ keywords: 'Kubernetes, KubeSphere, Helm, specifications'
description: 'Understand the chart structure and specifications.'
linkTitle: "Helm Specifications"
weight: 14420
version: "v3.3"
---
Helm charts serve as a packaging format. A chart is a collection of files that describe a related set of Kubernetes resources. For more information, see the [Helm documentation](https://helm.sh/docs/topics/charts/).

View File

@ -4,6 +4,7 @@ keywords: 'Kubernetes, KubeSphere, app-store'
description: 'Manage your app across the entire lifecycle, including submission, review, test, release, upgrade and removal.'
linkTitle: 'Application Lifecycle Management'
weight: 14100
version: "v3.3"
---
KubeSphere integrates [OpenPitrix](https://github.com/openpitrix/openpitrix), an open-source multi-cloud application management platform, to set up the App Store, managing Kubernetes applications throughout their entire lifecycle. The App Store supports two kinds of application deployment:

View File

@ -1,6 +1,7 @@
---
linkTitle: "Built-in Applications"
weight: 14200
version: "v3.3"
_build:
render: false

View File

@ -4,6 +4,7 @@ tag: 'KubeSphere, Kubernetes, Applications, Chaos Engineering, Chaos experiments
keywords: 'Chaos Mesh, Kubernetes, Helm, KubeSphere'
description: 'Learn how to deploy Chaos Mesh on KubeSphere and start running chaos experiments.'
linkTitle: "Deploy Chaos Mesh on KubeSphere"
version: "v3.3"
---
[Chaos Mesh](https://github.com/chaos-mesh/chaos-mesh) is a cloud-native Chaos Engineering platform that orchestrates chaos in Kubernetes environments. With Chaos Mesh, you can test your system's resilience and robustness on Kubernetes by injecting various types of faults into Pods, network, file system, and even the kernel.

View File

@ -4,6 +4,7 @@ keywords: 'Kubernetes, KubeSphere, etcd, app-store'
description: 'Learn how to deploy etcd from the App Store of KubeSphere and access its service.'
linkTitle: "Deploy etcd on KubeSphere"
weight: 14210
version: "v3.3"
---
Written in Go, [etcd](https://etcd.io/) is a distributed key-value store to store data that needs to be accessed by a distributed system or cluster of machines. In Kubernetes, it is the backend for service discovery and stores cluster states and configurations.

View File

@ -4,6 +4,7 @@ keywords: 'Kubernetes, KubeSphere, Harbor, app-store'
description: 'Learn how to deploy Harbor from the App Store of KubeSphere and access its service.'
linkTitle: "Deploy Harbor on KubeSphere"
weight: 14220
version: "v3.3"
---
[Harbor](https://goharbor.io/) is an open-source registry that secures artifacts with policies and role-based access control, ensures images are scanned and free from vulnerabilities, and signs images as trusted.

View File

@ -4,6 +4,7 @@ keywords: 'Kubernetes, KubeSphere, Memcached, app-store'
description: 'Learn how to deploy Memcached from the App Store of KubeSphere and access its service.'
linkTitle: "Deploy Memcached on KubeSphere"
weight: 14230
version: "v3.3"
---
[Memcached](https://memcached.org/) is an in-memory key-value store for small chunks of arbitrary data (strings, objects) from results of database calls, API calls, or page rendering. Its API is available for the majority of popular languages.

View File

@ -4,6 +4,7 @@ keywords: 'Kubernetes, KubeSphere, Meshery,Serive Mesh, Layer5, app-store'
description: 'Learn how to deploy Meshery from the App Store of KubeSphere and access its service.'
linkTitle: "Deploy Meshery on KubeSphere"
weight: 14240
version: "v3.3"
---
[Meshery](https://meshery.io/) is the open source, cloud native management plane that enables the adoption, operation, and management of Kubernetes, any service mesh, and their workloads.

View File

@ -4,6 +4,7 @@ keywords: 'Kubernetes, KubeSphere, Minio, app-store'
description: 'Learn how to deploy Minio from the App Store of KubeSphere and access its service.'
linkTitle: "Deploy MinIO on KubeSphere"
weight: 14240
version: "v3.3"
---
[MinIO](https://min.io/) object storage is designed for high performance and the S3 API. It is ideal for large, private cloud environments with stringent security requirements and delivers mission-critical availability across a diverse range of workloads.

View File

@ -4,6 +4,7 @@ keywords: 'KubeSphere, Kubernetes, Installation, MongoDB'
description: 'Learn how to deploy MongoDB from the App Store of KubeSphere and access its service.'
linkTitle: "Deploy MongoDB on KubeSphere"
weight: 14250
version: "v3.3"
---
[MongoDB](https://www.mongodb.com/) is a general purpose, document-based, distributed database built for modern application developers and for the cloud era.

View File

@ -5,6 +5,8 @@ description: 'Learn how to deploy MySQL from the App Store of KubeSphere and acc
link title: "Deploy MySQL"
weight: 14260
version: "v3.3"
---
[MySQL](https://www.mysql.com/) is an open-source relational database management system (RDBMS), which uses the most commonly used database management language - Structured Query Language (SQL) for database management. It provides a fully managed database service to deploy cloud-native applications using the world's most popular open-source database.

View File

@ -4,6 +4,7 @@ keywords: 'KubeSphere, Kubernetes, Installation, NGINX'
description: 'Learn how to deploy NGINX from the App Store of KubeSphere and access its service.'
linkTitle: "Deploy NGINX on KubeSphere"
weight: 14270
version: "v3.3"
---
[NGINX](https://www.nginx.com/) is an open-source software application for web serving, reverse proxying, caching, load balancing, media streaming, and more.

View File

@ -4,6 +4,7 @@ keywords: 'Kubernetes, KubeSphere, PostgreSQL, app-store'
description: 'Learn how to deploy PostgreSQL from the App Store of KubeSphere and access its service.'
linkTitle: "Deploy PostgreSQL on KubeSphere"
weight: 14280
version: "v3.3"
---
[PostgreSQL](https://www.postgresql.org/) is a powerful, open-source object-relational database system, which is famous for reliability, feature robustness, and performance.

View File

@ -4,6 +4,7 @@ keywords: 'KubeSphere, RabbitMQ, Kubernetes, Installation'
description: 'Learn how to deploy RabbitMQ from the App Store of KubeSphere and access its service.'
linkTitle: "Deploy RabbitMQ on KubeSphere"
weight: 14290
version: "v3.3"
---
[RabbitMQ](https://www.rabbitmq.com/) is the most widely deployed open-source message broker. It is lightweight and easy to deploy on premises and in the cloud. It supports multiple messaging protocols. RabbitMQ can be deployed in distributed and federated configurations to meet high-scale, high-availability requirements.

View File

@ -4,6 +4,7 @@ keywords: 'KubeSphere, Kubernetes, Installation, RadonDB MySQL'
description: 'Learn how to deploy RadonDB MySQL from the App Store of KubeSphere and access its service.'
linkTitle: "Deploy RadonDB MySQL on KubeSphere"
weight: 14293
version: "v3.3"
---
[RadonDB MySQL](https://github.com/radondb/radondb-mysql-kubernetes) is an open source, cloud-native, and highly available cluster solution based on [MySQL](https://MySQL.org) database. With the Raft protocol, RadonDB MySQL enables fast failover without losing any transactions.

View File

@ -4,6 +4,7 @@ keywords: 'KubeSphere, Kubernetes, Installation, RadonDB PostgreSQL'
description: 'Learn how to deploy RadonDB PostgreSQL from the App Store of KubeSphere and access its service.'
linkTitle: "Deploy RadonDB PostgreSQL on KubeSphere"
weight: 14294
version: "v3.3"
---
[RadonDB PostgreSQL](https://github.com/radondb/radondb-postgresql-kubernetes) is an open source, cloud-native, and highly available cluster solution based on [PostgreSQL](https://postgresql.org) database system.

View File

@ -4,6 +4,7 @@ keywords: 'KubeSphere, Kubernetes, Installation, Redis'
description: 'Learn how to deploy Redis from the App Store of KubeSphere and access its service.'
linkTitle: "Deploy Redis on KubeSphere"
weight: 14291
version: "v3.3"
---
[Redis](https://redis.io/) is an open-source (BSD licensed), in-memory data structure store, used as a database, cache and message broker.

View File

@ -4,6 +4,7 @@ keywords: 'KubeSphere, Kubernetes, Installation, Tomcat'
description: 'Learn how to deploy Tomcat from the App Store of KubeSphere and access its service.'
linkTitle: "Deploy Tomcat on KubeSphere"
weight: 14292
version: "v3.3"
---
[Apache Tomcat](https://tomcat.apache.org/index.html) powers numerous large-scale, mission-critical web applications across a diverse range of industries and organizations. Tomcat provides a pure Java HTTP web server environment in which Java code can run.

View File

@ -1,6 +1,7 @@
---
linkTitle: "External Applications"
weight: 14300
version: "v3.3"
_build:
render: false

View File

@ -4,6 +4,7 @@ keywords: 'KubeSphere, Kubernetes, ClickHouse, ClickHouse Operator, ClickHouse C
description: 'Learn how to deploy ClickHouse Operator and a ClickHouse Cluster on KubeSphere.'
linkTitle: "Deploy RadonDB ClickHouse Operator and Cluster"
weight: 14340
version: "v3.3"
---
[ClickHouse](https://clickhouse.tech/) is a column-oriented database management system (DBMS) for online analytical processing of queries (OLAP). [RadonDB ClickHouse](https://github.com/radondb/radondb-clickhouse-kubernetes) is a deeply customized ClickHouse cluster application maintaining ClickHouse cluster functions and featuring automated cluster management, data redistribution in clusters, and excellent performance with less cost.

View File

@ -4,6 +4,7 @@ keywords: 'KubeSphere, Kubernetes, GitLab, App Store'
description: 'Learn how to deploy GitLab on KubeSphere and access its service.'
linkTitle: "Deploy GitLab on KubeSphere"
weight: 14310
version: "v3.3"
---
[GitLab](https://about.gitlab.com/) is an open-source end-to-end software development platform with built-in version control, issue tracking, code review, CI/CD, and more.

View File

@ -5,6 +5,7 @@ keywords: 'Litmus,LitmusChaos,Kubernetes,Helm,KubeSphere'
description: 'Learn how to deploy Litmus on KubeSphere and create chaos experiments.'
linkTitle: "Deploy Litmus on KubeSphere"
Weight: 14350
version: "v3.3"
---
[Litmus](https://litmuschaos.io/) is an open-source, cloud-native chaos engineering toolkit that focuses on simulating failure tests on Kubernetes clusters. It helps developers and SREs find vulnerabilities in clusters and programs, therefore improving the robustness of the system.

View File

@ -4,6 +4,7 @@ keywords: 'KubeSphere, Kubernetes, Applications, MeterSphere'
description: 'Learn how to deploy MeterSphere on KubeSphere.'
linkTitle: "Deploy MeterSphere on KubeSphere"
weight: 14330
version: "v3.3"
---
MeterSphere is an open-source, one-stop, and enterprise-level continuous testing platform. It features test tracking, interface testing, and performance testing.

View File

@ -4,6 +4,7 @@ keywords: 'KubeSphere, Kubernetes, Deploy, RadonDB MySQL'
description: 'Learn how to deploy RadonDB MySQL Operator and RadonDB MySQL Cluster on KubeSphere.'
linkTitle: "Deploy RadonDB MySQL Operator and Cluster"
weight: 14350
version: "v3.3"
---
[RadonDB MySQL](https://github.com/radondb/radondb-mysql-kubernetes) is an open source, cloud-native, and highly available cluster solution based on [MySQL](https://MySQL.org) database. With the Raft protocol, RadonDB MySQL enables fast failover without losing any transactions.

View File

@ -4,6 +4,7 @@ keywords: 'KubeSphere, Kubernetes, TiDB, TiDB Operator, TiDB Cluster'
description: 'Learn how to deploy TiDB Operator and a TiDB Cluster on KubeSphere.'
linkTitle: "Deploy TiDB Operator and a TiDB Cluster"
weight: 14320
version: "v3.3"
---
[TiDB](https://en.pingcap.com/) is a cloud-native, open-source NewSQL database that supports Hybrid Transactional and Analytical Processing (HTAP) workloads. It features horizontal scalability, strong consistency, and high availability.

View File

@ -9,6 +9,7 @@ weight: 8000
icon: "/images/docs/v3.x/docs.svg"
version: "v3.3"
---
In KubeSphere, you set a cluster's configurations and configure its features using the interactive web console or the built-in native command-line tool kubectl. As a cluster administrator, you are responsible for a series of tasks, including cordoning and adding labels to nodes, controlling cluster visibility, monitoring cluster status, setting cluster-wide alerting and notification rules, as well as configuring storage and log collection solutions.

View File

@ -5,6 +5,8 @@ description: "Monitor application resources across the cluster, such as the numb
linkTitle: "Application Resources Monitoring"
weight: 8300
version: "v3.3"
---
In addition to monitoring data at the physical resource level, cluster administrators also need to keep a close track of application resources across the platform, such as the number of projects and DevOps projects, as well as the number of workloads and services of a specific type. Application resource monitoring provides a summary of resource usage and application-level trends of the platform.

View File

@ -1,6 +1,7 @@
---
linkTitle: "Cluster Settings"
weight: 8600
version: "v3.3"
_build:
render: false

View File

@ -4,6 +4,7 @@ keywords: 'KubeSphere, Kubernetes, Cluster, Gateway, NodePort, LoadBalancer'
description: 'Learn how to create a cluster-scope gateway on KubeSphere.'
linkTitle: "Cluster Gateway"
weight: 8630
version: "v3.3"
---
KubeSphere 3.3 provides cluster-scope gateways to let all projects share a global gateway. This document describes how to set a cluster gateway on KubeSphere.

View File

@ -4,6 +4,7 @@ keywords: "Cluster Visibility, Cluster Management"
description: "Learn how to set up cluster visibility and authorization."
linkTitle: "Cluster Visibility and Authorization"
weight: 8610
version: "v3.3"
---
In KubeSphere, you can allocate a cluster to multiple workspaces through authorization so that workspace resources can all run on the cluster. At the same time, a workspace can also be associated with multiple clusters. Workspace users with necessary permissions can create multi-cluster projects using clusters allocated to the workspace.

View File

@ -1,6 +1,7 @@
---
linkTitle: "Log Receivers"
weight: 8620
version: "v3.3"
_build:
render: false

View File

@ -4,6 +4,7 @@ keywords: 'Kubernetes, log, elasticsearch, pod, container, fluentbit, output'
description: 'Learn how to add Elasticsearch to receive container logs, resource events, or audit logs.'
linkTitle: "Add Elasticsearch as a Receiver"
weight: 8622
version: "v3.3"
---
You can use Elasticsearch, Kafka, and Fluentd as log receivers in KubeSphere. This tutorial demonstrates how to add an Elasticsearch receiver.

View File

@ -4,6 +4,7 @@ keywords: 'Kubernetes, log, fluentd, pod, container, fluentbit, output'
description: 'Learn how to add Fluentd to receive logs, events or audit logs.'
linkTitle: "Add Fluentd as a Receiver"
weight: 8624
version: "v3.3"
---
You can use Elasticsearch, Kafka and Fluentd as log receivers in KubeSphere. This tutorial demonstrates:

View File

@ -4,6 +4,7 @@ keywords: 'Kubernetes, log, kafka, pod, container, fluentbit, output'
description: 'Learn how to add Kafka to receive container logs, resource events, or audit logs.'
linkTitle: "Add Kafka as a Receiver"
weight: 8623
version: "v3.3"
---
You can use Elasticsearch, Kafka and Fluentd as log receivers in KubeSphere. This tutorial demonstrates:

View File

@ -4,6 +4,7 @@ keywords: 'Kubernetes, log, elasticsearch, kafka, fluentd, pod, container, fluen
description: 'Learn the basics of cluster log receivers, including tools, and general steps.'
linkTitle: "Introduction"
weight: 8621
version: "v3.3"
---
KubeSphere provides a flexible log receiver configuration method. Powered by [Fluent Operator](https://github.com/fluent/fluent-operator), users can easily add, modify, delete, enable, or disable Elasticsearch, Kafka and Fluentd receivers. Once a receiver is added, logs will be sent to this receiver.

View File

@ -4,6 +4,8 @@ keywords: "Kubernetes, KubeSphere, status, monitoring"
description: "Monitor how a cluster is functioning based on different metrics, including physical resources, etcd, and API server."
linkTitle: "Cluster Status Monitoring"
weight: 8200
version: "v3.3"
---
KubeSphere provides monitoring of related metrics such as CPU, memory, network, and disk of the cluster. You can also review historical monitoring data and sort nodes by different indicators based on their usage in **Cluster Status**.

View File

@ -1,6 +1,7 @@
---
linkTitle: "Cluster-wide Alerting and Notification"
weight: 8500
version: "v3.3"
_build:
render: false

View File

@ -4,6 +4,7 @@ keywords: 'KubeSphere, Kubernetes, node, Alerting, messages'
description: 'Learn how to view alerting messages for nodes.'
linkTitle: "Alerting Messages (Node Level)"
weight: 8540
version: "v3.3"
---
Alerting messages record detailed information of alerts triggered based on the alerting policy defined. This tutorial demonstrates how to view alerting messages at the node level.

View File

@ -4,6 +4,7 @@ keywords: 'KubeSphere, Kubernetes, Node, Alerting, Policy, Notification'
description: 'Learn how to set alerting policies for nodes.'
linkTitle: "Alerting Policies (Node Level)"
weight: 8530
version: "v3.3"
---
KubeSphere provides alerting policies for nodes and workloads. This tutorial demonstrates how to create alerting policies for nodes in a cluster. See [Alerting Policy (Workload Level)](../../../project-user-guide/alerting/alerting-policy/) to learn how to configure alerting policies for workloads.

View File

@ -4,6 +4,7 @@ keywords: 'Kubernetes, Prometheus, Alertmanager, alerting'
description: 'Learn how to manage alerts with Alertmanager in KubeSphere.'
linkTitle: "Alertmanager in KubeSphere"
weight: 8510
version: "v3.3"
---
Alertmanager handles alerts sent by client applications such as the Prometheus server. It takes care of deduplicating, grouping, and routing them to the correct receiver integration such as email, PagerDuty, or OpsGenie. It also takes care of silencing and inhibition of alerts. For more details, refer to the [Alertmanager guide](https://prometheus.io/docs/alerting/latest/alertmanager/).

View File

@ -5,6 +5,8 @@ description: "Monitor node status and learn how to add node labels or taints."
linkTitle: "Node Management"
weight: 8100
version: "v3.3"
---
Kubernetes runs your workloads by placing containers into Pods to run on nodes. A node may be a virtual or physical machine, depending on the cluster. Each node contains the services necessary to run Pods, managed by the control plane. For more information about nodes, see the [official documentation of Kubernetes](https://kubernetes.io/docs/concepts/architecture/nodes/).

View File

@ -1,6 +1,7 @@
---
linkTitle: "Notification Management"
weight: 8720
version: "v3.3"
_build:
render: false

View File

@ -4,6 +4,7 @@ keywords: 'KubeSphere, Kubernetes, DingTalk, Alerting, Notification'
description: 'Learn how to configure a Dingtalk conversation or chatbot to receive platform notifications sent by KubeSphere.'
linkTitle: "Configure DingTalk Notifications"
weight: 8723
version: "v3.3"
---
[DingTalk](https://www.dingtalk.com/en) is an enterprise-grade communication and collaboration platform. It integrates messaging, conference calling, task management, and other features into a single application.

View File

@ -4,6 +4,7 @@ keywords: 'KubeSphere, Kubernetes, custom, platform'
description: 'Configure a email server and add recipients to receive email notifications.'
linkTitle: "Configure Email Notifications"
weight: 8722
version: "v3.3"
---
This tutorial demonstrates how to configure a email server and add recipients to receive email notifications of alerting policies.

View File

@ -4,6 +4,7 @@ keywords: 'KubeSphere, Kubernetes, Slack, notifications'
description: 'Configure Slack notifications and add channels to receive notifications from alerting policies, kube-events, and kube-auditing.'
linkTitle: "Configure Slack Notifications"
weight: 8725
version: "v3.3"
---
This tutorial demonstrates how to configure Slack notifications and add channels, which can receive notifications for alerting policies.

View File

@ -4,6 +4,7 @@ keywords: 'KubeSphere, Kubernetes, custom, platform, webhook'
description: 'Configure a webhook server to receive platform notifications through the webhook.'
linkTitle: "Configure Webhook Notifications"
weight: 8726
version: "v3.3"
---
A webhook is a way for an app to send notifications triggered by specific events. It delivers information to other applications in real time, allowing users to receive notifications immediately.

View File

@ -4,6 +4,7 @@ keywords: 'KubeSphere, Kubernetes, WeCom, Alerting, Notification'
description: 'Learn how to configure a WeCom server to receive platform notifications sent by KubeSphere.'
linkTitle: "Configure WeCom Notifications"
weight: 8724
version: "v3.3"
---
[WeCom](https://work.weixin.qq.com/) is a communication platform for enterprises that includes convenient communication and office automation tools.

View File

@ -4,6 +4,7 @@ keywords: 'KubeSphere, Kubernetes, Platform, Notification'
description: 'Learn how to customize cluster name in notification messages sent by KubeSphere.'
linkTitle: "Customize Cluster Name in Notification Messages"
weight: 8721
version: "v3.3"
---
This document describes how to customize your cluster name in notification messages sent by KubeSphere.

View File

@ -7,6 +7,8 @@ linkTitle: "Cluster Shutdown and Restart"
weight: 8800
icon: "/images/docs/v3.x/docs.svg"
version: "v3.3"
---
This document describes the process of gracefully shutting down your Kubernetes cluster and how to restart it. You might need to temporarily shut down your cluster for maintenance reasons.

View File

@ -4,6 +4,7 @@ keywords: 'KubeSphere, Kubernetes, PVC, PV, Snapshot, Snapshot Classes'
description: 'Learn how to manage snapshot classes on KubeSphere.'
linkTitle: "Volume Snapshot Classes"
weight: 8900
version: "v3.3"
---
Volume snapshot classes provide a way for administrators to define storage types used for volume snapshots. This tutorial describes how to create and use snapshot classes.

View File

@ -4,6 +4,7 @@ keywords: "Storage, Volume, PV, PVC, storage class, csi, Ceph RBD, GlusterFS, Qi
description: "Learn basic concepts of PVs, PVCs,and storage classes, and demonstrate how to manage storage classes on KubeSphere."
linkTitle: "Storage Classes"
weight: 8800
version: "v3.3"
---
This tutorial demonstrates how a cluster administrator can manage storage classes and persistent volumes in KubeSphere.

View File

@ -7,6 +7,8 @@ linkTitle: "DevOps User Guide"
weight: 11000
icon: "/images/docs/v3.x/docs.svg"
version: "v3.3"
---
To deploy and manage your CI/CD tasks and related workloads on your Kubernetes clusters, you use the KubeSphere DevOps system. This chapter demonstrates how to manage and work in DevOps projects, including running pipelines, creating credentials, and integrating tools.

View File

@ -1,6 +1,7 @@
---
linkTitle: "Understand and Manage DevOps Projects"
weight: 11100
version: "v3.3"
_build:
render: false

View File

@ -4,6 +4,7 @@ keywords: 'Kubernetes, KubeSphere, DevOps, Jenkins'
description: 'Create and manage DevOps projects, and understand basic elements in DevOps projects.'
linkTitle: "DevOps Project Management"
weight: 11120
version: "v3.3"
---
This tutorial demonstrates how to create and manage DevOps projects.

View File

@ -4,6 +4,7 @@ keywords: 'Kubernetes, KubeSphere, DevOps, overview'
description: 'Develop a basic understanding of DevOps.'
linkTitle: "Overview"
weight: 11110
version: "v3.3"
---
DevOps is a set of practices and tools that automate the processes between IT and software development teams. Among other things, as agile software development sees increasing popularity, continuous integration (CI) and continuous delivery (CD) have become an ideal solution in this connection. In a CI/CD workflow, every integration is tested through automatic building, including coding, releasing and testing. This helps developers to identify any integration errors beforehand and teams can deliver internal software to a production environment with speed, security, and reliability.

View File

@ -1,6 +1,7 @@
---
linkTitle: "Examples"
weight: 11400
version: "v3.3"
_build:
render: false

View File

@ -4,6 +4,7 @@ keywords: 'Kubernetes, Docker, DevOps, Jenkins, Maven'
description: 'Learn how to build and deploy a Maven project using a KubeSphere pipeline.'
linkTitle: "Build and Deploy a Maven Project"
weight: 11430
version: "v3.3"
---
## Prerequisites

View File

@ -4,6 +4,7 @@ keywords: 'KubeSphere, Kubernetes, Multi-cluster, Pipeline, DevOps'
description: 'Learn how to create a multi-cluster pipeline on KubeSphere.'
linkTitle: "Create a Multi-cluster Pipeline"
weight: 11440
version: "v3.3"
---
As cloud providers offer different hosted Kubernetes services, DevOps pipelines have to deal with use cases where multiple Kubernetes clusters are involved.

View File

@ -4,6 +4,7 @@ keywords: 'Kubernetes, docker, DevOps, Jenkins, Go, KubeSphere'
description: 'Learn how to build and deploy a Go project using a KubeSphere pipeline.'
linkTitle: "Build and Deploy a Go Project"
weight: 11410
version: "v3.3"
---
## Prerequisites

View File

@ -4,6 +4,7 @@ keywords: 'Kubernetes, KubeSphere, Docker, DevOps, Jenkins, Multi-cluster'
description: 'Learn how to deploy apps in a multi-cluster project using a Jenkinsfile-based pipeline.'
linkTitle: "Deploy Apps in a Multi-cluster Project Using a Jenkinsfile"
weight: 11420
version: "v3.3"
---
## Prerequisites

View File

@ -4,6 +4,7 @@ keywords: 'KubeSphere, Kubernetes, Pipeline, Nexus, Jenkins'
description: 'Learn how to use Nexus in pipelines on KubeSphere.'
linkTitle: "Use Nexus in Pipelines"
weight: 11450
version: "v3.3"
---
[Nexus](https://www.sonatype.com/products/repository-oss) is a repository manager that stores, organizes, and distributes artifacts. With Nexus, developers can have better control over the artifacts needed in a development process.

View File

@ -1,6 +1,7 @@
---
linkTitle: "Tool Integration"
weight: 11300
version: "v3.3"
_build:
render: false

View File

@ -4,6 +4,7 @@ keywords: 'Kubernetes, Docker, DevOps, Jenkins, Harbor'
description: 'Integrate Harbor into your pipeline to push images to your Harbor registry.'
linkTitle: "Integrate Harbor into Pipelines"
weight: 11320
version: "v3.3"
---
This tutorial demonstrates how to integrate Harbor into KubeSphere pipelines.

View File

@ -4,6 +4,7 @@ keywords: 'Kubernetes, KubeSphere, DevOps, Jenkins, SonarQube, Pipeline'
description: 'Integrate SonarQube into your pipeline for code quality analysis.'
linkTitle: "Integrate SonarQube into Pipelines"
weight: 11310
version: "v3.3"
---
[SonarQube](https://www.sonarqube.org/) is a popular continuous inspection tool for code quality. You can use it for static and dynamic analysis of a codebase. After it is integrated into pipelines in KubeSphere [Container Platform](https://kubesphere.io/), you can view common code issues such as bugs and vulnerabilities directly on the dashboard as SonarQube detects issues in a running pipeline.

View File

@ -1,6 +1,7 @@
---
linkTitle: "Use DevOps"
weight: 11200
version: "v3.3"
_build:
render: false

View File

@ -1,6 +1,7 @@
---
linkTitle: "Code Repositories"
weight: 11230
version: "v3.3"
_build:
render: false

View File

@ -4,6 +4,7 @@ keywords: 'Kubernetes, GitOps, KubeSphere, Code Repository'
description: 'Describe how to import a code repository on KubeSphere.'
linkTitle: "Import a Code Repository"
weight: 11231
version: "v3.3"
---
In KubeSphere 3.3, you can import a GitHub, GitLab, Bitbucket, or Git-based repository. The following describes how to import a GitHub repository.

View File

@ -1,6 +1,7 @@
---
linkTitle: "Continuous Deployments"
weight: 11220
version: "v3.3"
_build:
render: false

View File

@ -4,6 +4,7 @@ keywords: 'Kubernetes, GitOps, KubeSphere, CI, CD'
description: 'Describe how to use GitOps for continuous deployment on KubeSphere.'
linkTitle: "Use GitOps to Achieve Continuous Deployment of Applications"
weight: 11221
version: "v3.3"
---
In KubeSphere 3.3, we introduce the GitOps concept, which is a way of implementing continuous deployment for cloud-native applications. The core component of GitOps is a Git repository that always stores applications and declarative description of the infrastructure for version control. With GitOps and Kubernetes, you can enable CI/CD pipelines to apply changes to any cluster, which ensures consistency in cross-cloud deployment scenarios.

View File

@ -1,6 +1,7 @@
---
linkTitle: "DevOps Settings"
weight: 11240
version: "v3.3"
_build:
render: false

View File

@ -4,6 +4,7 @@ keywords: 'Kubernetes, GitOps, KubeSphere, CI/CD, Allowlist'
description: 'Describe how to add a continuous deployment allowlist on KubeSphere.'
linkTitle: "Add a Continuous Deployment Allowlist"
weight: 11243
version: "v3.3"
---
In KubeSphere 3.3, you can set an allowlist so that only specific code repositories and deployment locations can be used for continuous deployment.

View File

@ -4,6 +4,7 @@ keywords: 'Kubernetes, Docker, Credential, KubeSphere, DevOps'
description: 'Create credentials so that your pipelines can communicate with third-party applications or websites.'
linkTitle: "Credential Management"
weight: 11241
version: "v3.3"
---
Credentials are objects containing sensitive information, such as usernames and passwords, SSH keys, and tokens. When a KubeSphere DevOps pipeline is running, it interacts with objects in external environments to perform a series of tasks, including pulling code, pushing and pulling images, and running scripts. During this process, credentials need to be provided accordingly while they do not appear explicitly in the pipeline.

View File

@ -4,6 +4,7 @@ keywords: 'Kubernetes, KubeSphere, DevOps, role, member'
description: 'Create and manage roles and members in DevOps projects.'
linkTitle: "Role and Member Management"
weight: 11242
version: "v3.3"
---
This guide demonstrates how to manage roles and members in your DevOps project.

View File

@ -4,6 +4,7 @@ keywords: 'Kubernetes, docker, KubeSphere, Jenkins, cicd, pipeline, dependency c
description: 'Configure a node or a group of nodes specifically for continuous integration (CI) to speed up the building process in a pipeline.'
linkTitle: "Set a CI Node for Dependency Caching"
weight: 11245
version: "v3.3"
---
Generally, different dependencies need to be pulled as applications are being built. This may cause some issues such as long pulling time and network instability, further resulting in build failures. To provide your pipeline with a more enabling and stable environment, you can configure a node or a group of nodes specifically for continuous integration (CI). These CI nodes can speed up the building process by using caches.

View File

@ -1,6 +1,7 @@
---
linkTitle: "Pipelines"
weight: 11210
version: "v3.3"
_build:
render: false

View File

@ -4,6 +4,7 @@ keywords: 'Kubernetes, KubeSphere, Docker, DevOps, Jenkins, Agent'
description: 'Specify the Jenkins agent and use the built-in podTemplate for your pipeline.'
linkTitle: "Choose Jenkins Agent"
weight: 112190
version: "v3.3"
---
The `agent` section specifies where the entire Pipeline, or a specific stage, will execute in the Jenkins environment depending on where the `agent` section is placed. The section must be defined at the upper-level inside the `pipeline` block, but stage-level usage is optional. For more information, see [the official documentation of Jenkins](https://www.jenkins.io/doc/book/pipeline/syntax/#agent).

View File

@ -4,6 +4,7 @@ keywords: 'KubeSphere, Kubernetes, jenkins, cicd, graphical pipelines'
description: 'Learn how to create and run a pipeline by using the graphical editing panel of KubeSphere.'
linkTitle: 'Create a Pipeline Using Graphical Editing Panels'
weight: 11211
version: "v3.3"
---
A graphical editing panel in KubeSphere contains all the necessary operations used in Jenkins [stages](https://www.jenkins.io/doc/book/pipeline/#stage) and [steps](https://www.jenkins.io/doc/book/pipeline/#step). You can directly define these stages and steps on the interactive panel without creating any Jenkinsfile.

View File

@ -4,6 +4,7 @@ keywords: 'KubeSphere, Kubernetes, Docker, Spring Boot, Jenkins, DevOps, CI/CD,
description: "Learn how to create and run a pipeline by using an example Jenkinsfile."
linkTitle: "Create a Pipeline Using a Jenkinsfile"
weight: 11212
version: "v3.3"
---
A Jenkinsfile is a text file that contains the definition of a Jenkins pipeline and is checked into source control. As it stores the entire workflow as code, it underpins the code review and iteration process of a pipeline. For more information, see [the official documentation of Jenkins](https://www.jenkins.io/doc/book/pipeline/jenkinsfile/).

View File

@ -4,6 +4,7 @@ keywords: "KubeSphere, Kubernetes, DevOps, Jenkins, Agent"
description: "Learn how to customize a Jenkins agent on KubeSphere."
linkTitle: "Customize Jenkins Agent"
Weight: 112191
version: "v3.3"
---
If you need to use a Jenkins agent that runs on a specific environment, for example, JDK 11, you can customize a Jenkins agent on KubeSphere.

View File

@ -4,6 +4,7 @@ keywords: 'KubeSphere, Kubernetes, GitLab, Jenkins, Pipelines'
description: 'Learn how to create a multi-branch pipeline with GitLab on KubeSphere.'
linkTitle: "Create a Multi-branch Pipeline with GitLab"
weight: 11215
version: "v3.3"
---
[GitLab](https://about.gitlab.com/) is an open source code repository platform that provides public and private repositories. It is a complete DevOps platform that enables professionals to perform their tasks in a project.

View File

@ -4,6 +4,7 @@ keywords: 'KubeSphere, Kubernetes, notification, jenkins, devops, ci/cd, pipelin
description: 'Set the email server to receive notifications of your Jenkins pipelines.'
linkTitle: "Set Email Server for KubeSphere Pipelines"
Weight: 11218
version: "v3.3"
---

View File

@ -4,6 +4,7 @@ keywords: 'Kubernetes, KubeSphere, Jenkins, CasC'
description: 'Learn how to customize your Jenkins settings.'
linkTitle: 'Jenkins System Settings'
Weight: 11216
version: "v3.3"
---
Jenkins is powerful and flexible and it has become the de facto standard for CI/CD workflows. Nevertheless, many plugins require users to set system-level configurations before they can be put to use.

View File

@ -4,6 +4,7 @@ keywords: 'KubeSphere, Kubernetes, Jenkins, Shared Library, Pipelines'
description: 'Learn how to use Jenkins shared libraries in a pipeline.'
linkTitle: "Use Jenkins Shared Libraries in a Pipeline"
weight: 11217
version: "v3.3"
---
For Jenkins pipelines that contain the same stages or steps, one way to avoid repetition in the pipeline codes is to use Jenkins shared libraries in the Jenkinsfiles.

View File

@ -4,6 +4,7 @@ keywords: 'KubeSphere, Kubernetes, Docker, Jenkins, Pipelines'
description: 'Understand various pipeline properties in a DevOps project.'
linkTitle: "Pipeline Settings"
weight: 11214
version: "v3.3"
---
When you create a pipeline, you can customize its configurations through various settings. This document illustrates these settings in detail.

View File

@ -4,6 +4,7 @@ keywords: 'Kubernetes, DevOps, Jenkins, Pipeline, Webhook'
description: 'Learn how to trigger a Jenkins pipeline by using a webhook.'
linkTitle: "Trigger a Pipeline by Using a Webhook"
weight: 11219
version: "v3.3"
---
If you create a Jenkinsfile-based pipeline from a remote code repository, you can configure a webhook in the remote repository so that the pipeline is automatically triggered when changes are made to the remote repository.

View File

@ -4,6 +4,7 @@ keywords: 'KubeSphere, Kubernetes, Jenkins, Graphical Pipelines, Pipeline Templa
description: 'Understand how to use pipeline templates on KubeSphere.'
linkTitle: "Use Pipeline Templates"
weight: 11213
version: "v3.3"
---
KubeSphere offers a graphical editing panel where the stages and steps of a Jenkins pipeline can be defined through interactive operations. KubeSphere 3.3 provides built-in pipeline templates, such as Node.js, Maven, and Golang, to help users quickly create pipelines. Additionally, KubeSphere 3.3 also supports customization of pipeline templates to meet diversified needs of enterprises.

View File

@ -7,6 +7,8 @@ linkTitle: "FAQ"
weight: 16000
icon: "/images/docs/v3.x/docs.svg"
version: "v3.3"
---
This chapter answers and summarizes the questions users ask most frequently about KubeSphere. You can find these questions and answers in their respective sections which are grouped based on KubeSphere functions.

View File

@ -4,4 +4,5 @@ keywords: 'Kubernetes, KubeSphere, account, access control'
description: 'Faq about access control and account management'
layout: "second"
weight: 16400
version: "v3.3"
---

View File

@ -4,6 +4,7 @@ keywords: "namespace, project, KubeSphere, Kubernetes"
description: "Add your existing Kubernetes namespaces to a KubeSphere workspace."
linkTitle: "Add existing Kubernetes namespaces to a KubeSphere Workspace"
Weight: 16430
version: "v3.3"
---
A Kubernetes namespace is a KubeSphere project. If you create a namespace object not from the KubeSphere console, the namespace does not appear directly in a certain workspace. But cluster administrators can still see the namespace on the **Cluster Management** page. At the same time, you can also place the namespace into a workspace.

Some files were not shown because too many files have changed in this diff Show More