Skip to content

Commit e48aa8f

Browse files
authored
Merge pull request #8 from frezes/docs/extensions
add holmesgpt docs
2 parents a3f559a + 641fd7c commit e48aa8f

13 files changed

Lines changed: 215 additions & 19 deletions

File tree

website/docs/extension-managerment/install.md

Lines changed: 0 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -46,15 +46,13 @@ title: 安装扩展组件
4646
4747
安装成功后,该扩展组件默认即被启用。
4848

49-
---
5049

5150
## 🧭 后续操作 & 使用
5251

5352
- 在 KubeSphere 控制台的扩展中心中,查看已安装扩展列表
5453
- 对已安装的扩展进行升级、配置或卸载
5554
- 使用扩展组件提供的功能模块(访问 UI、管理 Agent、查看状态等)
5655

57-
---
5856

5957
## 📘 延伸阅读
6058

website/docs/extension-managerment/manage.md

Lines changed: 0 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -15,7 +15,6 @@ title: 管理扩展组件
1515
- 配置集群 Agent
1616
- 禁用或启用扩展组件
1717

18-
---
1918

2019
## 🧩 配置扩展组件
2120

@@ -44,7 +43,6 @@ title: 管理扩展组件
4443
- **复制(Copy)**:复制当前配置信息。
4544
- **下载(Download)**:下载当前配置文件。
4645

47-
---
4846

4947
## ⚙️ 配置集群 Agent
5048

@@ -70,7 +68,6 @@ title: 管理扩展组件
7068
- **copy-light**:复制当前配置信息。
7169
- **download-new**:下载配置文件。
7270

73-
---
7471

7572
## 🚫 禁用扩展组件
7673

@@ -90,7 +87,6 @@ title: 管理扩展组件
9087
4. 点击组件图标下的 **更多(More)**,选择 **禁用(Disable)**
9188
5. 若需重新启用组件,再次点击 **更多(More)**,选择 **启用(Enable)**
9289

93-
---
9490

9591
## 📘 延伸阅读
9692

website/docs/extension-managerment/uninstall.md

Lines changed: 0 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -13,14 +13,12 @@ title: 卸载扩展组件
1313

1414
对于配置了集群 Agent 的扩展组件,卸载时会先卸载集群 Agent,再卸载组件。
1515

16-
---
1716

1817
## ⚠️ 前提条件
1918

