Skip to content

Commit 18953c8

Browse files
Gygkimo95Gygkimo95
authored
3.2409 (#20)
* 更新回滚语句FAQ * 新增镜像地址FAQ * 回滚部分更新 * 更新docker镜像推荐 * 新增配置文件标记 * 更新数据源插件配置方法 * 工单支持上线到其他数据源 * 更新规则数量 * 新增CI/CD描述 * 更新审核SQL例外 * 新增黑名单 * 新增推送规则描述 * SQL管控中新增高优先级SQL筛选 * Update mirror.md * Update Docker.md * Update config.md * Update config.md * Update howtouse.md * Update blacklist-manager.md * Update blacklist-manager.md * Update push-rule.md * Update blacklist-manager.md * 规则模板导入导出支持csv格式 * 新增CB水印说明 * 新增版本控制 * Update version-management.md * Update how-to-use.md * Update how-to-use.md * Update how-to-use.md
1 parent e95189a commit 18953c8

File tree

5 files changed

+116
-33
lines changed

5 files changed

+116
-33
lines changed

‎docs/user-manual/project/rule-template-manager.md‎

Lines changed: 7 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -49,12 +49,13 @@ SQLE平台提供不同数据库类型的审核规则，是在长期实践中依
4949
### 后续步骤
5050
* 设置数据源的审核规则模板：用户可为不同数据源设置相同或者不同的审核规则模板，具体操作请参见[数据源管理](instance-manager.md)
5151
* 创建工单：工单中SQL的审核将依据该数据源配置的审核规则模板，请参见[工单说明](../project/workflow/intro.md)。
52-
* 创建智能扫描任务：智能扫描任务中SQL的审核将依据该数据源配置的审核规则模板，请参见[扫描任务说明](../project/audit_task/intro.md)。
52+
* SQL管控配置：SQL管控中采集的SQL将依据配置中应用的审核规则模板，请参见[SQL管控配置](../project/audit_task/intro.md)。
5353

5454
### 更多操作
55-
* 导入规则模板：可以导入其他项目中形成的规则模板文件
56-
* 编辑规则模板：编辑规则模板的基本信息及应用的规则
57-
* 删除规则模板：删除自行创建的规则模板
58-
* 限制：当已有数据源绑定了该规则模板，该规则模板不可被删除
55+
* 导入规则模板：可以导入其他项目中形成的规则模板文件，支持以csv、json格式导入规则模板内容。
56+
* 导出规则模板：导出当前选中的规则模板，以csv、json格式下载规则模板内容。
57+
* 编辑规则模板：编辑规则模板的基本信息及应用的规则。
58+
* 删除规则模板：删除自行创建的规则模板。
59+
* 限制：当已有数据源绑定了该规则模板，该规则模板不可被删除。
5960
* 克隆规则模板：克隆当前的模板，克隆的规则模版只会继承源模版所有启用的规则、以及变更过的规则等级和阈值。克隆出的新规则模版的模版名称等基本信息需要手动填写。
60-
* 导出规则模板：导出当前选中的规则模板，以json格式下载规则模板内容。
61+

‎docs/user-manual/project/workflow/img/verison-manage.png‎

112 KB
Loading

‎docs/user-manual/project/workflow/version-management.md‎

Lines changed: 81 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,81 @@
1+
---
2+
title: 版本控制
3+
---
4+
5+
SQLE的版本管理功能适用于以下场景：
6+
7+
1. 大规模数据库升级项目
8+
* 管理多个环境（如开发、测试、生产）的数据库变更
9+
* 跟踪复杂的脚本执行进度
10+
2. 日常数据库维护
11+
* 组织和追踪例行的数据库修改
12+
* 直观查看各阶段数据变更情况差异
13+
3. 协调团队的数据库开发
14+
* 避免冲突并确保变更的顺序执行
15+
4. 合规性和审计要求
16+
* 记录所有数据库变更的历史
17+
* 提供详细的变更日志以满足审计需求
18+
19+
20+
## 前置操作
21+
在开始使用版本控制功能之前，请确保：
22+
23+
* 已准备不同发布环境的数据源；
24+
* 已为团队成员分配数据源上的创建工单、审批工单权限；
25+
26+
## 步骤一 创建新版本
27+
28+
**目标**：建立一个新的版本记录，定义版本信息和涉及的环境。
29+
30+
* 进入"版本管理"页面，点击"添加版本"按钮
31+
* 填写版本信息：
32+
* 输入版本名称（如：v1_2_3）
33+
* 输入版本描述
34+
* 设置版本涉及的发布阶段：
35+
* 添加需要的环境（如：开发、测试、预生产、生产）
36+
* 添加每个环境中涉及的数据源
37+
* 点击"保存"按钮确认配置
38+
39+
:::tip
40+
版本名称建议使用有意义的标识，如功能名称加版本号，便于后续管理。
41+
:::
42+
43+
## 步骤二 将变更添加至版本中
44+
45+
**目标**：将具体的数据库变更关联到创建的版本中。
46+
47+
* 在版本详情页第一个阶段中，新增该版本中涉及的变更
48+
* 选择变更类型：
49+
* 新建工单：创建一个新的变更请求
50+
* 关联现有工单：将已存在的工单关联到此版本
51+
* 点击"确认"，添加变更到版本
52+
53+
:::tip
54+
* 仅能够关联这个阶段的数据源
55+
:::
56+
57+
58+
## 步骤三 跟踪版本进度
59+
60+
**目标**：监控变更的执行进度，确保按计划进行。
61+
62+
* 进入版本详情页面，查看当前版本涉及的阶段及每个阶段中的变更工单完成进度
63+
* 上线：一个阶段中的多个工单需按顺序执行上线
64+
* 当顺序中的工单具备上线条件时，工单操作人/项目管理员可以点击`上线`按钮，完成变更工单上线
65+
* 发布：同一工单需要顺序发布到不同环境进行验证
66+
* 当一个工单在当前阶段已完成上线验证，需要发布到下一个阶段时，工单操作人/项目管理员可以点击`发布`按钮，将当前变更内容发布到下一阶段数据源验证
67+
68+
:::tip
69+
* 上线：指在当前环境执行变更
70+
* 发布：指将已验证的变更推进到下一个环境
71+
:::
72+
73+
![verison-manage](img/verison-manage.png)
74+
75+
## 步骤四 完成版本发布
76+
77+
**目标**：确认所有变更已完成，并锁定版本。版本锁定后，将无法继续在版本中发布变更。
78+
79+
* 确保所有环境的所有变更都已执行完毕
80+
* 在版本列表点击`锁定`按钮，确认并锁定当前版本
81+

‎docs/user-manual/sql-workbench/how-to-use.md‎

Lines changed: 27 additions & 27 deletions
Original file line numberDiff line numberDiff line change
@@ -2,41 +2,41 @@
22
title: 使用定制包快速搭建环境
33
---
44

5-
SQLE在原有CloudBeaver release_23_2_1 分支的基础上, 增加了对OceanBase 和 TiDB 的支持, 用户无需再手动配置环境，可直接使用SQL工作台功能。
65

7-
![cb](img/appear.png)
6+
## 项目地址
87

9-
定制分支与原分支区别详情
10-
* 支持并默认启用 OceanBase 驱动
11-
* 支持并默认启用 TiDB 驱动
12-
* 默认访问路由调整为 /sql_query, 便于与SQLE集成
13-
* 默认会话超时时间调整为12小时(之前是30分钟)
14-
* 移除了默认创建的 PG 演示实例和 SQLite 演示实例
15-
* docker镜像名调整为 actiontech/sqle-cloudbeaver:23_2_1
16-
* 优化打包方式, 大幅提高打包效率
17-
* 默认主题改为暗色
8+
Release: https://github.com/actiontech/cloudbeaver/releases
189

19-
### 项目地址
20-
* 定制CloudBeaver分支: https://github.com/actiontech/cloudbeaver/tree/release_23_2_1_sqle
10+
## 使用说明
11+
### 方式一 使用定制包启动
2112

13+
以23-2-2版本为例：
2214

23-
### 定制包下载地址
24-
https://github.com/actiontech/cloudbeaver/releases/tag/v23.2.1
15+
#### 下载定制包
2516

26-
### 使用说明
27-
#### 编译和运行项目
28-
与 原项目编译运行方式 保持一致
17+
定制包下载地址https://github.com/actiontech/cloudbeaver/releases/tag/v23.2.2
2918

30-
#### 编译docker镜像
31-
进入项目的 deploy/docker 目录, 然后执行 ./make-docker-container.sh
19+
#### 安装与启动
3220

33-
#### 运行docker镜像
34-
* 方式一: 进入项目的 deploy/docker 目录, 然后执行 ./run-docker-container.sh
35-
* 方式二: 手动启动镜像, 镜像参数和 原项目镜像参数 保持一致
21+
```bash
22+
unzip cloudbeaver-23-2-2-sqlev3.zip
23+
cd cloudbeaver
24+
./run-server.sh
25+
```
3626

37-
#### 已有CloudBeaver环境升级为定制环境
38-
CloudBeaver程序目录下应当有以下几个文件
27+
### 方式二 使用定制Docker镜像启动（推荐）
3928

40-
![cb](img/cb.png)
29+
```bash
30+
docker run -d --restart unless-stopped --name cloudbeaver --privileged -it -p 8978:8978 actiontech/cloudbeaver:latest
31+
```
32+
33+
34+
## 升级现有CloudBeaver环境至定制环境
35+
36+
确保CloudBeaver程序目录下包含以下文件：
37+
38+
- `conf`目录
39+
- `workspace`目录
40+
41+
将现有CloudBeaver程序目录下的`conf`和`workspace`目录移动到定制CloudBeaver程序目录下（覆盖原目录）。随后停止旧CloudBeaver，运行新的CloudBeaver即可。
4142

42-
将CloudBeaver程序目录下的conf目录和workspace目录移动到定制CloudBeaver程序目录下(覆盖原目录), 随后停止旧CloudBeaver, 运行新CloudBeaver即可

‎sidebars.js‎

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -78,6 +78,7 @@ const sidebars = {
7878
"user-manual/project/workflow/create-workflow",
7979
"user-manual/project/workflow/audit-workflow",
8080
"user-manual/project/workflow/exec-workflow",
81+
"user-manual/project/workflow/version-management",
8182
],
8283
},
8384
"user-manual/project/CICDintegration",

0 commit comments

Comments
 (0)