Skip to content

Commit a32ec45

Browse files
authored
4.2505 (#29)
* 新增可用区 * 用户角色更新 * tdsql支持慢日志 * 插件配置方式更新 * Update howtouse.md * Update zone.md * Update zone.md
1 parent f3b79a7 commit a32ec45

File tree

6 files changed

+102
-57
lines changed

6 files changed

+102
-57
lines changed

docs/dev-manual/plugins/howtouse.md

Lines changed: 10 additions & 44 deletions
Original file line numberDiff line numberDiff line change
@@ -2,52 +2,18 @@
22
title: 数据库审核插件使用
33
---
44

5-
## 配置插件
6-
### 选择需要启用的数据源类型
5+
# 数据库审核插件使用说明
76

8-
1. 进入SQLE目录下的scripts目录,执行插件配置脚本;
9-
2. 输入需要使用的数据源插件序号;
10-
3. 随后,脚本将结合选定的数据源插件序号,自动执行以下行为:
11-
1. 校验当前环境信息是否满足插件运行条件,如java环境校验、donet环境校验;
12-
2. 环境校验成功后,修改插件执行权限,并将未启用的插件移除当前目录;
13-
3. 修改config.yaml文件;
14-
4. 配置完成后,脚本将启动SQLE服务;
7+
## 概述
8+
SQLE 提供了丰富的数据库审核插件,用于支持不同类型数据库的 SQL 审核功能。这些插件已经默认集成在专业版的部署包中。
159

16-
### 完整操作流程参考
10+
## 支持的数据库类型
11+
请参考 [支持的数据源类型](/docs/support/compare.md)
1712

18-
执行脚本运行命令并选择数据源插件序号 ./init_config.sh
19-
![scripts](img/scriptsexec.png)
20-
脚本自动执行环境校验
21-
![check](img/environmentcheck.png)
22-
脚本自动修改相关配置并启动SQLE
23-
![config](img/editconfig.png)
13+
## 插件使用方式
2414

15+
### 1. 默认插件
16+
当前数据源插件已默认集成在 SQLE 中,无需配置,开箱即用。在添加数据源时,只需选择对应的数据库类型即可。
2517

26-
27-
28-
## 新增插件
29-
30-
1. 进入SQLE目录下的scripts目录,执行插件配置脚本;
31-
2. 输入需要使用的数据源插件序号(注:已启用的数据源插件需要也需要填写);
32-
3. 后续操作与[配置插件](#配置插件)一致;
33-
34-
35-
## 删除插件
36-
37-
1. 进入SQLE目录下的scripts目录,执行插件配置脚本;
38-
2. 输入需要使用的数据源插件序号,不再填写需要删除的数据源插件序号;
39-
3. 后续操作与[配置插件](#配置插件)一致;
40-
41-
42-
43-
:::tip
44-
1. 针对Oracle和DB2类型的数据源,须先在SQLE环境中安装JDK
45-
yum install java-1.8.0-openjdk* -y
46-
1. 针对Sql Server类型的数据源,需要安装 .net 6.0 版本
47-
* ubuntu
48-
* apt-get install -y dotnet-sdk-6.0
49-
* centos
50-
* rpm -Uvh https://packages.microsoft.com/config/rhel/7/packages-microsoft-prod.rpm
51-
* yum install -y dotnet-runtime-6.0
52-
* yum install -y aspnetcore-runtime-6.0
53-
:::
18+
### 2. 自定义插件
19+
如果需要使用自定义的审核插件,请参考[数据库审核插件开发](./howtodev.md)

docs/user-manual/project/audit_task/slowlog_audit.md

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -9,6 +9,7 @@ title: 慢日志
99

1010
## 支持的数据源类型
1111
* MySQL
12+
* TDSQL
1213

1314
## 方式一:采集慢日志表
1415
### 前置条件
81.5 KB
Loading
Lines changed: 60 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,60 @@
1+
# 可用区管理
2+
3+
## 功能概述
4+
5+
### 功能用途
6+
可用区功能让您能够在一个平台上集中管理分布在不同网络区域的数据库资源。
7+
8+
### 应用场景
9+
- 数据库分散在不同地区机房(如北京、上海、广州),需要统一管理
10+
- 企业网络安全策略严格,跨区域访问数据库受限
11+
- 需要同时兼顾运维效率和安全合规要求
12+
13+
### 主要特点
14+
- 统一管理界面:单一平台操作所有区域数据库
15+
- 安全隔离:保持各区域网络隔离,严格的数据访问权限控制
16+
17+
### 预期效果
18+
- 提升运维效率:无需在多个系统间切换
19+
- 确保安全合规:符合国家网络安全基线
20+
- 简化数据管理:备份和审计工作更轻松
21+
22+
## 前置条件
23+
24+
### 使用权限要求
25+
- 管理员权限:创建和配置可用区
26+
- 普通用户权限:按分配权限访问指定可用区
27+
28+
### 依赖条件
29+
- 各网络区域之间需要基本的网络连通性
30+
- 中心区需要有足够的存储空间用于数据同步
31+
32+
## 操作指南
33+
34+
### 功能入口
35+
项目管理 -> 可用区管理
36+
37+
### 操作步骤
38+
1. 管理员操作:
39+
- 创建网络可用区(如:Zone-北京、Zone-上海)
40+
- 配置可用区参数
41+
42+
2. 普通用户操作:
43+
- 登录系统
44+
- 选择已授权的可用区
45+
- 进行数据库管理操作
46+
47+
48+
![zone](img/zone.png)
49+
50+
## 使用规则
51+
52+
### 注意事项
53+
- 确保网络区域间的连接稳定
54+
- 定期检查数据同步状态
55+
- 遵守数据安全访问规范
56+
57+
### 使用建议
58+
- 建议按照地理位置或业务划分可用区
59+
- 定期检查和更新权限配置
60+
- 保持合理的数据同步策略

docs/user-manual/user-manager/user.md

Lines changed: 30 additions & 13 deletions
Original file line numberDiff line numberDiff line change
@@ -2,23 +2,40 @@
22
title: 用户管理
33
---
44

5-
# 用户管理
5+
# 用户管理
66
当需要创建新的用户,或需要由管理员修改用户基本信息时,可以进行用户管理的相关操作。
77

8-
### 操作步骤
9-
* 点击顶部导航栏`更多`按钮,点击平台管理栏目下的`用户中心`选项,查看用户管理标签。
10-
* 点击列表右上角`创建用户`按钮,填写用户相关信息:
11-
* 用户名
12-
* 密码
13-
* 确认密码
14-
* 邮箱:若开启邮件推送或飞书推送服务,则将会以邮件形式通知对应用户工单的流转状态
15-
* 微信ID:若开启企业微信推送服务,则将通过企业微信通知对应用户工单的流转状态
16-
* 平台管理权限:当前可选项为创建项目,若选择该权限,则该用户将具有创建项目的权限
178

18-
* 点击提交,完成用户创建
199

20-
### 执行结果
21-
创建成功后,可在用户列表中查看已创建的用户信息
10+
11+
## 操作指南
12+
13+
### 功能入口
14+
- 在菜单栏右下角,点击配置按钮。
15+
- 在展开的菜单中,点击 用户中心 即可进入用户列表页面。
16+
17+
### 创建新用户操作步骤:
18+
19+
- 在“用户列表”页面的右上角,点击 创建用户 按钮。
20+
- 系统将弹出“创建用户”表单,请依次填写以下信息:
21+
- 填写完毕后,点击 提交 按钮。
22+
23+
#### 参数说明:
24+
25+
- 用户名:用户的登录标识,创建后不可修改。建议使用统一规范(如:工号、姓名拼音)。
26+
- 密码/确认密码:设置用户的初始登录密码,需要输入两次以确认一致。
27+
- 邮箱:用户的电子邮箱。如果开启了邮件推送服务,系统将通过此邮箱发送工单状态等通知。
28+
- 微信ID:用户的企业微信ID。如果开启了企业微信推送服务,系统将通过此ID推送通知。
29+
- 平台角色:为用户分配系统级别的角色,决定其基础权限。
30+
- 系统管理员:拥有系统最高权限,可管理所有功能模块。
31+
- 审计管理员:负责审计系统操作日志等。
32+
- 项目总监:通常负责管理多个项目。
33+
- 普通用户:拥有最基础的访问权限,具体操作权限由其所在项目决定。
34+
35+
### 操作结果展示:
36+
- 创建成功后,系统会自动返回用户列表。
37+
- 您可以在列表中看到刚刚创建的用户信息。
38+
2239

2340
![userlist](img/userlist.png)
2441

sidebars.js

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -130,6 +130,7 @@ const sidebars = {
130130
"user-manual/sys-configuration/MFA",
131131
"user-manual/sys-configuration/configuration",
132132
"user-manual/sys-configuration/customize",
133+
"user-manual/sys-configuration/zone",
133134
],
134135
},
135136
{

0 commit comments

Comments
 (0)