Skip to content

Commit

Permalink
improve extension docs and add docs in quickstart
Browse files Browse the repository at this point in the history
Signed-off-by: zhuxiujuan28 <[email protected]>
  • Loading branch information
zhuxiujuan28 committed Nov 7, 2024
1 parent 8805080 commit ca8c3e7
Show file tree
Hide file tree
Showing 29 changed files with 720 additions and 113 deletions.
Original file line number Diff line number Diff line change
Expand Up @@ -15,8 +15,11 @@ This section explains how to install applications from the App Store.

== Prerequisites

// * {empty}
include::../../../../_custom-en/projectManagement/projectManagement-prer-requiredPermission_new.adoc[]

// * At least one application have been listed in the App Store. For more information, please refer to link:../../../../11-use-extensions/02-app-store/03-app-store-management/01-apps/06-publish-an-app-template/[Publish Application Templates].

== Steps

include::../../../../_custom-en/projectManagement/projectManagement-oper-openProjectPage.adoc[]
Expand Down
106 changes: 106 additions & 0 deletions content/zh/docs/_custom/extension-intro-ks.adoc
Original file line number Diff line number Diff line change
@@ -0,0 +1,106 @@
[.admon.note,cols="a"]
|===
|说明

|可在{ks_product_left} Web 控制台的扩展市场中查看各个扩展组件的更多信息。
|===

[%header,cols="1a,1a,3a"]
|===
|类别 |名称 |功能

.10+|WhizardTelemetry 可观测平台
|WhizardTelemetry 平台服务
|它是 WhizardTelemetry 可观测平台各扩展组件的公共服务。是各个可观测性扩展组件通用的 APIServer,为所有可观测性扩展组件提供公共的后端平台服务。

|WhizardTelemetry 数据流水线
|提供可观测性数据的收集、转换和路由能力。

|OpenSearch 分布式检索与分析引擎
|KubeSphere 内置的日志存储扩展组件,用于存储日志、审计、事件、通知历史等可观测数据。

|WhizardTelemetry 日志
|提供多租户视角的云原生应用实时及历史日志收集、查询、导出、存储等功能,可对接如 ElasticSearch、OpenSearch、Kafka 等日志接收器。

|WhizardTelemetry 事件
|可长期保存 Kubernetes 相关对象产生的事件,并提供多租户视角的事件检索和查看功能。

// |WhizardTelemetry 审计
// |实时记录{ks_product_both}平台上的用户相关操作行为,并提供多租户视角的审计历史的检索及查看功能,可快速回溯相关用户的操作行为。

|WhizardTelemetry 监控
|提供多租户视角的云原生资源监控能力,包括针对集群,节点,工作负载、GPU、K8s 控制面等对象的核心监控指标进行实时和历史数据展示等功能。其中包含了 Whizard 可观测中心。

|WhizardTelemetry 告警
|基于 KubeSphere 采集的监控数据,可针对不同资源类型和监控指标,提供平台及租户视角的告警及告警规则管理功能。

// |WhizardTelemetry 事件告警
// |为 Kubernetes/KubeSphere 审计事件、Kubernetes 原生事件、以及 Kubernetes 日志定义告警规则,对传入的事件数据和日志数据进行评估,并将告警发送到指定的接收器如 HTTP 端点等。

|WhizardTelemetry 通知
|管理多租户 Kubernetes 环境中的通知。它能够接收来自不同发送者的告警、云事件以及其他类型的事件(例如审计和 Kubernetes 事件),并根据租户标签(如命名空间或用户)将通知发送给相应的租户接收器。

|Grafana for WhizardTelemetry
|一个开放且可组合的数据可视化和监控分析平台,内置众多仪表盘(Dashboard)来增强 WhizardTelemetry 可观测平台的可视化能力。

|Grafana Loki for WhizardTelemetry
|支持在 Grafana 控制台查看存储到 Loki 的 KubeSphere 日志、审计、事件及通知历史数据。

