+
+ | 工具名称 |
+ 配置文件位置 |
+
+
+ | chameleon |
+ ${config}/chameleon/config-example.yml |
+
+
+ | zookeeper |
+ ${confluent.path}/etc/kafka/zookeeper.properties |
+
+
+ | kafka |
+ ${confluent.path}/etc/kafka/server.properties |
+
+
+ | schema-registry |
+ ${confluent.path}/etc/schema-registry/schema-registry.properties |
+
+
+ | connector-mysql |
+ ${config}/debezium/connect-avro-standalone.properties |
+
+
+ | ${config}/debezium/mysql-source.properties |
+
+
+ | ${config}/debezium/mysql-sink.properties |
+
+
+ | connector-opengauss |
+ ${config}/debezium/connect-avro-standalone.properties |
+
+
+ | ${config}/debezium/opengauss-source.properties |
+
+
+ | ${config}/debezium/opengauss-sink.properties |
+
+
+ | datacheck |
+ ${config}/datacheck/application-source.yml |
+
+
+ | ${config}/datacheck/application-sink.yml |
+
+
+ | ${config}/datacheck/application.yml |
+
+
+
+## 执行迁移计划
+
+portal支持启动多个任务执行不同的迁移计划，但是要求各迁移计划使用的MySQL实例和openGauss数据库互不相同。
+
+启动迁移计划时需要添加参数，这样不同的迁移计划可以根据不同的workspace.id进行区分，如果不添加的话，workspace.id默认值为1。
+
+启动workspace.id为2的全量迁移：
```
-java -Dpath=/ops/portal/ -Dskip=true -Dorder=start_mysql_full_migration -Dworkspace.id=2 -jar portalControl-1.0-SNAPSHOT-exec.jar
+sh gs_rep_portal.sh start_mysql_full_migration 2 &
```
-portal除了支持单项任务的启动与停止，也会提供一些组合的默认计划：
+portal除了支持单项功能的启动与停止，也会提供一些组合的默认计划：
-启动包括全量迁移和全量校验在内的迁移计划：
+启动workspace.id为2的包括全量迁移和全量校验在内的迁移计划：
```
-java -Dpath=/ops/portal/ -Dskip=true -Dorder=start_plan1 -Dworkspace.id=3 -jar portalControl-1.0-SNAPSHOT-exec.jar
+sh gs_rep_portal.sh start_plan1 2 &
```
-#### 计划列表
+### 计划列表
| 计划名称 | 包括指令 |
| -------- | -------------------------------------------- |
@@ -271,42 +361,48 @@ java -Dpath=/ops/portal/ -Dskip=true -Dorder=start_plan1 -Dworkspace.id=3 -jar p
| plan2 | 全量迁移→全量校验→增量迁移→增量校验 |
| plan3 | 全量迁移→全量校验→增量迁移→增量校验→反向迁移 |
-#### 增量迁移和反向迁移
+### 增量迁移和反向迁移
增量迁移功能是持续将MySQL端的数据修改同步到openGauss端的功能，而反向迁移功能是持续将openGauss端的数据修改同步到MySQL端的功能，所以二者均不会自动关闭。如果用户想要停止增量迁移功能，需要另开窗口输入指令停止增量迁移功能，反向迁移功能同理。
-并且需要注意的是：增量迁移和反向迁移不能同时开启，如果一个计划中包含了增量迁移和反向迁移，那么需要用户手动停止增量迁移，启动反向迁移，以启动默认计划3为例：
+并且需要注意的是：增量迁移和反向迁移不能同时开启，如果一个计划中包含了增量迁移和反向迁移，那么需要用户手动停止增量迁移，启动反向迁移。用户在停止增量迁移之后到启动反向迁移之前，禁止向openGauss进行作业，否则会导致这之间的数据丢失。
+
+以启动默认计划3为例：
-在配置好配置文件后输入以下指令开启plan3：
+1.在配置好配置文件后输入以下指令启动workspace.id为3的计划plan3：
```
-java -Dpath=/ops/portal/ -Dskip=true -Dorder=start_plan3 -Dworkspace.id=3 -jar portalControl-1.0-SNAPSHOT-exec.jar
+sh gs_rep_portal.sh start_plan3 3 &
```
-这时portal会自动执行全量迁移→全量校验→增量迁移→增量校验，然后一直处于增量迁移状态（此时增量迁移和增量校验同时运行），如果用户想要停止增量迁移功能，需要另开窗口输入以下指令停止增量迁移功能：
+这时portal会自动执行全量迁移→全量校验→增量迁移→增量校验，然后一直处于增量迁移状态（此时增量迁移和增量校验同时运行）。
+
+2.如果用户想要停止增量迁移功能，需要另开窗口输入以下指令停止增量迁移功能：
```
-java -Dpath=/ops/portal/ -Dskip=true -Dorder=stop_incremental_migration -Dworkspace.id=3 -jar portalControl-1.0-SNAPSHOT-exec.jar
+sh gs_rep_portal.sh stop_incremental_migration 3 &
```
-输入指令后，这个进程会退出，而正在执行计划的portal会接收到停止增量迁移的消息，从而停止增量迁移，等待下一步指令。
+输入指令后，这个进程会退出，而正在执行计划的workspace.id为3的portal主进程会接收到停止增量迁移的消息，从而停止增量迁移，等待下一步指令。
-如果用户想要启动反向迁移功能，需要输入以下指令：
+3.如果用户想要启动反向迁移功能，需要输入以下指令：
```
-java -Dpath=/ops/portal/ -Dskip=true -Dorder=run_reverse_migration -Dworkspace.id=3 -jar portalControl-1.0-SNAPSHOT-exec.jar
+sh gs_rep_portal.sh run_reverse_migration 3 &
```
-输入指令后，这个进程会退出，而正在执行计划的portal会接收到启动反向迁移的消息，从而启动反向迁移，此时portal一直处于反向迁移状态。
+输入指令后，这个进程会退出，而正在执行计划的workspace.id为3的portal主进程会接收到启动反向迁移的消息，从而启动反向迁移，此时portal一直处于反向迁移状态。
如果想要停止整个迁移计划，请参考下方的“停止计划”小节。
以下为启动迁移计划的指令列表：
-#### 指令列表
+### 启动指令列表
-| 指令名称 | 指令说明 |
-| ------------------------------------------- | ------------------------------------------------------------ |
+| 指令名称 | 指令说明 |
+|---------------------------------------------|------------------------------------------------- |
+| verify_pre_migration | 迁移前校验 |
+| verify_reverse_migration | 反向迁移前校验 |
| start_mysql_full_migration | 开始mysql全量迁移 |
| start_mysql_incremental_migration | 开始mysql增量迁移 |
| start_mysql_reverse_migration | 开始mysql反向迁移 |
@@ -322,60 +418,60 @@ java -Dpath=/ops/portal/ -Dskip=true -Dorder=run_reverse_migration -Dworkspace.i
用户也可以在/ops/portal/config目录的currentPlan文件中自定义迁移计划，但自定义迁移计划需要遵守以下规则：
-1.在currentPlan中每行填入一条启动单个迁移任务的指令，如start_mysql_full_migration，start_mysql_incremental_migration等。指令的顺序遵循：
+- 在currentPlan中每行填入一条启动单个迁移任务的指令，如start_mysql_full_migration，start_mysql_incremental_migration等。指令的顺序遵循：
-- start_mysql_full_migration
-- start_mysql_full_migration_datacheck
-- start_mysql_incremental_migration
-- start_mysql_incremental_migration_datacheck
-- start_mysql_reverse_migration
+ - start_mysql_full_migration
+ - start_mysql_full_migration_datacheck
+ - start_mysql_incremental_migration
+ - start_mysql_incremental_migration_datacheck
+ - start_mysql_reverse_migration
-如果顺序错误则portal报错。
+ 如果顺序错误则portal报错。
-2.增量校验的上一项一定是增量迁移，全量校验的上一项一定是全量迁移。
+- 增量校验的上一项一定是增量迁移，全量校验的上一项一定是全量迁移。
-3.每个单项任务只能添加一次。
+- 每个单项任务只能添加一次。
-#### 停止计划
+### 停止计划
举例：
-在portal正在执行计划的状态下，另开一个窗口输入以下指令可以停止workspace.id为2的任务：
+在portal正在执行计划的状态下，另开一个窗口输入以下指令可以停止workspace.id为3的任务：
```
-java -Dpath=/ops/portal/ -Dskip=true -Dorder=stop_plan -Dworkspace.id=2 -jar portalControl-1.0-SNAPSHOT-exec.jar
+sh gs_rep_portal.sh stop_plan 3 &
```
-输入指令后，这个进程会退出，而正在执行计划的portal会接收到停止计划的消息，从而停止计划。
+输入指令后，这个进程会退出，而正在执行计划的workspace.id为3的portal主进程会接收到停止计划的消息，从而停止计划。
-#### 启动多个计划
+### 启动多个计划
portal支持同时启动多个计划，但是这些计划的mysql端应该为各不相同的实例，openGauss端应该为各不相同的数据库：
首先修改配置文件，详情见配置参数环节。
-使用workspace.id为p1启动第一个迁移计划（这里启动计划3）：
+使用workspace.id为p1启动第一个迁移计划（这里以启动计划3为例）：
```
-java -Dpath=/ops/portal/ -Dskip=true -Dorder=start_plan3 -Dworkspace.id=p1 -jar portalControl-1.0-SNAPSHOT-exec.jar
+sh gs_rep_portal.sh start_plan3 p1 &
```
然后再次修改配置文件。
-使用workspace.id为p2启动第一个迁移计划（这里启动计划3）：
+使用workspace.id为p2启动第一个迁移计划（这里以启动计划3为例）：
```
-java -Dpath=/ops/portal/ -Dskip=true -Dorder=start_plan3 -Dworkspace.id=p2 -jar portalControl-1.0-SNAPSHOT-exec.jar
+sh gs_rep_portal.sh start_plan3 p2 &
```
这样就启动了多个portal。
-#### 卸载迁移工具
+## 卸载迁移工具
使用以下指令可以卸载不同功能对应的迁移工具，举例：
```
-java -Dpath=/ops/portal/ -Dskip=true -Dorder=uninstall_mysql_all_migration_tools -Dworkspace.id=1 -jar portalControl-1.0-SNAPSHOT-exec.jar
+sh gs_rep_portal.sh uninstall_mysql_all_migration_tools 1 &
```
在命令行运行这条命令可以卸载所有功能用到的迁移工具。
@@ -388,7 +484,49 @@ java -Dpath=/ops/portal/ -Dskip=true -Dorder=uninstall_mysql_all_migration_tools
| uninstall_mysql_reverse_migration_tools | 卸载mysql反向迁移工具 |
| uninstall_mysql_all_migration_tools | 卸载mysql迁移工具 |
+## 完整数据迁移流程
+
+1.下载gs_rep_portal安装包
+
+ ```
+wget -c https://opengauss.obs.cn-south-1.myhuaweicloud.com/latest/tools/centos7/PortalControl-7.0.0rc2-x86_64.tar.gz
+ ```
+
+2.解压gs_rep_portal安装包
+
+ ```
+tar -zxvf PortalControl-7.0.0rc2-x86_64.tar.gz
+ ```
+
+3.在/ops/portal/config目录的toolspath.properties文件中修改安装路径，然后启动命令安装
+
+ ```
+sh gs_rep_portal.sh install_mysql_all_migration_tools 1 &
+ ```
+
+4.在/ops/portal/config目录的migrationConfig.properties文件中修改迁移参数，指定新的workspace.id为2启动迁移计划3
+ ```
+sh gs_rep_portal.sh start_plan3 2 &
+ ```
+
+5.程序将自动运行至增量迁移和增量校验同时开启中，让workspace.id为2的任务停止增量迁移，此时程序进入等待状态，之后可以启动反向迁移或停止计划
+
+ ```
+sh gs_rep_portal.sh stop_incremental_migration 2 &
+ ```
+
+6.启动反向迁移，此时程序进入反向迁移状态，之后可以停止计划
+
+ ```
+sh gs_rep_portal.sh run_reverse_migration 2 &
+ ```
+
+7.停止workspace.id为2的计划
+
+ ```
+sh gs_rep_portal.sh stop_plan 2 &
+ ```
#### 参与贡献
1. Fork 本仓库
diff --git a/multidb-portal/README.md b/multidb-portal/README.md
new file mode 100644
index 0000000000000000000000000000000000000000..7db0455c465a5d052544635a57378ab3967b8e79
--- /dev/null
+++ b/multidb-portal/README.md
@@ -0,0 +1,275 @@
+# 1 简介
+
+## 1.1 工具介绍
+
+mutidb_portal 是一款基于Java开发的openGauss数据迁移门户工具，整合了openGauss全量迁移、增量迁移、反向迁移及数据校验功能，支持完成MySQL/PostgreSQL到openGauss的一站式迁移。
+
+## 1.2 使用限制
+
+（1）服务器限制
+
+工具当前仅支持在指定系统架构的Linux服务器中运行，支持的系统架构如下：
+
+- CentOS7 x86_64
+- openEuler20.03 x86_64/aarch64
+- openEuler22.03 x86_64/aarch64
+- openEuler24.03 x86_64/aarch64
+
+（2）运行环境限制
+
+工具使用Java 11编写，需要服务器准备Java 11或更高版本的运行环境。
+
+（3）数据库版本限制
+
+- MySQL 5.7及以上版本。
+- PostgreSQL 9.4.26及以上版本。
+- openGauss适配MySQL需要5.0.0及以上版本。
+- openGauss适配PostgreSQL需要6.0.0-RC1及以上版本。
+
+# 2 工具安装
+
+## 2.1 安装包获取
+
+各系统架构对应的安装包下载链接如下表：
+
+| 系统名称 | 架构 | 下载链接 |
+| :------------- | ------- | ------------------------------------------------------------ |
+| CentOS7 | x86_64 | https://opengauss.obs.cn-south-1.myhuaweicloud.com/latest/tools/centos7/openGauss-portal-7.0.0rc2-CentOS7-x86_64.tar.gz |
+| openEuler20.03 | x86_64 | https://opengauss.obs.cn-south-1.myhuaweicloud.com/latest/tools/openEuler20.03/openGauss-portal-7.0.0rc2-openEuler20.03-x86_64.tar.gz |
+| openEuler20.03 | aarch64 | https://opengauss.obs.cn-south-1.myhuaweicloud.com/latest/tools/openEuler20.03/openGauss-portal-7.0.0rc2-openEuler20.03-aarch64.tar.gz |
+| openEuler22.03 | x86_64 | https://opengauss.obs.cn-south-1.myhuaweicloud.com/latest/tools/openEuler22.03/openGauss-portal-7.0.0rc2-openEuler22.03-x86_64.tar.gz |
+| openEuler22.03 | aarch64 | https://opengauss.obs.cn-south-1.myhuaweicloud.com/latest/tools/openEuler22.03/openGauss-portal-7.0.0rc2-openEuler22.03-aarch64.tar.gz |
+| openEuler24.03 | x86_64 | https://opengauss.obs.cn-south-1.myhuaweicloud.com/latest/tools/openEuler24.03/openGauss-portal-7.0.0rc2-openEuler24.03-x86_64.tar.gz |
+| openEuler24.03 | aarch64 | https://opengauss.obs.cn-south-1.myhuaweicloud.com/latest/tools/openEuler24.03/openGauss-portal-7.0.0rc2-openEuler24.03-aarch64.tar.gz |
+
+## 2.2 安装步骤
+
+此处以在CentOS7 x86_64的服务器上安装为例，讲解安装步骤。
+
+（1）下载安装包
+
+下载匹配自身系统架构的安装包，参考命令如下
+
+```sh
+wget https://opengauss.obs.cn-south-1.myhuaweicloud.com/latest/tools/centos7/openGauss-portal-7.0.0rc2-CentOS7-x86_64.tar.gz
+```
+
+（2）解压安装包
+
+完成安装包下载后，参考如下命令解压安装包
+
+```sh
+tar -zxvf openGauss-portal-7.0.0rc2-CentOS7-x86_64.tar.gz
+```
+
+（3）查看目录结构
+
+切换至解压出的portal目录下，查看其目录结构，参考命令如下：
+
+```sh
+cd portal && ls -l
+```
+
+检查是否包含如下目录结构
+
+```sh
+bin # 工具操作命令储存目录，其中包含的命令可逐个执行，以学习各命令提示的用法
+config # 工具配置文件目录
+openGauss-portal-7.0.0rc2.jar # 工具核心jar文件
+pkg # 迁移组件储存目录
+template # 迁移模版文件储存目录
+```
+
+**注意：上述罗列的目录结构中的内容，请勿修改，删减等，否则可能导致工具无法正常运行。**
+
+（4）安装chameleon依赖
+
+chameleon为MySQL全量迁移工具，不需要迁移MySQL时，可以跳过此项。
+
+依赖安装，要求使用root用户，或者sudo免密用户。切换到portal目录下后，执行如下命令
+
+```sh
+./bin/install dependencies
+```
+
+（5）安装迁移工具
+
+迁移工具安装命令如下，其中除去全量迁移工具可根据自身需要安装以外，其他工具均需安装
+
+```sh
+./bin/install tools # 一键安装所有迁移工具命令，需提前完成chameleon依赖安装
+./bin/install chameleon # MySQL全量迁移工具安装命令，需提前完成chameleon依赖安装
+./bin/install full_migration_tool # PostgreSQL全量迁移工具安装命令
+./bin/install debezium # 增量、反向迁移工具安装命令
+./bin/install data_checker # 数据校验工具安装命令
+./bin/install kafka # 工具所需三方工具安装命令
+```
+
+（6）检查安装状态
+
+迁移工具安装完成后，使用如下命令检查各工具安装状态，确保所需迁移工具均已完成安装
+
+```sh
+./bin/install check
+```
+
+# 3 使用迁移功能
+
+## 1.1 创建迁移任务
+
+（1）创建迁移任务
+
+创建迁移任务的命令模版如下，使用时请根据自身情况替换对应参数。
+
+```sh
+./bin/task create