新增v3版本，添加v3版本部署文档

actiontech · Oct 23, 2023 · a593c35 · a593c35
1 parent 87ddffa
commit a593c35
Show file tree

Hide file tree

Showing 180 changed files with 5,372 additions and 856 deletions.
diff --git a/docs/deploy-manual/config.md b/docs/deploy-manual/config.md
@@ -3,46 +3,124 @@ title: 配置文件说明
 ---
 # 配置文件说明
 :::tip
-SQLE的配置文件采用yml的格式，默认情况下位于SQLE安装目录下，路径为`./etc/sqled.yml`
+SQLE的配置文件采用yml的格式，默认情况下位于SQLE安装目录下，路径为`./etc/config.yml`
 :::
 ## 默认文件参考
 ```yml
-server:
- sqle_config:
-  server_port: 10000
-  enable_https: false
-  cert_file_path: './etc/cert.pem'
-  key_file_path: './etc/key.pem'
-  auto_migrate_table: true
-  debug_log: false
-  log_path: './logs'
-  log_max_size_mb: 1024
-  log_max_backup_number: 2
-  secret_key: 'xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx' #从 v1.2203.0 版本引入
- db_config:
-  mysql_cnf:
-   mysql_host: '127.0.0.1'
-   mysql_port: 3306
-   mysql_user: 'root'
-   mysql_password: '123456'
-   mysql_schema: 'sqle'
+dms:
+  id: 1
+  api:
+    addr: "0.0.0.0"
+    port: 10000
+    enable_https: false
+    cert_file_path: './etc/cert.pem'
+    key_file_path: './etc/key.pem'
+  secret_key: 'xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx'
+  service:
+    database:
+      host: "127.0.0.1"
+      port: 3306
+      username: "root"
+      password: "123456"
+      database: "dms"
+      debug: true
+  cloudbeaver:
+    enable_https: false
+    host: "127.0.0.1"
+    port: 8978
+    admin_user: "cbadmin"
+    admin_password: "123456"
+
+sqle:
+  id: 1
+  dms_server_address: "http://127.0.0.1:10000"
+  api:
+    addr: "127.0.0.1"
+    port: 10001
+    enable_https: false
+    cert_file_path: './etc/cert.pem'
+    key_file_path: './etc/key.pem'
+  secret_key: 'xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx'
+  service:
+    auto_migrate_table: true
+    debug_log: false
+    log_path: './logs'
+    log_max_size_mb: 1024
+    log_max_backup_number: 2
+    plugin_path: './plugins'
+    database:
+      mysql_host: '127.0.0.1'
+      mysql_port: 3306
+      mysql_user: 'root'
+      mysql_password: '123456'
+      mysql_schema: 'sqle'
 ```
 ## 配置说明
-### sqle_config
+### 通用配置
+|参数|说明|
+|-|-|
+|id|server id，辨识集群节点，集群内不重复即可|
+|api|当前服务的web接口参数|
+|secret_key|全局AES加密秘钥，影响登录和用户密码等的存储；**生产环境建议配置该值替换掉程序默认值，不然会存在安全风险**；格式是32位随机字符串|
+
+#### 通用配置.api
 |参数|说明|
 |-|-|
-|server_port|sqle 服务的 http 端口，默认10000|
+|addr|server id，辨识集群节点，集群内不重复即可|
+|port|当前服务的web接口参数|
 |enable_https|是否开启https，默认不开启|
 |cert_file_path|https 证书路径|
 |key_file_path|https 私钥路径|
+
+### DMS 配置
+|参数|说明|
+|-|-|
+|id|通用配置|
+|api|通用配置|
+|secret_key|通用配置|
+|service|服务|
+|cloudbeaver|SQL工作台|
+
+#### DMS.service.database
+|参数|说明|
+|-|-|
+|host|DMS 后端数据库地址|
+|port|DMS 后端数据库地址|
+|username|DMS 后端数据库用户|
+|password|DMS 后端数据库密码|
+|database|DMS 后端数据库 schema|
+|debug||
+
+#### DMS.cloudbeaver
+SQL工作台的配置，配置则代表开启SQL工作台。
+
+|参数|说明|
+|-|-|
+|enable_https|是否是https连接|
+|host|cloudbeaver 地址|
+|port|cloudbeaver 端口|
+|admin_user|cloudbeaver 超级管理员名称|
+|admin_password|cloudbeaver 超级管理员密码|
+
+### SQLE 配置
+|参数|说明|
+|-|-|
+|id|通用配置|
+|api|通用配置|
+|secret_key|通用配置|
+|service|服务|
+
+#### SQLE.service
+|参数|说明|
+|-|-|
 |auto_migrate_table|自动创建表结构，初始化数据|
 |debug_log|开启debug模式，打印更多日志，会打印业务SQL，开发环境可开启|
 |log_path|日志目录|
 |log_max_size_mb|单个日志文件最大大小，单位MB|
 |log_max_backup_number|日志文件最大备份数量|