.6+|平台管理
|KubeSphere 应用商店管理
|基于 OpenPitrix 的多云应用管理平台,用于上传、审核并管理多云环境中不同类型的应用。它可作为企业不同团队间数据、中间件和办公应用的共享与分发管理工具。

|KubeSphere 服务网格
|一款强大的微服务治理与微服务可视化管理工具。它提供包括蓝绿部署、金丝雀发布与流量镜像三种灰度发布策略,与流量监控、链路追踪两项可观测能力。

|KubeSphere 多集群代理连接
|它是一种通过代理在集群间建立网络连接的工具。如果主集群无法直接访问成员集群,您可以暴露主集群的代理服务地址,这样可以让成员集群通过代理连接到主集群。

|联邦集群应用管理
|一个旨在简化跨多个联邦 Kubernetes 集群管理应用程序的扩展组件,用户可以轻松地在多个联邦集群中部署、更新和管理应用程序。

|KubeEdge 边缘计算框架
|为集群添加边缘节点并在这些节点上运行工作负载,以便将本机容器化应用编排和管理扩展到边缘端设备。

|Metrics Server
|根据设定指标对 Pod 数量进行动态伸缩,使运行在上面的服务对指标的变化有一定的自适应能力。

// |Spring Cloud
// |提供微服务、微服务配置和微服务网关功能。

// |数据库与中间件
// |RadonDB DMP
// |一款面向 Kubernetes 多云场景的企业级云原生数据库管理平台。能轻松实现多类型主流数据库的跨云部署、多云管理、智能观测与统一运维等,并完整构建围绕高性能、高可用、业务追踪、数据流转等场景下的生态闭环,助力客户真正实现数据库即服务。

|CI/CD
|DevOps
|基于 Jenkins 提供开箱即用的 CI/CD 功能,提供一站式 DevOps 方案、支持使用图形编辑面板或 Jenkinsfile 创建流水线。

.2+|网络
|KubeSphere 网关
|KubeSphere 网关是聚合服务、管理 KubeSphere 平台外部访问的扩展组件,现已形成“集群、项目、企业空间”三类资源管理维度的网关体系,支持管理集群网关、企业空间网关与项目网关。

|KubeSphere 网络
|管理集群的网络策略和容器组 IP 池。控制集群和项目中容器组的访问和被访问权限;创建容器组 IP 池并从 IP 池中分配 IP 地址到 Pod。

// |应用路由工具
// |为应用路由提供多项实用扩展能力,如域名重用校验,添加后,租户侧在创建应用路由无法将同一个域名应用在不同的项目中。

|安全
|Gatekeeper
|Gatekeeper 是一个用于 Kubernetes 可灵活配置策略的准入控制器,利用 link:https://www.openpolicyagent.org/[Open Policy Agent (OPA)] 验证在 Kubernetes 集群上创建和更新资源的请求。

// |OAuth2-Proxy
// |提供统一认证接口确保所有应用通过相同流程保护,简化多应用环境下的身份验证管理,提高安全性和用户体验,适用于需要对多个后端应用进行统一认证管理的企业环境,以及需要通过第三方认证服务进行用户身份验证的应用。

// |证书管理
// |为 Kubernetes 中的工作负载创建 TLS 证书,并在证书过期前续订。

|存储
|KubeSphere 存储
|管理卷快照、卷快照类、为存储类设置授权规则、设置存储卷自动扩展。

// |人工智能
// |NVIDIA GPU Operator
// |基于 link:https://github.com/NVIDIA/gpu-operator[GPU Operator] 改造的扩展组件,支持在 Kubernetes 上创建、配置和管理 GPU。
|===
38 changes: 38 additions & 0 deletions content/zh/docs/_custom/install-all-extensions.adoc
Original file line number Diff line number Diff line change
@@ -0,0 +1,38 @@
. 以具有 **platform-admin** 角色的用户登录{ks_product_left} Web 控制台。

. 点击**扩展中心**,搜索您要安装的扩展组件。

. 点击扩展组件名称,然后点击**安装**,进入组件安装页面。

