Skip to content

Commit 90350a4

Browse files
bd-xiaowangbd-xiaowang
committed
新增CMDB数据库表结构文档
1 parent 759fa78 commit 90350a4

19 files changed

+1692
-0
lines changed

‎docs/db/README.md

+26
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,26 @@
1+
# 数据库表结构设计
2+
3+
*说明：蓝鲸配置平台（蓝鲸CMDB）项目底层使用MongoDB进行数据存储，MongoDB是一个面向文档的数据库，因此它没有传统的表结构，而是使用集合（Collection）和文档（Document）来组织数据，本目录下文档中涉及的表结构和字段解释仅供参考，请以实际环境中的结构为准。*
4+
5+
## 表结构文档分类及作用
6+
7+
| 作用 | 分类文档 |
8+
|----------------|---------------------------------------------------|
9+
| 内置模型相关表 | [built-in_model](built-in_model.md) |
10+
| 业务下相关资源表 | [business](business.md) |
11+
| 云资源相关功能表 | [cloud_resource](cloud_resource.md) |
12+
| 容器数据纳管功能相关表 | [container_data_manage](container_data_manage.md) |
13+
| 字段组合模板功能相关表 | [field_template](field_template.md) |
14+
| 主机属性自动应用功能相关表 | [host_apply_rule](host_apply_rule.md) |
15+
| 实例相关表 | [instance](instance.md) |
16+
| 主线模型相关表 | [mainline_model](mainline_model.md) |
17+
| 模型相关表 | [model](model.md) |
18+
| 运营分析功能相关表 | [operational_analysis](operational_analysis.md) |
19+
| 管控区域相关表 | [plat](plat.md) |
20+
| 服务模板功能相关表 | [service_template](service_template.md) |
21+
| 集群模板功能相关表 | [set_template](set_template.md) |
22+
| 异步任务相关表 | [task](task.md) |
23+
| 资源目录用户自定义配置相关表 | [user_custom](user_custom.md) |
24+
| 资源变更事件相关表 | [watch](watch.md) |
25+
| 不归属任何一种分类的表 | [other](other.md) |
26+

‎docs/db/built-in_model.md

