Skip to content

Commit 357115e

Browse files
committed
docs: 更新项目架构图和代码架构图及其描述
1 parent a5a93e5 commit 357115e

File tree

6 files changed

+22
-21
lines changed

6 files changed

+22
-21
lines changed

docs/overview/architecture.md

+10-4
Original file line numberDiff line numberDiff line change
@@ -13,12 +13,18 @@
1313

1414
2. **服务层(service layer)**: 服务层划分为两大模块
1515

16-
1. **资源管理模块**: 在配置平台中我们把资源类型进行了抽象,目前划分为主机、进程、通用对象三大类,支持横向扩展,每一类资源由一类微服务进程来管理。
16+
1. **资源管理模块**: 在配置平台中我们把资源类型进行了抽象,提供原子接口服务,支持横向扩展,每一类资源由一类微服务进程来管理。
1717

1818

19-
2. **业务场景模块**: 业务场景模块是基于资源管理模块的原子接口对应用场景的封装,基于操作的相关度,目前划分出【admin、event、host、topo、process、datacollection】几个微服务,admin服务
20-
负责系统的配置刷新、初始化数据写入等操作;event服务负责系统的事件订阅与推送服务;process、topo、host分别负责系统进程、拓扑模型、主机数据的使用场景;
21-
datacollection 服务负责系统快照数据的接收与写入。
19+
2. **业务场景模块**: 业务场景模块是基于资源管理模块的原子接口对应用场景的封装,基于操作的相关度,目前划分出【admin、auth、cloud、datacollection、operation、host、process、synchronize、task、topo】几个微服务。
20+
- admin服务负责系统的配置刷新、初始化数据写入等操作;
21+
- event服务负责系统的事件订阅与推送服务;
22+
- process、topo、host、cloud分别负责系统进程、拓扑模型、主机、云数据的使用场景;
23+
- datacollection 服务负责系统快照数据的接收与写入;
24+
- operation 服务提供与运营统计相关功能;
25+
- synchronize 服务提供数据同步功能;
26+
- auth 服务提供权限相关功能;
27+
- task 服务提供异步任务管理。
2228

2329

2430
3. **接口层(api)**: 这一层是系统的api服务网关。

docs/overview/code_framework.md

+12-17
Original file line numberDiff line numberDiff line change
@@ -1,17 +1,15 @@
11
# 蓝鲸智云配置平台的代码结构
22

3-
![bk-cmdb.png](../resource/img/code2.jpg)
3+
![bk-cmdb.png](../resource/img/code.png)
44

55

66
## 1. web-server & ui
77

88
web-server是基于gin打造的web服务器, ui目录基于vue.js构建
99

10+
## 2. test & tools
1011

11-
12-
## 2. test case & example
13-
14-
此目录为系统服务的调用示例
12+
test 目录为系统服务的调用示例,tools 目录为客户端管理工具和辅助脚本工具
1513

1614

1715
## 3. api_server
@@ -22,24 +20,21 @@ api-server基于开源go-restful 框架构建
2220

2321
scene_server基于go-restful框架构建,以下为划分的微服务目录:
2422
* admin_server
25-
* event_server
23+
* auth_server
24+
* cloud_server
2625
* datacollection
26+
* event_server
2727
* host_server
28+
* operation_server
2829
* proc_server
30+
* synchronize_server
31+
* task_server
2932
* topo_server
30-
* validator
3133

3234

3335
## 5. source_controller
3436

35-
source_controller基于go-restful框架构建,以下为划分的微服务目录:
36-
37-
* hostcontroller
38-
* auditcontroller
39-
* objectcontroller
40-
* proccontroller
41-
42-
37+
source_controller基于go-restful框架构建,提供提供原子接口服务
4338

44-
## 6. common & storage
45-
common 目录为项目的公共依赖库,storage是项目对存储接入的封装
39+
## 6. common & storage &
40+
common 目录为项目的公共依赖库storage是项目对存储接入的封装,thirdpartyclient是项目对第三方客户端接入的封装

docs/resource/img/art_en.png

149 KB
Loading

docs/resource/img/code.jpg

-69 KB
Binary file not shown.

docs/resource/img/code.png

251 KB
Loading

docs/resource/img/code2.jpg

-63.7 KB
Binary file not shown.

0 commit comments

Comments
 (0)