. 在组件安装对话框的**版本选择**页签,选择扩展组件的版本号,并安装好所有必装组件(若有),点击**下一步**
+
[.admon.note,cols="a"]
|===
|说明

|
安装检测时,会识别扩展组件是否有依赖组件。依赖组件分为必装组件和选装组件。

若必装组件的状态为**未就绪**,您需要先行安装正确版本的必装组件,以确保扩展组件的正常使用。而选装组件不会影响扩展组件的安装。
|===

. 在**扩展组件安装**页签,修改扩展组件的配置后(可选),点击**开始安装**,开始安装扩展组件。
+
image:/images/ks-qkcp/zh/v4.0/install-extensions.png[,100%]

. 待安装完成后,点击**下一步**,配置集群 Agent。

. 在**集群选择**页签,根据名称、标识选择集群(可选择多个集群),以便在目标集群中开启扩展组件。

. 在**差异化配置**页签,分别编辑选中集群的 YAML 配置,也可不修改,使用初始默认配置。点击**确定**,开始安装集群 Agent,等待完成即可。
+
--
安装完成后,默认启用扩展组件。

[.admon.note,cols="a"]
|===
|说明

|部分扩展组件不需要安装集群 Agent(即没有**集群选择****差异化配置**页签),请以实际页面为准。
|===
--

This file was deleted.

42 changes: 42 additions & 0 deletions content/zh/docs/v4.1/02-quickstart/02-install-an-extension.adoc
Original file line number Diff line number Diff line change
@@ -0,0 +1,42 @@
---
title: "安装并使用扩展组件"
keywords: "Kubernetes, KubeSphere, 快速入门, 安装组件, 示例, DevOps, 扩展组件功能"
description: "介绍所有扩展组件,并演示如何安装扩展组件。"
weight: 02
---


自 v4.1 开始,KubeSphere 解耦了一些核心功能组件,它们以扩展组件的方式无缝融入到 KubeSphere 控制台中,并独立维护版本,真正实现即插即用的应用级云原生操作系统。

原有的功能模块,如 DevOps,服务网格,可观测(包括监控、告警、日志、事件、通知),应用商店,边缘计算,网络与存储管理等,现由扩展组件提供。因此,为了充分利用这些功能,建议您根据实际需求选择要安装的扩展组件,定制您专属的 KubeSphere 容器管理平台。


== 了解扩展组件

请参照下表了解扩展组件的功能,以便选择合适的扩展组件进行安装。

include::../../_custom/extension-intro-ks.adoc[]

== 安装扩展组件

include::../../_custom/install-all-extensions.adoc[]

== 管理扩展组件

ifeval::["{file_output_type}" == "html"]
您可以在扩展中心link:../../06-extension-user-guide/03-manage-components[配置、升级、禁用、卸载扩展组件]。
endif::[]

ifeval::["{file_output_type}" == "pdf"]
您可以在扩展中心配置、升级、禁用、卸载扩展组件,请参阅《{ks_product_right}扩展组件管理指南》。
endif::[]

== 使用扩展组件

ifeval::["{file_output_type}" == "html"]
扩展组件的使用方法各不相同,请参阅link:../../11-use-extensions/[扩展组件使用指南],了解各个扩展组件的功能入口、配置及使用方法。
endif::[]

ifeval::["{file_output_type}" == "pdf"]
扩展组件的使用方法各不相同,请参阅《{ks_product_right}扩展组件使用指南》,了解各个扩展组件的功能入口、配置及使用方法。
endif::[]
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
---
title: "控制用户权限"
linkTitle: "创建企业空间、项目、用户和平台角色"
linkTitle: "创建企业空间、项目、用户和角色"
keywords: "Kubernetes, KubeSphere, 快速入门, 用户, 权限"
description: "介绍如何创建用户,并使用企业空间、项目和角色控制用户的访问权限。"
weight: 03
Expand Down
Loading

0 comments on commit ca8c3e7

Please sign in to comment.