-|secret_key|全局AES加密秘钥，影响登录和用户密码等的存储；**生产环境建议配置该值替换掉程序默认值，不然会存在安全风险**；格式是32位随机字符串|
+|plugin_path|SQL审核插件的加载地址|
 
-### db_config
+#### SQLE.service.database
 |参数|说明|
 |-|-|
 |mysql_host|SQLE存储库的地址|

diff --git a/docs/deploy-manual/intro.md b/docs/deploy-manual/intro.md
@@ -4,12 +4,12 @@ titile: 安装说明
 # 安装说明
 SQLE 提供了多种安装部署的方式，用户可以结合自己的环境和现状选择。初次体验或者测试使用的话建议使用docker-compose 或 docker 快速部署。
 ## 安装方式
-1. [源码安装](./source.md)
+1. 源码安装（待更新）
 2. [RPM 部署](./rpm.md)
-3. [Docker 部署](./docker.md)
-4. [Docker Compsoe 部署](./docker-compose.md)
+3. Docker 部署（待更新）
+4. Docker Compsoe 部署（待更新）
 ## 如何访问
-SQLE 对外提供 web 服务，在程序部署完成后，即可通过 SQLE UI 访问：http://127.0.0.1:10000
+SQLE 对外提供 web 服务，在程序部署完成后，即可通过 SQLE UI 访问：http://127.0.0.1:10000, 地址和端口为配置文件内 dms.api 配置项。
 :::tip
 ps：ip 和端口请根据前面的配置自行替换，默认端口是10000。
 :::

diff --git a/docs/deploy-manual/rpm.md b/docs/deploy-manual/rpm.md
@@ -22,6 +22,7 @@ rpm -ivh /path/to/sqle-ce-${version}.qa.el7.x86_64.rpm --prefix=/opt/sqle
 准备一台 MySQL5.7 作为 SQLE 的后端存储数据库。执行下面命令创建 SQLE 需要的 schema：
 ```sql
 CREATE DATABASE IF NOT EXISTS sqle default character set utf8mb4 collate utf8mb4_unicode_ci
+CREATE DATABASE IF NOT EXISTS dms default character set utf8mb4 collate utf8mb4_unicode_ci
 ```
 :::tip
 创建好的 Schema 将在下面修改SQLE配置时使用到。
@@ -31,17 +32,18 @@ CREATE DATABASE IF NOT EXISTS sqle default character set utf8mb4 collate utf8mb4
 安装完 SQLE 后，需要根据实际情况修改SQLE的配置，参考：[配置文件说明](./config.md)。SQLE安装完成后提供一个配置模版可直接修改。
 ```sh
 cd /opt/sqle/etc
-mv sqled.yml.template sqled.yml
-vim sqled.yml
+vim config.yml
 ```
 :::tip
-确保 sqled.yml 的文件 owner 为 actiontech-universe:actiontech
+确保 config.yml 的文件 owner 为 actiontech-universe:actiontech
 :::
 
 ## 启动 SQLE
 SQLE 进程通过 Systemd 管理。在成功安装 RPM 后，执行启动命令：
 ```sh
-systemctl start sqled
+cd /opt/sqle
+chmod +x scripts/init_start.sh
+./scripts/init_start.sh
 ```
 
 ## 启动失败问题诊断

diff --git a/docusaurus.config.js b/docusaurus.config.js
@@ -36,11 +36,14 @@ const config = {
           // Please change this to your repo.
           // Remove this to remove the "edit this page" links.
           editUrl: 'https://github.com/actiontech/sqle-docs/tree/main/',
-          // lastVersion: 'v2',
+          lastVersion: 'current',
           versions: {
             current: {
+              label: 'v3',
+            },
+            v2: {
               label: 'v2',
-              path: '/',
+              path: '/v2',
             },
           },
         },
@@ -108,7 +111,7 @@ const config = {
             position: 'right',
             dropdownItemsAfter: [
               {
-                label: 'v1 版本',
+                label: 'v1',
                 href: 'https://actiontech.github.io/sqle-docs-cn/',
               }
             ],