mirror of
https://github.com/kubesphere/website.git
synced 2025-12-26 00:12:48 +00:00
Merge branch 'master' of https://github.com/kubesphere/website into docs
This commit is contained in:
zhuxiujuan28
commit
c0d2c12f60
|
|
@ -0,0 +1,142 @@
|
|||
---
|
||||
title: 'KubeSphere v4 应用商店配置指南'
|
||||
tag: 'KubeSphere, Kubernetes, KubeSphere v4, KubeSphere LuBan'
|
||||
createTime: '2024-11-01'
|
||||
author: 'inksnw'
|
||||
snapshot: 'https://pek3b.qingstor.com/kubesphere-community/images/ks-v4-appstore-configuration-guide-cover.png'
|
||||
---
|
||||
|
||||
在 KubeSphere v4 版本中，为保持平台的简洁性，系统默认移除了内置应用商店中的应用。用户可以按照下列步骤进行手动配置和添加。
|
||||
|
||||
> 注意：应用商店和扩展市场有所不同，扩展市场的使用方法将在后续文档中详细介绍。
|
||||
>
|
||||
> - **Helm Repo 源**：安装时需要从源下载 Chart 包，需要保证源是可用状态，平台会定时从源同步最新的应用信息
|
||||
> - **应用商店**：应用被存储在平台中，默认不会自动更新，可在审核后全局可见
|
||||
> - **商店导入工具**：用于将 Helm Repo 源中的应用转为应用商店应用
|
||||
|
||||
## 企业空间中的 Helm Repo 源配置
|
||||
|
||||
### 添加源
|
||||
|
||||
在企业空间中添加的源仅对当前空间可见。
|
||||
|
||||
- 进入企业空间，选择左侧边栏中的应用仓库。
|
||||
- 添加一个 Helm Repo 源。
|
||||
|
||||
KubeSphere v3.x 默认提供的 Helm Repo 源为： https://charts.kubesphere.io/stable
|
||||
|
||||
|
||||
|
||||
### 使用源
|
||||
|
||||
- 进入项目，选择应用负载 > 应用。
|
||||
- 点击创建 > 从应用模板，选择对应的应用源。
|
||||
|
||||
|
||||
|
||||
## 仅在企业空间的应用管理
|
||||
|
||||
### 安装应用商店扩展
|
||||
|
||||
在 KubeSphere v4 中需要安装应用商店扩展，才能在企业空间上传应用 Chart 包，上传的 Chart 应用默认只在当前企业空间可见，如需全局可见，请参考后续的全局应用配置。
|
||||
|
||||
- 进入企业空间，选择左侧边栏中的应用模板。
|
||||
- 选择上传 Helm Chart以添加应用。
|
||||
|
||||
|
||||
|
||||
### 使用上传应用
|
||||
|
||||
- 进入项目，选择应用负载 > 应用。
|
||||
- 点击创建 > 从应用模板，选择当前企业空间的应用源。
|
||||
|
||||
|
||||
|
||||
## 全局应用商店的应用
|
||||
|
||||
### 提交审核
|
||||
|
||||
在企业空间上传 Chart 后，可以将应用提交审核，通过审核后，该应用将在全局应用商店中可见，所有用户均可访问。
|
||||
|
||||
- 上传 Chart 后，进入应用详情页。
|
||||
- 点击提交审核按钮。
|
||||
|
||||
|
||||
|
||||
### 通过审核
|
||||
|
||||
通过审核。
|
||||
|
||||
|
||||
|
||||
### 上架
|
||||
|
||||
|
||||
|
||||
此时，所有企业空间的用户都能在应用商店页看到这个应用。
|
||||
|
||||
|
||||
|
||||
## 全局的 Repo 源
|
||||
|
||||
可以在应用商店管理配置的 Repo 源，所有用户在项目内创建应用时，都可以选择到。
|
||||
|
||||
|
||||
|
||||
在项目中创建应用。
|
||||
|
||||
|
||||
|
||||
## 问题说明
|
||||
|
||||
上传 Helm Chart 时如果提示超出限制，需要您删除一下 Chart 包中的无用文件减小体积。
|
||||
|
||||
目前支持上传的文件体积，不能超过 1M，且不能调整。
|
||||
|
||||
当开启了 S3 外置存储时, 可不限制大小： https://github.com/kubesphere/kubesphere/blob/6a2f78ef0f3c8e0497095da831415f4e672dc14a/config/ks-core/values.yaml#L38
|
||||
|
||||
但目前前端还有限制, 预计在 KubeSphere 4.1.3 版本会移除前端的这个限制。
|
||||
|
||||
## 商店导入工具
|
||||
|
||||
如果想把 Helm Repo 中的应用变成商店中的应用，可以使用[商店导入工具](https://github.com/kubesphere-extensions/app-tool)来操作。
|
||||
|
||||
### 概述
|
||||
|
||||
本工具用于把 Helm Repo 中的软件同步到应用商店中。
|
||||
|
||||
这个工具是把 Repo 中的应用变成全局商店应用, 不是必须的操作。
|
||||
|
||||
### 前提条件
|
||||
|
||||
- 可访问的 Kubernetes 集群，并配置好 `~/.kube/config` 文件
|
||||
- 安装应用商店管理扩展
|
||||
|
||||
### 使用方法
|
||||
|
||||
#### 命令行参数
|
||||
|
||||
- `--server`：KubeSphere 的服务器 URL（必填）
|
||||
- `--token`：平台的访问令牌（必填）
|
||||
- `--repo`：Helm Repo的 URL（必填）
|
||||
|
||||
#### 使用示例
|
||||
|
||||
```
|
||||
# 创建service account
|
||||
kubectl apply -f token.yaml
|
||||
# 获取token
|
||||
token=$(kubectl get secrets $(kubectl get serviceaccounts.kubesphere.io app-tool -n default -o "jsonpath={.secrets[].name}") -n default -o jsonpath={.data.token} | base64 -d)
|
||||
# 执行
|
||||
go run main.go --server=http://192.168.50.87:30880 --token=${token} --repo=https://charts.kubesphere.io/stable
|
||||
# 删除service account
|
||||
kubectl delete -f token.yaml
|
||||
```
|
||||
|
||||
### 注意事项
|
||||
|
||||
#### 多次执行的场景
|
||||
|
||||
由于商店允许多次上传并生成随机名称的应用，本工具不会处理多次执行的场景。如果您多次执行，希望清理生成的资源，请手动执行：
|
||||
|
||||
`kubectl delete applications.application.kubesphere.io xxx`
|
||||
|
|
@ -0,0 +1,142 @@
|
|||
---
|
||||
title: 'KubeSphere v4 扩展组件使用指南'
|
||||
tag: 'KubeSphere, Kubernetes, KubeSphere v4, KubeSphere LuBan'
|
||||
createTime: '2024-11-07'
|
||||
author: 'KubeSphere'
|
||||
snapshot: 'https://pek3b.qingstor.com/kubesphere-community/images/ks-v4-extension-guide-cover.png'
|
||||
---
|
||||
|
||||
日前，KubeSphere v4 发布，相较于之前的版本，新版本在架构上有了较大的变化。其中，有一个新的概念——扩展组件。
|
||||
|
||||
本文我们将针对扩展组件做一个详细的说明，让大家对扩展组件能够了解、理解和丝滑使用。
|
||||
|
||||
关于 KubeSphere v4 的介绍，请阅读本文：[KubeSphere v4 开源并发布全新可插拔架构 LuBan](https://www.kubesphere.io/zh/news/kubesphere-v4-ga-announcement/)。
|
||||
|
||||
如何安装 KubeSphere v4，请参考本文：[KubeSphere v4 安装指南](https://www.kubesphere.io/zh/blogs/kubesphere-v4-install-guide/)。
|
||||
|
||||
## 扩展市场介绍
|
||||
|
||||
KubeSphere 扩展组件用于扩展 KubeSphere 的平台能力，用户可在系统运行时动态地安装、卸载、启用、禁用扩展组件。
|
||||
|
||||
监控、告警、通知、项目网关和集群网关、卷快照、网络隔离等功能，将由扩展组件来提供。
|
||||
|
||||
**扩展组件的方式，解决了 KubeSphere 之前版本诸如“发版周期长”、“代码耦合”、“系统资源占用过多”等问题。用户可以根据自己的需求来安装和启用扩展组件，真正做到按需使用，实现轻量化。另外，用户还可以根据自己的需求进行定制和扩展，以满足不同的设计和功能要求。**
|
||||
|
||||
目前，我们已经开源了 21 个扩展组件，您可以根据对应 v3.4 中的功能决定是否安装，分别是：
|
||||
|
||||
|
||||
| 扩展组件名称 | 对应 v3.4 功能点 | 新增功能点 | 挂载位置 |
|
||||
| --------------------------------- | ---------------- | ---------------- | -------------------- |
|
||||
| KubeSphere 网络 | IP池、网络隔离 | 无 | 项目、企业空间、集群管理页面左侧导航栏 |
|
||||
| KubeSphere 应用商店管理 | 应用上架审核，chart 包上传 | 全局应用实例管理 | 九宫格，企业空间导航 |
|
||||
| KubeSphere 存储 | 存储类授权规则，PVC 自动扩容，快照 | 无 | 集群和项目的左侧导航栏|
|
||||
| KubeSphere 服务网格 | 灰度发布<br>自制应用 | 无 | 项目管理页面左侧导航栏 |
|
||||
| KubeSphere 多集群代理连接 | 使用代理连接模式纳管集群 | 无 | 添加集群模式选择下拉框 |
|
||||
| KubeSphere 网关 | 项目、企业空间、集群网关 | 创建 Ingress 时支持配置 Ingress class | 项目、企业空间、集群管理页面左侧导航栏 |
|
||||
| DevOps | 流水线、持续部署、代码仓库、S2I/B2I | 无 | 企业空间左侧导航栏 |
|
||||
| KubeEdge |边缘计算 | 无 | 集群左侧导航栏 |
|
||||
| 联邦集群应用管理 | 联邦项目以及联邦应用 | 无 | 企业空间左侧导航栏 |
|
||||
| OpenSearch 分布式检索与分析引擎 | OpenSearch | 无 | 无挂载点，直接暴露服务进行访问 |
|
||||
| Grafana for WhizardTelemetry | - | 新增扩展，增强 WhizardTelemetry 可观测平台的可视化能力 | 无挂载点，直接暴露服务进行访问 |
|
||||
| Grafana Loki for WhizardTelemetry | - | 部署 Grafana Loki | 无 |
|
||||
| WhizardTelemetry 数据流水线 | 提供日志、事件、审计等数据收集能力，用以替代 FluentBit | 无 | 无 |
|
||||
| WhizardTelemetry 平台服务 | 提供监控、日志、审计、事件、通知查询接口 | 无 | 无 |
|
||||
| WhizardTelemetry 告警 | KubeSphere 告警 | 无 | 集群和项目的左侧导航栏 |
|
||||
| WhizardTelemetry 事件 | KubeSphere 事件 | 支持使用 Loki 作为后端存储 | ⼯具箱 |
|
||||
| WhizardTelemetry 日志 | KubeSphere 日志 | 支持使用 Loki 作为后端存储 | ⼯具箱、集群设置 |
|
||||
| WhizardTelemetry 监控 | KubeSphere 监控 | 增强集群概览与项目概览页面监控 | 集群和项目的左侧导航栏将显示监控告警，可查看集群状态等，集群、企业空间、项目下等诸多页面也将显示相关监控数据 |集群和项目的左侧导航栏
|
||||
| WhizardTelemetry 通知 | KubeSphere 通知 | 支持使用 Loki 作为通知历史的后端存储。通知只需要在 host 集群部署了 | 平台设置左侧导航栏 |
|
||||
| Metrics Server | 可视化创建和管理 HPA | 无 |工作负载（Deployment/SatetfulSet） 详情页支持可视化创建和管理 HPA |
|
||||
| Gatekeeper | 安全准入策略管理 | UI 支持<br>版本更新 | 集群管理页面左侧导航栏 |
|
||||
|
||||
扩展组件仓库：https://github.com/kubesphere-extensions/ks-extensions/
|
||||
|
||||
您可以在扩展组件仓库中了解每个扩展组件的具体功能以及详细的安装及使用方法。
|
||||
|
||||
> 注意：扩展市场不等同于应用商店，两者的对比，可参考[对比文档](https://dev-guide.kubesphere.io/extension-dev-guide/zh/faq/01-difference/)。
|
||||
>
|
||||
> 关于应用商店的使用方法，详见文章 [KubeSphere v4 应用商店配置指南](https://www.kubesphere.io/zh/blogs/kubesphere-v4-appstore-configuration-guide/)。
|
||||
|
||||
## 扩展组件使用方式
|
||||
|
||||
KubeSphere v4 除账户、权限、租户、实时监控和日志功能外，其他功能都以扩展组件提供且不默认安装。
|
||||
|
||||
在安装完成后，请从左上角“扩展市场”导航菜单进入扩展市场，按需开启扩展组件。
|
||||
|
||||
|
||||
|
||||
> 💡 如果扩展市场是空的，怎么排查？
|
||||
> 1. `kubectl -n kubesphere-system get deploy extensions-museum` 检查本地扩展组件仓库是否正常 Running
|
||||
> 2. `kubectl describe repository.kubesphere.io extensions-museum` 检查扩展组件仓库是否正常同步
|
||||
> 3. 主动触发同步 `kubectl patch repository extensions-museum --type=merge -p '{"status":null}'`
|
||||
|
||||
接下来以 Gatekeeper 扩展组件为例进行演示。
|
||||
|
||||
打开需要安装的扩展组件详情页面：
|
||||
|
||||
|
||||
|
||||
依次点击“管理”、“安装”，选择合适的扩展组件版本：
|
||||
|
||||
|
||||
|
||||
对扩展组件进行配置：
|
||||
|
||||
|
||||
|
||||
|
||||
点击开始安装：
|
||||
|
||||
|
||||
|
||||
等待安装完成后点击下一步，选择需要开启扩展组件的目标集群：
|
||||
|
||||
|
||||
|
||||
|
||||
对目标集群中扩展组件进行差异化配置，在差异化配置页签，分别编辑选中集群的 YAML 配置，也可不修改，使用初始默认配置。点击确定，开始配置集群 Agent：
|
||||
|
||||
|
||||
|
||||
|
||||
等待扩展组件集群 Agent 安装完成后**刷新页面**：
|
||||
|
||||
|
||||
|
||||
安装完成后，默认启用该组件。您可以在扩展中心对扩展组件进行启用、禁用、配置变更、卸载等操作：
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
不同的扩展组件会有不同的集成方式，有的会将扩展组件的功能入口放在顶部导航栏，有的扩展组件会将功能入口放在企业空间或项目的侧边栏，有的扩展组件会将功能入口放在快捷访问入口。
|
||||
|
||||
还是以 Gatekeeper 扩展组件为例，扩展组件安装完成之后，进入到集群管理页面，从左侧导航栏可以进入扩展组件的功能入口。
|
||||
|
||||
|
||||
|
||||
查看扩展组件的默认配置：
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
> 目前[官网文档](https://www.kubesphere.io/zh/docs/v4.1/11-use-extensions/)也已更新，详细介绍了如何使用 KubeSphere 的各个扩展组件，您也可以参考。
|
||||
|
||||
## 开发自己的扩展组件，创造属于您自己的价值
|
||||
|
||||
社区目前正在逐步发布开源的扩展组件，为各位用户提供更多的功能，让各位用户有更多的选择。同时您可以开发自己的扩展组件，并将其上架到 Marketplace，为其定价，如果是确实有价值的扩展组件，相信您可以收获到对应的回报。
|
||||
|
||||
目前，已经有一位参与开源之夏的学生贡献者张豈明，开发了一款扩展组件 Pod Status Analysis Tool，地址： https://github.com/kubesphere-extensions/ks-extensions-contrib/tree/main/pod-analyzer。
|
||||
|
||||
贡献仓库： https://github.com/kubesphere-extensions/ks-extensions-contrib
|
||||
|
||||
开发指南： https://dev-guide.kubesphere.io/extension-dev-guide/zh/
|
||||
|
||||
## 总结
|
||||
|
||||
以上就是扩展组件使用的方法说明。如果您在使用过程中出现问题，可去论坛搜索是否有解答，如没有，可在论坛提问：https://ask.kubesphere.io/forum/。
|
||||
Loading…
Reference in New Issue