2019
- 您需要在 KubeSphere 平台中具有 **platform-admin** 角色。
2120
有关更多信息,请参阅 [用户和平台角色](https://docs.kubesphere.com.cn/v4.2.0/07-user-guide/02-platform-management/04-users-and-roles/)
2221

23-
---
2422

2523
## 🛠 操作步骤
2624

@@ -30,15 +28,13 @@ title: 卸载扩展组件
3028
4. 点击组件图标下的 **更多(More)**,选择 **卸载(Uninstall)**
3129
5. 输入扩展组件的名称,点击 **确定(Confirm)** 开始卸载。
3230

33-
---
3431

3532
## ⚠️ 注意事项
3633

3734
- 卸载操作不可撤销,请在确认不再使用该组件后再执行此操作。
3835
- 若组件依赖其他扩展或服务,请先评估其影响。
3936
- 对于配置了集群 Agent 的扩展组件,系统会自动清理相关资源,无需手动删除。
4037

41-
---
4238

4339
## 📘 延伸阅读
4440

website/docs/extension-managerment/upgrade.md

Lines changed: 0 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -13,7 +13,6 @@ title: 升级扩展组件
1313

1414
当组件发布新版本后,您可以在扩展中心的组件详情页中执行升级操作。
1515

16-
---
1716

1817
## ⚠️ 注意事项
1918

@@ -34,15 +33,13 @@ title: 升级扩展组件
3433
2. **推荐使用默认配置**,以自动获取与当前扩展版本匹配的镜像标签。
3534
3. 各扩展组件镜像标签的具体配置路径,请参阅 **扩展中心各组件详情页的升级说明**
3635

37-
---
3836

3937
## 🧩 前提条件
4038

4139
- 您需要在 KubeSphere 平台中具有 **platform-admin** 角色。
4240
有关更多信息,请参阅 [用户和平台角色](https://docs.kubesphere.com.cn/v4.2.0/07-user-guide/02-platform-management/04-users-and-roles/)
4341
- 目标组件已安装,且存在可用的新版本。
4442

45-
---
4643

4744
## ⚙️ 操作步骤
4845

@@ -53,7 +50,6 @@ title: 升级扩展组件
5350
5. 在弹出的更新对话框中,根据提示完成升级步骤。
5451
6. 升级完成后,系统会自动同步至新的组件版本。
5552

56-
---
5753

5854
## 📘 延伸阅读
5955

website/docs/quick-start.md

Lines changed: 3 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -7,7 +7,6 @@ sidebar_position: 2
77
本章节介绍如何在 **KubeSphere** 环境中快速部署 **AI Labs**
88
你可以选择以下两种方式之一进行安装:
99

10-
---
1110

1211
## 方式 1:使用 kubectl 部署(推荐)
1312

@@ -30,7 +29,7 @@ kubectl get deploy -n kubesphere-system -l app=ai-labs-museum
3029
> 此方式适合快速安装与功能体验。
3130
> 系统会自动同步扩展,无需手动推送。
3231
33-
---
32+
3433

3534
## 方式 2:手动推送扩展至 KubeSphere 扩展中心(开发者使用)
3635

@@ -43,7 +42,7 @@ git clone https://github.com/frezes/ai-labs.git
4342
cd ai-labs
4443
```
4544

46-
---
45+
4746

4847
### ⚙️ 步骤 2:构建并发布扩展
4948

@@ -60,7 +59,7 @@ ksbuilder publish extensions/{extension}/config/{extension}
6059
> * `{extension}` 请替换为实际扩展名称(如 `holmesgpt``open-webui``jupyterhub` 等)。
6160
> * 推送成功后,扩展将出现在 KubeSphere 控制台的 **扩展中心** 页面。
6261
63-
---
62+
6463

6564
## 📘 接下来做什么
6665

Lines changed: 9 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,9 @@
1+
{
2+
"label": "HolmesGPT",
3+
"position": 2,
4+
"link": {
5+
"type": "generated-index"
6+
},
7+
"collapsible": true,
8+
"collapsed": false
9+
}
Lines changed: 44 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,44 @@
1+
---
2+
sidebar_position: 2
3+
title: HolmesGPT 配置
4+
---
5+
6+
# HolmesGPT 配置
7+
8+
## 模型选择与接入
9+
10+
HolmesGPT 支持多家 AI 提供商,让您可以灵活地选择最适合您需求和预算的模型。包括 Anthropic、AWS Bedrock、Azure OpenAI、Gemini、Google Vertex AI、Ollama、OpenAI、OpenAI-Compatible 等。
11+
12+
当然,HolmesGPT 也进行了 Benchmark,以帮助您选择最合适的模型,更详细内容可参考 [HolmesGPT LLM Evaluation Benchmark Results](https://holmesgpt.dev/development/evaluations/latest-results/)
13+
14+
### Model Accuracy Comparison
15+
16+
| Model | Pass | Fail | Skip/Error | Total | Success Rate |
17+
|-----------------------------------------------------|------|------|-------------|--------|------------------------|
18+
| gpt-4o | 52 | 41 | 12 | 105 | 🟡 **56% (52/93)** |
19+
| eu.anthropic.claude-sonnet-4-20250514-v1:0 | 82 | 13 | 10 | 105 | 🟡 **86% (82/95)** |
20+
| gpt-4.1 | 67 | 27 | 11 | 105 | 🟡 **71% (67/94)** |
21+
| gpt-5 | 74 | 20 | 11 | 105 | 🟡 **79% (74/94)** |
22+
| deepseek/deepseek-v3.1-terminus | 75 | 20 | 10 | 105 | 🟡 **79% (75/95)** |
23+
| qwen/qwen3-next-80b-a3b-instruct | 55 | 40 | 10 | 105 | 🟡 **58% (55/95)** |
24+
25+
### 模型配置接入
26+
27+
你可以 [ai-providers](https://holmesgpt.dev/ai-providers/) 查看所有支持的 AI 提供商,并选择你需要的提供商进行配置。
28+
29+
30+
## 数据源配置
31+
32+
HolmesGPT 连接到您的监控和可观察性工具,以提供全面的根本原因分析。您可以在 [data-sources](https://holmesgpt.dev/data-sources/) 查看所有支持的数据源,并进行配置。
33+
34+
- 内置工具集
35+
36+
预先配置了 Prometheus、Grafana、DataDog 等流行工具的集成。
37+
38+
- 自定义工具集
39+
40+
为专有或专用工具创建您自己的集成。
41+
42+
- 远程 MCP 服务器
43+
44+
连接到模型上下文协议服务器以获得扩展功能。
230 KB
Loading
163 KB
Loading
Lines changed: 123 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,127 @@
11
---
22
sidebar_position: 1
3+
title: HolmesGPT 介绍
34
---
45

5-
# Intro
6+
# HolmesGPT 介绍
7+
8+
## HolmesGPT 是什么
9+
10+
**HolmesGPT** 是一个面向云原生环境的智能故障排查助手(AI Agent for Troubleshooting Cloud-Native Environments)。
11+
它基于大语言模型(LLM),通过交互式分析、自动化集成和多源数据联动,帮助用户快速定位和解决云原生系统中的问题。
12+
13+
14+
15+
## 主要特性
16+
17+
### 1. 交互式诊断(Interactive Mode)
18+
19+
HolmesGPT 提供强大的对话式交互界面,支持用户以自然语言与 AI 进行多轮对话式排障。
20+
它能够理解上下文,结合日志、事件、配置等信息,进行迭代式的故障分析与建议。
21+
22+
### 2. CI/CD 流水线故障分析
23+
24+
HolmesGPT 可集成到 CI/CD 流水线中,自动识别并分析部署失败的原因。
25+
当部署失败时,系统会即时生成诊断结果,并可将分析报告推送到 **Slack** 等协作工具中,帮助开发团队快速响应。
26+
27+
### 3. Prometheus 告警分析
28+
29+
通过连接到 **AlertManager** 实例,HolmesGPT 能够对 Prometheus/AlertManager 的告警进行深入分析。
30+
无论是全量告警还是特定告警,都可通过 HolmesGPT 发起智能调查,定位潜在问题根因。
31+
32+
### 4. MCP 集成分析
33+
34+
HolmesGPT 支持与 **MCP(Model Context Protocol)** 服务器集成,可结合 **MCP****自定义 tool_call** 进行智能化排查,帮助运维人员快速理解和解决集群异常。
35+
36+
37+
38+
## 快速开始
39+
40+
### 前提条件
41+
42+
在开始之前,请确保:
43+
44+
- 已部署可用的 **KubeSphere** 环境。
45+
- 已按照 [AI Labs 快速开始指南](https://frezes.github.io/ai-labs/docs/quick-start/) 安装完成 AI Labs 平台。
46+
47+
48+
49+
### 安装 HolmesGPT 扩展
50+
51+
1. 打开 **KubeSphere 扩展中心**
52+
2. 搜索 **HolmesGPT** 并进入详情页。
53+
3. 点击 **安装**,根据提示完成安装流程。
54+
55+
#### 示例配置
56+
57+
```yaml
58+
holmes:
59+
logLevel: DEBUG
60+
additionalEnvVars:
61+
- name: CLUSTER_NAME
62+
value: "host"
63+
- name: DEEPSEEK_API_BASE
64+
value: "https://openapi.coreshub.cn/v1" # 请替换为您的 DeepSeek API Base
65+
- name: DEEPSEEK_API_KEY
66+
value: "sk-*******************" # 请替换为您的 DeepSeek API Key
67+
68+
customClusterRoleRules:
69+
- apiGroups: ["monitoring.coreos.com"]
70+
resources: ["servicemonitors", "podmonitors", "prometheusrules"]
71+
verbs: ["get", "list"]
72+
- apiGroups: [""]
73+
resources: ["secrets", "pods", "services", "configmaps", "persistentvolumeclaims"]
74+
verbs: ["get", "list", "watch"]
75+
- apiGroups: [""]
76+
resources: ["namespaces"]
77+
verbs: ["get"]
78+
- apiGroups: ["apps"]
79+
resources: ["deployments", "statefulsets", "daemonsets"]
80+
verbs: ["get", "list", "watch"]
81+
- apiGroups: ["batch"]
82+
resources: ["jobs", "cronjobs"]
83+
verbs: ["get", "list", "watch"]
84+
- apiGroups: ["networking.k8s.io"]
85+
resources: ["ingresses"]
86+
verbs: ["get", "list", "watch"]
87+
88+
toolsets:
89+
kubernetes/core:
90+
enabled: true
91+
kubernetes/logs:
92+
enabled: true
93+
kubernetes/prometheus_stack:
94+
description: This toolset fetches Prometheus target definitions. Requires specific cluster role rules.
95+
enabled: true
96+
helm/core:
97+
enabled: true
98+
robusta:
99+
enabled: false
100+
internet:
101+
enabled: true
102+
prometheus/metrics:
103+
enabled: true
104+
config:
105+
prometheus_url: "http://prometheus-k8s.kubesphere-monitoring-system.svc:9090"
106+
107+
modelList:
108+
deepseek:
109+
api_key: "{{ env.DEEPSEEK_API_KEY }}"
110+
model: deepseek/DeepSeek-V3.1-Terminus # 请替换为您的 DeepSeek 模型
111+
temperature: 0
112+
```
113+
114+
安装完成后,HolmesGPT 将出现在扩展组件列表中,可直接进入交互模式进行使用。
115+
116+
> 💡 **提示:**
117+
> 模型原则上支持多种,可查看[配置部分](./configuration.md)了解详情。国内推建使用 **DeepSeek-V3.1-Terminus** 模型。
118+
> 可使用基石智算的产品,[注册](https://www.coreshub.cn/) 即送算力券,参考如下方式[获取 API Key](https://docs.coreshub.cn/console/big_model_server/api_key/create_api_key),使用 **DeepSeek-V3.1-Terminus** 模型。
119+
120+
121+
122+
## 下一步
123+
124+
* [使用 HolmesGPT 进行交互式排障](./playground.md)
125+
* [配置 HolmesGPT](./configuration.md)
126+
* [更多关于 HolmesGPT 的信息](https://holmesgpt.dev/)
127+

0 commit comments

Comments
 (0)