Skip to content

Commit e95189a

Browse files
authored
3.2408 (#19)
* 更新回滚语句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
1 parent 2ac2e9f commit e95189a

23 files changed

+232
-159
lines changed

docs/FAQ/img/mirrorrepo.jpeg

19.8 KB
Loading

docs/FAQ/mirror.md

Lines changed: 14 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,14 @@
1+
---
2+
title: 镜像仓库推荐
3+
---
4+
# 镜像仓库推荐
5+
6+
:::tip
7+
由于网络原因,推荐配置国内镜像源后,拉取SQLE
8+
:::
9+
10+
镜像源地址:https://docker.rainbond.cc
11+
12+
配置参考
13+
14+
![mirror](img/mirrorrepo.jpeg)

docs/FAQ/rollback.md

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,6 @@
1+
---
2+
title: SQL回滚支持程度
3+
---
4+
# 支持回滚的SQL语句类型
5+
6+
参考 https://github.com/actiontech/sqle/discussions/391

docs/deploy-manual/Docker.md

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -6,6 +6,10 @@ title: Docker部署
66
## Docker hub 地址
77
[actiontech/sqle-ce](https://hub.docker.com/r/actiontech/sqle-ce)
88

9+
:::tip
10+
推荐配置国内镜像源,参考[镜像推荐](/docs/FAQ/mirror.md)
11+
:::
12+
913
## Docker 参考命令
1014
```sh
1115
docker run -d -it \

docs/deploy-manual/config.md

Lines changed: 13 additions & 13 deletions
Original file line numberDiff line numberDiff line change
@@ -3,11 +3,11 @@ title: 配置文件说明
33
---
44
# 配置文件说明
55
:::tip
6-
SQLE的配置文件采用yml的格式,默认情况下位于SQLE安装目录下,路径为`./etc/config.yaml`
6+
SQLE的配置文件采用yaml的格式,默认情况下位于SQLE安装目录下,路径为`./etc/config.yaml`
77
:::
88

99
## 默认文件参考
10-
```yml
10+
```yaml
1111
dms:
1212
id: 1
1313
api:
@@ -19,11 +19,11 @@ dms:
1919
secret_key: 'xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx'
2020
service:
2121
database:
22-
host: "127.0.0.1"
23-
port: 3306
24-
username: "root"
25-
password: "123456"
26-
database: "dms"
22+
host: "127.0.0.1" # 请修改为实际监听的IP
23+
port: 3306 # 请修改为实际监听的端口
24+
username: "root" # 请修改为实际连接信息
25+
password: "123456" # 请修改为实际连接信息
26+
database: "dms"
2727
debug: true
2828
auto_migrate: true
2929
log:
@@ -33,7 +33,7 @@ dms:
3333
max_backup_number: 10
3434
cloudbeaver:
3535
enable_https: false
36-
host: "127.0.0.1"
36+
host: "127.0.0.1"
3737
port: 8978
3838
admin_user: "cbadmin"
3939
admin_password: "123456"
@@ -72,10 +72,10 @@ sqle:
7272
log_max_backup_number: 2
7373
plugin_path: './plugins'
7474
database:
75-
mysql_host: '127.0.0.1'
76-
mysql_port: 3306
77-
mysql_user: 'root'
78-
mysql_password: '123456'
75+
mysql_host: '127.0.0.1' # 请修改为实际监听的IP
76+
mysql_port: 3306 # 请修改为实际监听的端口
77+
mysql_user: 'root' # 请修改为实际连接信息
78+
mysql_password: '123456' # 请修改为实际连接信息
7979
mysql_schema: 'sqle'
8080
```
8181
## 配置说明
@@ -160,4 +160,4 @@ SQL工作台的配置,配置则代表开启SQL工作台。
160160
|mysql_password|SQLE存储库的数据库密码|
161161
|mysql_schema|SQLE存储库的数据库 schema|
162162
163-
数据库插件配置请参考:[如何配置数据库审核插件](../dev-manual/plugins/howtouse.md)
163+
数据库插件配置请参考:[如何配置数据库审核插件](../dev-manual/plugins/howtouse.md)

docs/dev-manual/plugins/howtouse.md

Lines changed: 34 additions & 113 deletions
Original file line numberDiff line numberDiff line change
@@ -3,84 +3,42 @@ title: 数据库审核插件使用
33
---
44

55
## 配置插件
6-
### 创建插件二进制目录
6+
### 选择需要启用的数据源类型
7+
8+
1. 进入SQLE目录下的scripts目录,执行插件配置脚本;
9+
2. 输入需要使用的数据源插件序号;
10+
3. 随后,脚本将结合选定的数据源插件序号,自动执行以下行为:
11+
1. 校验当前环境信息是否满足插件运行条件,如java环境校验、donet环境校验;
12+
2. 环境校验成功后,修改插件执行权限,并将未启用的插件移除当前目录;
13+
3. 修改config.yaml文件;
14+
4. 配置完成后,脚本将启动SQLE服务;
15+
16+
### 完整操作流程参考
17+
18+
执行脚本运行命令并选择数据源插件序号 ./init_config.sh
19+
![scripts](img/scriptsexec.png)
20+
脚本自动执行环境校验
21+
![check](img/environmentcheck.png)
22+
脚本自动修改相关配置并启动SQLE
23+
![config](img/editconfig.png)
24+
25+
26+
27+
28+
## 新增插件
29+
30+
1. 进入SQLE目录下的scripts目录,执行插件配置脚本;
31+
2. 输入需要使用的数据源插件序号(注:已启用的数据源插件需要也需要填写);
32+
3. 后续操作与[配置插件](#配置插件)一致;
33+
34+
35+
## 删除插件
36+
37+
1. 进入SQLE目录下的scripts目录,执行插件配置脚本;
38+
2. 输入需要使用的数据源插件序号,不再填写需要删除的数据源插件序号;
39+
3. 后续操作与[配置插件](#配置插件)一致;
740

8-
通常创建在 SQLE 的工作目录
941

10-
```jsx title="插件目录"
11-
bash-4.2$ ls -l
12-
drwxr-x--- 2 actiontech-universe actiontech 46 128 03:19 bin
13-
-rw-r----- 1 actiontech-universe actiontech 5 1225 02:48 dms.pid
14-
drwxrwx--- 2 actiontech-universe actiontech 43 1222 07:57 etc
15-
drwxr-x--- 2 actiontech-universe actiontech 53 128 03:25 logs
16-
drwxr-x--- 2 actiontech-universe actiontech 33 1225 02:43 plugins
17-
drwxr-x--- 2 actiontech-universe actiontech 126 128 03:19 scripts
18-
-rw-r--r-- 1 actiontech-universe actiontech 4 1225 05:43 sqled.pid
19-
drwxr-x--- 4 actiontech-universe actiontech 112 128 03:19 static
20-
-rw-r--r-- 1 actiontech-universe actiontech 180270 1225 05:52 std.log
21-
```
22-
### 修改配置文件config.yaml
23-
:::tip
24-
注意:dms组件中,需要在database_driver_options部分配置数据库logo存储路径、变量信息,详细配置信息请参考[配置文件说明](/docs/deploy-manual/config.md)
25-
:::
26-
```jsx title="config.yaml "
27-
dms:
28-
id: 1
29-
api:
30-
addr: 0.0.0.0
31-
port: 7601
32-
service:
33-
database:
34-
username: root
35-
password:
36-
host: 127.0.0.1
37-
port: 3306
38-
database: dms
39-
debug: true
40-
log:
41-
level: DEBUG
42-
path: logs
43-
max_size_mb: 100
44-
max_backup_number: 10
45-
cloudbeaver:
46-
enable_https: false
47-
host: 172.41.134.5
48-
port: 8978
49-
admin_user: administrator
50-
admin_password: 123456
51-
secret_key:
52-
database_driver_options: ## 需要配置数据库logo存储路径、变量信息
53-
- db_type: MySQL
54-
logo_path: "/logo/mysql.png"
55-
params:
56-
- db_type: PostgreSQL
57-
logo_path: "/logo/postgres_sql.png"
58-
params:
59-
sqle:
60-
id: 1
61-
dms_server_address: http://127.0.0.1:7601
62-
api:
63-
addr: 127.0.0.1
64-
port: 10000
65-
enable_https: false
66-
cert_file_path: './etc/cert.pem'
67-
key_file_path: './etc/key.pem'
68-
secret_key:
69-
service:
70-
auto_migrate_table: true
71-
debug_log: false
72-
log_path: './logs'
73-
log_max_size_mb: 1024
74-
log_max_backup_number: 2
75-
plugin_path: './plugins' ## 插件所在路径,也可以填写绝对路径
76-
enable_cluster_mode:
77-
database:
78-
mysql_host: '127.0.0.1'
79-
mysql_port: '3306'
80-
mysql_user: 'root'
81-
mysql_password: ''
82-
mysql_schema: 'sqle'
83-
```
8442

8543
:::tip
8644
1. 针对Oracle和DB2类型的数据源,须先在SQLE环境中安装JDK
@@ -93,40 +51,3 @@ yum install java-1.8.0-openjdk* -y
9351
* yum install -y dotnet-runtime-6.0
9452
* yum install -y aspnetcore-runtime-6.0
9553
:::
96-
97-
## 集成插件
98-
将插件的二进制文件放在[配置插件](#配置插件)中创建的 plugins/目录内,其中插件可以由第三方提供或者自行编译,参考:[sqle-pg-plugin](https://github.com/actiontech/sqle-pg-plugin)
99-
100-
ps:在重启 SQLE 前,需要确保 SQLE 的运行用户拥有对二进制文件的执行权限,如果没有,可以通过以下命令来设置:
101-
```
102-
chmod +x /opt/sqle/plugins/sqle-pg-plugin
103-
```
104-
105-
## 重启服务
106-
```jsx title="rpm方式安装"
107-
systemctl restart sqled
108-
systemctl restart dms
109-
110-
```
111-
```jsx title="docker方式安装"
112-
docker restart containername
113-
```
114-
115-
## 确认插件生效
116-
117-
### 方式一:通过日志
118-
重启后,若成功加载插件,日志中会打印当前加载的审核插件:
119-
```
120-
time="2021-10-12T14:06:42+08:00" level=info msg="starting sqled server"
121-
time="2021-10-12T14:06:42+08:00" level=info msg="plugin inited" plugin_name=PostgreSQL
122-
...
123-
time="2021-10-12T14:06:43+08:00" level=info msg="starting http server on :10000"
124-
```
125-
126-
### 方式二:通过页面
127-
验证是否已加载插件规则:查看 SQLE 规则页面,PostgreSQL 插件支持的审核规则已经加载到 SQLE Server:
128-
![pluginrules](img/pluginrules.png)
129-
验证能否添加插件类型的数据源:添加数据源,显示已经可以添加 PostgreSQL 类型的数据源。
130-
![plugintype](img/plugintype.png)
131-
132-
797 KB
Loading
1.23 MB
Loading
-155 KB
Binary file not shown.
865 KB
Loading

0 commit comments

Comments
 (0)