+127
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,127 @@
1+
# 内置模型相关表
2+
3+
## cc_BizSetBase
4+
5+
#### 作用
6+
7+
存放业务集信息
8+
9+
#### 表结构
10+
11+
| 字段 | 类型 | 描述 |
12+
|---------------------|------------|--------------------|
13+
| _id | ObjectId | 数据唯一ID |
14+
| bk_biz_set_id | NumberLong | 业务集id |
15+
| bk_biz_set_name | String | 业务集名称 |
16+
| bk_biz_set_desc | String | 业务集描述 |
17+
| bk_biz_maintainer | String | 维护者 |
18+
| bk_scope | Object | 业务集范围 |
19+
| default | NumberLong | 是否是默认业务集，1代表是，0代表否 |
20+
| bk_supplier_account | String | 开发商ID |
21+
| create_time | ISODate | 创建时间 |
22+
| last_time | ISODate | 最后更新时间 |
23+
24+
**注意**：此处仅对业务集内置的模型字段做说明，业务集表结构字段取决于用户在业务集模型中定义的属性字段
25+
26+
#### bk_scope 字段结构示例
27+
28+
| 字段 | 类型 | 描述 |
29+
|-----------|---------|------------|
30+
| match_all | Boolean | 是否包含所有业务 |
31+
| filter | Object | 所包含业务的条件规则 |
32+
33+
#### bk_scope.filter 字段结构示例
34+
35+
| 字段 | 类型 | 描述 |
36+
|-----------|--------|-----------|
37+
| condition | String | 规则操作符 |
38+
| rules | Array | 过滤节点的范围规则 |
39+
40+
#### bk_scope.filter.rules 字段结构示例
41+
42+
过滤规则为三元组 `field`, `operator`, `value`
43+
44+
| 字段 | 类型 | 描述 |
45+
|----------|--------|-----------------------------|
46+
| field | string | 字段名 |
47+
| operator | string | 操作符 |
48+
| value | - | 操作数,不同的operator对应不同的value格式 |
49+
50+
## cc_HostBase
51+
52+
#### 作用
53+
54+
主机信息表
55+
56+
#### 表结构
57+
58+
| 字段 | 类型 | 描述 |
59+
|--------------------------|--------------|--------------|
60+
| _id | ObjectId | 数据唯一ID |
61+
| bk_os_name | String | 操作系统名称 |
62+
| bk_addressing | String | 寻址方式 |
63+
| import_from | String | 录入方式 |
64+
| bk_sla | String | SLA级别 |
65+
| bk_cpu_module | String | CPU型号 |
66+
| bk_host_innerip_v6 | String Array | 内网IPv6 |
67+
| bk_agent_id | String | GSE Agent ID |
68+
| bk_cloud_host_identifier | Boolean | 云主机标识 |
69+
| bk_os_bit | String | 操作系统位数 |
70+
| bk_sn | String | 设备SN |
71+
| bk_host_outerip | String Array | 外网IP |
72+
| bk_service_term | NumberLong | 质保年限 |
73+
| bk_state_name | String | 所在国家 |
74+
| bk_mac | String | 内网MAC地址 |
75+
| bk_cloud_inst_id | String | 云主机实例ID |
76+
| bk_cpu_architecture | String | CPU架构 |
77+
| bk_os_version | String | 操作系统版本 |
78+
| operator | String Array | 主要维护人 |
79+
| bk_os_type | String | 操作系统类型 |
80+
| bk_host_id | NumberLong | 主机id |
81+
| bk_cloud_id | NumberLong | 管控区域id |
82+
| bk_comment | String | 备注 |
83+
| bk_cloud_host_status | NumberLong | 云主机状态 |
84+
| bk_bak_operator | String Array | 备份维护人 |
85+
| bk_province_name | NumberLong | 所在省份 |
86+
| bk_isp_name | String | 所属运营商 |
87+
| bk_disk | NumberLong | 磁盘容量(GB) |
88+
| bk_outer_mac | String | 外网MAC |
89+
| bk_state | String | 当前状态 |
90+
| bk_host_outerip_v6 | String Array | 外网IPv6 |
91+
| bk_host_name | String | 主机名称 |
92+
| bk_asset_id | String | 固资编号 |
93+
| bk_cloud_vendor | String | 云厂商 |
94+
| bk_host_innerip | String Array | 内网IP |
95+
| bk_cpu | NumberLong | CPU逻辑核心数 |
96+
| bk_mem | NumberLong | 内存容量(MB) |
97+
| bk_supplier_account | String | 开发商ID |
98+
| create_time | ISODate | 创建时间 |
99+
| last_time | ISODate | 最后更新时间 |
100+
101+
**注意**：此处仅对主机内置的模型字段做说明，主机表结构字段取决于用户在主机模型中定义的属性字段
102+
103+
## cc_ProjectBase
104+
105+
#### 作用
106+
107+
项目表
108+
109+
#### 表结构
110+
111+
| 字段 | 类型 | 描述 |
112+
|---------------------|------------|--------|
113+
| _id | ObjectId | 数据唯一ID |
114+
| id | NumberLong | 自增ID |
115+
| bk_project_id | String | 项目ID |
116+
| bk_project_code | String | 项目英文名 |
117+
| bk_project_type | String | 项目类型 |
118+
| bk_project_owner | String | 项目负责人 |
119+
| bk_project_name | String | 项目名称 |
120+
| bk_project_desc | String | 项目描述 |
121+
| bk_project_sec_lvl | String | 保密级别 |
122+
| bk_status | String | 项目状态 |
123+
| bk_supplier_account | String | 开发商ID |
124+
| create_time | ISODate | 创建时间 |
125+
| last_time | ISODate | 最后更新时间 |
126+
127+
**注意**：此处仅对项目内置的模型字段做说明，项目表结构字段取决于用户在项目模型中定义的属性字段

‎docs/db/business.md

