doc: add run details

Signed-off-by: fanzu8 <tuzengbing@gmail.com>
This commit is contained in:
tuzengbing 2025-07-15 15:27:02 +08:00
parent 9128f7a3a3
commit 67ca28005c
1 changed files with 44 additions and 4 deletions

View File

@ -13,11 +13,51 @@
- **开源技术生态融合**:无缝对接主流开源可观测技术栈,如 Prometheus、Grafana、Pyroscope、Elasticsearch等。支持独立物理机和云原生部署自动感知 K8S 容器资源/标签/注解,自动关联操作系统内核事件指标,消除数据孤岛。通过零侵扰、内核可编程方式兼容主流硬件平台和内核版本,确保其适应性、应用性。
# 快速上手
为用户开发者快速体验 HUATUO 我们提供容器编译镜像的便捷方式,一键运行 docker compose 即可启动。该命令会启动 elasticsearch, prometheus, grafana 以及编译的 huatuo-bamai 组件。上述命令执行成功后,打开浏览器访问 http://localhost:3000 即可浏览监控大盘。
```bash
$ docker compose --project-directory ./build/docker up
```
- **极速体验**
如果你只关心底层原理,不关心存储、前端展示等,我们提供了编译好的镜像,已包含 HUATUO 底层运行的必要组件,直接运行即可:
```bash
$ docker run --privileged --network=host -v /sys:/sys -v /run:/run huatuo/huatuo-bamai:latest
```
- **快速搭建**
如果你想更进一步了解 HUATUO 运行机制,架构设计等,可在本地很方便地搭建 HUATUO 完整运行的所有组件,我们提供容器镜像以及简单配置,方便用户开发者快速了解 HUATUO。
```mermaid
flowchart LR
subgraph host
subgraph huatuo-bamai
A1[【metrics】] <-- "transfer" --> A2[【tracing】]
end
end
subgraph storage backends
A1 -->|:19704| B1[prometheus]
A2 -->|:9200| B2[elasticsearch]
end
subgraph grafana_dashboard["grafana panels"]
B1 -->|:9090| C1[host, container]
B2 -->|:9200| C2[autotracing, events]
end
subgraph browser
D[:3000]
end
C1 --> D
C2 --> D
```
<div style="text-align: center; margin: 8px 0 20px 0; color: #777;">
<small>
HUATUO 组件运行示意<br>
</small>
</div>
为快速搭建运行环境,我们提供一键运行的方式,该命令会启动 elasticsearch, prometheus, grafana 以及 huatuo-bamai 组件。命令执行成功后,打开浏览器访问 http://localhost:3000 即可浏览监控大盘。
```bash
$ docker compose --project-directory ./build/docker up
```
# 软件架构
![](./docs/huatuo-arch.svg)