+137
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,137 @@
1+
# 业务下相关资源表
2+
3+
## cc_ServiceCategory
4+
5+
#### 作用
6+
7+
服务分类信息表
8+
9+
#### 表结构
10+
11+
| 字段 | 类型 | 描述 |
12+
|---------------------|------------|---------|
13+
| _id | ObjectId | 数据唯一ID |
14+
| id | NumberLong | 分类id |
15+
| name | String | 分类名称 |
16+
| bk_root_id | NumberLong | 根节点id |
17+
| bk_parent_id | NumberLong | 父节点id |
18+
| is_built_in | Boolean | 是否为系统内置 |
19+
| bk_biz_id | NumberLong | 业务id |
20+
| bk_supplier_account | String | 开发商ID |
21+
22+
## cc_HostFavourite
23+
24+
#### 作用
25+
26+
存放收藏主机搜索条件信息
27+
28+
#### 表结构
29+
30+
| 字段 | 类型 | 描述 |
31+
|---------------------|------------|--------|
32+
| _id | ObjectId | 数据唯一ID |
33+
| bk_biz_id | NumberLong | 业务id |
34+
| id | NumberLong | 自增id |
35+
| info | String | ip查询条件 |
36+
| name | String | 收藏的名称 |
37+
| count | NumberLong | 数量 |
38+
| user | String | 创建者 |
39+
| type | String | 收藏类型 |
40+
| query_params | String | 通用查询条件 |
41+
| bk_supplier_account | String | 开发商ID |
42+
| create_time | ISODate | 创建时间 |
43+
| last_time | ISODate | 最后更新时间 |
44+
45+
## cc_ServiceInstance
46+
47+
#### 作用
48+
49+
服务实例信息表
50+
51+
#### 表结构
52+
53+
| 字段 | 类型 | 描述 |
54+
|---------------------|------------|--------|
55+
| _id | ObjectId | 数据唯一ID |
56+
| id | NumberLong | 自增id |
57+
| bk_biz_id | NumberLong | 业务id |
58+
| name | String | 服务实例名 |
59+
| labels | Object | 标签 |
60+
| service_template_id | NumberLong | 服务模板id |
61+
| bk_host_id | NumberLong | 主机id |
62+
| bk_module_id | NumberLong | 模块id |
63+
| creator | String | 创建人 |
64+
| modifier | String | 更新人 |
65+
| bk_supplier_account | String | 开发商ID |
66+
| create_time | ISODate | 创建时间 |
67+
| last_time | ISODate | 最后更新时间 |
68+
69+
#### labels 字段结构示例
70+
71+
| 字段 | 类型 | 描述 |
72+
|-----|--------|-------------------------|
73+
| env | String | 标签名称，由用户自定义，此处 env 仅为例子 |
74+
75+
## cc_Process
76+
77+
#### 作用
78+
79+
进程实例信息表
80+
81+
#### 表结构
82+
83+
| 字段 | 类型 | 描述 |
84+
|----------------------|------------|----------|
85+
| _id | ObjectId | 数据唯一ID |
86+
| service_instance_id | NumberLong | 服务实例id |
87+
| start_cmd | String | 启动命令 |
88+
| user | String | 启动用户 |
89+
| bk_start_param_regex | String | 启动参数匹配规则 |
90+
| restart_cmd | String | 重启命令 |
91+
| face_stop_cmd | String | 强制停止命令 |
92+
| work_path | String | 工作路径 |
93+
| description | String | 备注 |
94+
| priority | NumberLong | 启动优先级 |
95+
| bk_process_name | String | 进程别名 |
96+
| bk_start_check_secs | NumberLong | 启动等待时长 |
97+
| bk_func_name | String | 进程名称 |
98+
| reload_cmd | String | 进程重载命令 |
99+
| pid_file | String | PID文件路径 |
100+
| auto_start | Boolean | 是否自动拉起 |
101+
| bk_biz_id | NumberLong | 业务ID |
102+
| proc_num | NumberLong | 启动数量 |
103+
| stop_cmd | String | 停止命令 |
104+
| bk_process_id | NumberLong | 进程id |
105+
| timeout | NumberLong | 操作超时时长 |
106+
| bind_info | Array | 绑定信息 |
107+
| bk_supplier_account | String | 开发商ID |
108+
| create_time | ISODate | 创建时间 |
109+
| last_time | ISODate | 最后更新时间 |
110+
111+
#### bind_info 字段结构示例
112+
113+
| 字段 | 类型 | 描述 |
114+
|-----------------|------------|------------|
115+
| enable | Boolean | 是否启用 |
116+
| template_row_id | NumberLong | 在进程模板中的行id |
117+
| ip | String | 绑定ip |
118+
| port | String | 绑定端口 |
119+
| protocol | String | 通信方式 |
120+
121+
## cc_ProcessInstanceRelation
122+
123+
#### 作用
124+
125+
存放进程实例关联关系信息
126+
127+
#### 表结构
128+
129+
| 字段 | 类型 | 描述 |
130+
|---------------------|------------|--------|
131+
| _id | ObjectId | 数据唯一ID |
132+
| bk_biz_id | NumberLong | 业务id |
133+
| bk_process_id | NumberLong | 进程id |
134+
| service_instance_id | NumberLong | 服务实例id |
135+
| process_template_id | NumberLong | 进程模板id |
136+
| bk_host_id | NumberLong | 主机id |
137+
| bk_supplier_account | String | 开发商ID |

0 commit comments

Comments
 (0)