Upgrade OMS in single-node deployment mode

OceanBase Migration Service (OMS) V3.2.1 and later can be directly upgraded to V4.3.1. This topic describes how to upgrade OMS in single-node deployment mode in different scenarios.

Background information

An upgrade to OMS V4.3.1 can be classified into the following two version scenarios:

• The current version is V3.2.1 or later but earlier than V4.0.1.

  Notice

  OMS of a version earlier than V3.2.1 must be first upgraded to V3.2.1.

  To upgrade OMS from V3.2.1 or later, or a version earlier than V4.0.1 to V4.3.1, you must perform the following two more steps than upgrading from V4.0.1 or later to V4.3.1:

  • Check the prerequisites below.

  • Execute the upgrade package in the .jar format during the upgrade.

    Notice

    OMS V4.0.1 integrates the migration and synchronization frameworks, which involves the restructuring of table schemas. To upgrade OMS of a version earlier than V4.0.1 to V4.0.1 or later, you must restructure table schemas. Do not perform this operation in other scenarios.

• The current version is V4.0.1 or later.

Before you upgrade OMS to V4.3.1 in the preceding two scenarios, check the following prerequisites.

• If you want to deploy the cluster manager (CM) database separately, make sure that all data migration and synchronization tasks have proceeded to the expected step.

  • Reverse increment is enabled:

    • If a task includes the full migration and incremental synchronization steps, the task must enter the reverse increment step before the upgrade.

    • If a task includes the full migration step but not the incremental synchronization step, the task must complete the full migration step before the upgrade.

    • If a task includes the incremental synchronization step but not the full migration step, the task must enter the reverse increment step before the upgrade.

    • If a task does not include the full migration or incremental synchronization step, no requirements are raised for the task before the upgrade.

  • If reverse increment is disabled, no requirements are raised for tasks before the upgrade.

• Modify the config.yaml file.

  Notice

  Do not modify OMS deployed by using OAT of a version earlier than V4.3.2.

  Modification	Key	Description
  Add keys	oms_rm_meta_host oms_cm_meta_host	The data is sourced from oms_meta_host.
  	oms_rm_meta_port oms_cm_meta_port	The data is sourced from oms_meta_port.
  	oms_rm_meta_password oms_cm_meta_password	The data is sourced from oms_meta_password.
  	oms_rm_meta_user oms_cm_meta_user	The data is sourced from oms_meta_user.
  Delete keys	oms_meta_host oms_meta_port oms_meta_password oms_meta_user	In OMS V4.3.1, you must delete these four keys from the config.yaml configuration file. Otherwise, the connection strings of the resource manager (RM) and CM databases may be lost when you run the docker_init.sh script.

  Here is a sample config.yaml configuration file of OMS V4.3.0:

  "cm_location": "2"
  "cm_nodes":
  - "xxx.xxx.xxx.1"
  - "xxx.xxx.xxx.2"
  "cm_region": "cn-hangzhou"
  "cm_region_cn": "cn-hangzhou"
  "cm_url": "http://xxx.xxx.xxx.1:8088"
  "drc_cm_db": "oms_cm"
  "drc_cm_heartbeat_db": "oms_cm_hb_hangzhou"
  "drc_rm_db": "oms_rm"
  "oms_meta_host": "xxx.xxx.xxx.3"
  "oms_meta_password": "ob_password"
  "oms_meta_port": "2883"
  "oms_meta_user": "oms_meta_user"
  

  Here is a modified config.yaml configuration file for OMS V4.3.1:

  "cm_location": "2"
  "cm_nodes":
  - "xxx.xxx.xxx.1"
  - "xxx.xxx.xxx.2"
  "cm_region": "cn-hangzhou"
  "cm_region_cn": "cn-hangzhou"
  "cm_url": "http://xxx.xxx.xxx.1:8088"
  "drc_cm_db": "oms_cm"
  "drc_cm_heartbeat_db": "oms_cm_hb_hangzhou"
  "drc_rm_db": "oms_rm"
  "oms_cm_meta_host": "xxx.xxx.xxx.3"
  "oms_cm_meta_password": "ob_password"
  "oms_cm_meta_port": "2883"
  "oms_cm_meta_user": "oms_meta_user"
  "oms_rm_meta_host": "xxx.xxx.xxx.3"
  "oms_rm_meta_password": "ob_password"
  "oms_rm_meta_port": "2883"
  "oms_rm_meta_user": "oms_meta_user"
  

Upgrade OMS from V4.0.1 or later to V4.3.1

1. If high availability (HA) is enabled, record the current value of the ha.config parameter and disable HA.

   1. Log in to the OMS console.

   2. In the left-side navigation pane, choose System Management > System Parameters.

   3. On the System Parameters page, find ha.config.

   4. Click the edit icon in the Value column of the parameter.

   5. In the Modify Value dialog box, copy and save the current value of ha.config, and set enable to false to disable HA.

   6. Click OK.

2. Back up databases.

   1. Stop the container of OMS V4.3.0 and record the time as T1.

      sudo docker stop ${CONTAINER_NAME}
      

      Note

      CONTAINER_NAME specifies the name of the container.

      • If you deploy the system in the single-node deployment mode or in the separated deployment mode without the need to keep data migration or data synchronization tasks running, perform the upgrade operations on the management and component containers as described in this section.

      • If you deploy the system in the separated deployment mode and need to keep data migration or data synchronization tasks running, do not stop the OMS V4.3.0 component container. You can use the upgrade assistant tool to upgrade the component container and then perform the upgrade operations on the management container as described in this section.

        The following procedure describes how to upgrade the component container in the separated deployment mode.

        1. Contact technical support to obtain the installation package of the upgrade assistant tool. The installation package for the x86 architecture is named oms-<version number>_x86_upgrade_tools-amd64-xxxxxxxxxxxxx, and the installation package for the ARM architecture is named oms-<version number>_arm_upgrade_tools-arm64-xxxxxxxxxxxxx.
        2. Load the downloaded upgrade assistant tool installation package into the local image repository of the Docker container.

           docker load -i <upgrade assistant tool installation package>
           

        3. Parse the corresponding host directory of /home/ds/run on the OMS server.

           docker inspect ${OMS container name} | jq -r '.[0].Mounts[] | select(.Destination == "/home/ds/run") | .Source'
           

        4. Fill in the docker run command based on the template.

           sudo docker run -d -v ${directory parsed in the previous step}/rpm:/root/rpm --name oms-upgrade-tool ${upgrade assistant tool image ID} 
           

        5. Enter the OMS component container.

           cd /home/ds/run/rpm
           

        6. Upgrade the component container.

           sh support_upgrade_action.sh
           

           After the command is executed, the component container is successfully upgraded, and data migration or data synchronization tasks will not be interrupted.

        7. After the component container is upgraded, you can remove the upgrade assistant tool.

           sudo docker rmi ${upgrade assistant tool image ID}
           

   2. Log in to the CM heartbeat database specified in the configuration file and back up data.

      # Log in to the CM heartbeat database specified in the configuration file.
      mysql -hxxx.xxx.xxx.xxx -P<port> -u<username> -p<password> -Dcm_hb_430
      

      # Create an intermediate table.
      CREATE TABLE IF NOT EXISTS `heatbeat_sequence_bak` (
      `id` bigint(20) NOT NULL AUTO_INCREMENT COMMENT 'PK',
      `gmt_created` datetime NOT NULL,
      `gmt_modified` datetime NOT NULL,
      PRIMARY KEY (`id`)
      ) DEFAULT CHARSET=utf8 COMMENT='Heartbeat sequence table';
      
      # Back up data to the intermediate table.
      INSERT INTO heatbeat_sequence_bak SELECT `id`,`gmt_created`,`gmt_modified` FROM heatbeat_sequence ORDER BY `id` DESC LIMIT 1;
      
      # Rename the heatbeat_sequence table and the intermediate table.
      # The heatbeat_sequence table provides auto-increment IDs and reports heartbeats.
      ALTER TABLE `heatbeat_sequence` RENAME TO `heatbeat_sequence_bak2`;
      ALTER TABLE `heatbeat_sequence_bak` RENAME TO `heatbeat_sequence`;
      
      # Delete the original table.
      DROP TABLE heatbeat_sequence_bak2;
      

   3. Run the following commands to back up the rm, cm, and cm_hb databases as SQL files and make sure that the sizes of the three files are not 0:

      mysqldump -hxxx.xxx.xxx.xxx -P<port> -u<username> -p<password> --triggers=false rm_430 > /home/admin/rm_430.sql
      
      mysqldump -hxxx.xxx.xxx.xxx -P<port> -u<username> -p<password> --triggers=false cm_430 > /home/admin/cm_430.sql
      
      mysqldump -hxxx.xxx.xxx.xxx -P<port> -u<username> -p<password> --triggers=false cm_hb_430 > /home/admin/cm_hb_430.sql
      

      Parameter	Description
      -h	The IP address of the host from which the data is exported.
      -P	The port number used to connect to the database.
      -u	The username used to connect to the database.
      -p	The password used to connect to the database.
      --triggers	The data export trigger. The default value is false, which disables data export.
      rm_430, cm_430, and cm_hb_430	Specifies to back up the rm, cm, and cm_hb databases as SQL files named in the format of database name > SQL file storage path.sql. You need to replace the values based on the actual environment.

   4. Back up the config.yaml configuration file.

3. Load the downloaded OMS installation package to the local image repository of the Docker container.

   docker load -i <OMS installation package>
   

4. Confirm the following information:

   • The config.yaml configuration file is suitable for OMS V4.3.1 and the CM database for each region is as expected.

   • The three disk mount paths of OMS are the same as those before the upgrade.
     

     You can run the sudo docker inspect ${CONTAINER_NAME} | grep -A5 'Binds' command to view the paths of disks mounted to the old OMS container.

   • The image ID is correct.

5. Start the container of OMS V4.3.1.

   You can access the OMS console by using an HTTP or HTTPS URL. To securely access the OMS console, install an SSL certificate and mount it to the specified directory in the container. The certificate is not required for HTTP access.

   OMS_HOST_IP=xxx
   CONTAINER_NAME=oms_xxx
   IMAGE_TAG=feature_x.x.x
   
   docker run -dit --net host \
   -v /data/config.yaml:/home/admin/conf/config.yaml \
   -v /data/oms/oms_logs:/home/admin/logs \
   -v /data/oms/oms_store:/home/ds/store \
   -v /data/oms/oms_run:/home/ds/run \
   # If you mount the SSL certificate to the OMS container, you must set the following two parameters:
   -v /data/oms/https_crt:/etc/pki/nginx/oms_server.crt 
   -v /data/oms/https_key:/etc/pki/nginx/oms_server.key
   -e OMS_HOST_IP=${OMS_HOST_IP} \
   -e IS_UPGRADE=true \
   --privileged=true \
   --pids-limit -1 \
   --ulimit nproc=65535:65535 \
   --name ${CONTAINER_NAME} \
   work.oceanbase-dev.com/obartifact-store/oms:${IMAGE_TAG} 
   

   Parameter	Description
   OMS_HOST_IP	The IP address of the host.
   CONTAINER_NAME	The name of the container, in the oms_xxx format. Specify xxx based on the actual OMS version. For example, if you use OMS V4.3.1, the value is oms_431.
   IMAGE_TAG	The unique identifier of the loaded image. After you load the installation package of OMS by using Docker, run the docker images command to obtain the [IMAGE ID] or [REPOSITORY:TAG] value of the loaded image. The obtained value is the unique identifier (<OMS_IMAGE>) of the loaded image.
   /data/oms/oms_logs /data/oms/oms_store /data/oms/oms_run	/data/oms/oms_logs, /data/oms/oms_store, and /data/oms/oms_run can be replaced with the mount directories created on the server where OMS is deployed to respectively store the runtime log files of OMS, the files generated by the Store component, and the files generated by the Incr-Sync component, for local data persistence. Notice The mount directories must remain unchanged during subsequent redeployment or upgrades.
   /home/admin/logs /home/ds/store /home/ds/run	/home/admin/logs, /home/ds/store, and /home/ds/run are default directories in the container and cannot be modified.
   /data/oms/https_crt (optional) /data/oms/https_key (optional)	The mount directory of the SSL certificate in the container of OMS. If you mount an SSL certificate, the Nginx service in the OMS container runs in HTTPS mode. In this case, you can access the OMS console by using only the HTTPS URL.
   IS_UPGRADE	Specifies whether the current scenario is an upgrade. Note that IS_UPGRADE must be in uppercase.
   privileged	Specifies whether to grant extended privileges on the container.
   pids-limit	Specifies whether to limit the number of container processes. The value -1 indicates that the number is unlimited.
   ulimit nproc	The maximum number of user processes.

6. Run the sh /root/docker_upgrade.sh command.

   • In the integrated deployment mode, you can run this command on any OMS node.

   • In the separated deployment mode, you can run this command on any management node.

7. On the System Parameters page, enable HA and configure the related parameters.

   1. Log in to the OMS console.

   2. In the left-side navigation pane, choose System Management > System Parameters.

   3. On the System Parameters page, find ha.config.

   4. Click the edit icon in the Value column of the parameter.

   5. In the Modify Value dialog box, set enable to true to enable HA, and record the time as T2.

   6. We recommend that you set the perceiveStoreClientCheckpoint parameter to true. After that, you do not need to record T1 and T2.

      If you set the perceiveStoreClientCheckpoint parameter to true, you can use the default value 30min of the refetchStoreIntervalMin parameter. HA is enabled, so the system starts the Store component based on the earliest request time of downstream components minus the value of the refetchStoreIntervalMin parameter. For example, if the earliest request time of the downstream Connector or JDBC-Connector component is 12:00:00 and the refetchStoreIntervalMin parameter is set to 30 minutes, the system starts the Store component at 11:30:00.

      If you set the perceiveStoreClientCheckpoint parameter to false, you need to modify the value of the refetchStoreIntervalMin parameter as needed. refetchStoreIntervalMin specifies the time interval, in minutes, for pulling data from the Store component. The value must be greater than T2 minus T1.

8. (Optional) To roll back the OMS upgrade, perform the following steps:

   1. Disable the HA feature based on Step 1.

   2. Stop the new container and record the time as T3.

      sudo docker stop ${CONTAINER_NAME}
      

   3. Connect to the MetaDB and run the following commands:

      drop database rm_430;
      drop database cm_430;
      drop database cm_hb_430;
      
      create database rm_430;
      create database cm_430;
      create database cm_hb_430;
      

   4. Restore the original databases based on the SQL files created in Step 2.

      mysql -hxxx.xxx.xxx.xxx -P<port> -u<username> -p<password> -e "source /home/admin/rm_430.sql" -Drm_430
      
      mysql -hxxx.xxx.xxx.xxx -P<port> -u<username> -p<password> -e "source /home/admin/cm_430.sql" -Dcm_430
      
      mysql -hxxx.xxx.xxx.xxx -P<port> -u<username> -p<password> -e "source /home/admin/cm_hb_430.sql" -Dcm_hb_430
      

   5. Restart the container of OMS V4.3.0.

      sudo docker restart ${CONTAINER_NAME}
      

   6. On the System Parameters page, enable HA.

      Note

      • We recommend that you set the perceiveStoreClientCheckpoint parameter to true.

      • The HA feature automatically starts disaster recovery and the Incr-Sync component. However, you must manually resume the Full-Import component.

9. After the upgrade is complete, clear the browser cache before you log in to OMS.

Upgrade OMS to V4.3.1 from V3.2.1 or a version later than V3.2.1 but earlier than V4.0.1

Prerequisites

• Before the upgrade, check whether data migration and synchronization tasks with duplicate names exist. If yes, rename the tasks to ensure that all task names are unique.

  Run the following command to check for tasks with duplicate names:

  • Data migration tasks

    SELECT project_name,count(*) AS count,group_concat(id) AS ids FROM oms_project WHERE project_status != "DELETED" GROUP BY project_name HAVING count(*) > 1;
    

  • Data synchronization tasks

    SELECT project_name,count(*) AS count,group_concat(id) AS ids FROM oms_sync_project WHERE project_status != "DELETED" GROUP BY project_name HAVING count(*) > 1;
    

  If tasks with duplicate names exist, rename the tasks in sequence. The syntax for renaming tasks is as follows:

  • Data migration tasks

    UPDATE oms_project SET project_name=<New name of the data migration task> WHERE id=<ID of the data migration task>;
    

  • Data synchronization tasks

    UPDATE oms_sync_project SET project_name=<New name of the data synchronization task> WHERE id=<ID of the data synchronization task>;
    

• If you use an OceanBase data source as both the target of one task and the source of another, and you have updated the blackRegionNo parameter of JDBCWriter, perform the following steps:

  1. In the OMS container, run the following command to obtain the value of cm_location:

     cat /home/admin/conf/config.yaml  | grep 'cm_location'
     

  2. Log in to the drc_cm database of OMS and run the following command:

     SELECT * FROM config_job WHERE `key`='sourceFile.blackRegionNo' AND VALUE!=xxx;
     

     If the query result is not empty and a data source is still used as both the target of one task and the source of another, contact OMS Technical Support. If the query result is empty, proceed with the upgrade operations.

Procedure

The following procedure shows how to upgrade OMS from V3.4.0 to V4.3.1.

1. If HA is enabled, record the current value of the ha.config parameter and disable HA.

2. Back up databases.

   1. Stop the container of OMS V3.4.0 and record the time as T1.

      sudo docker stop ${CONTAINER_NAME}
      

      Note

      CONTAINER_NAME specifies the name of the container.

   2. Log in to the CM heartbeat database specified in the configuration file and back up data.

      # Log in to the CM heartbeat database specified in the configuration file.
      mysql -hxxx.xxx.xxx.xxx -P<port> -u<username> -p<password> -Dcm_hb_340
      

      # Create an intermediate table.
      CREATE TABLE IF NOT EXISTS `heatbeat_sequence_bak` (
      `id` bigint(20) NOT NULL AUTO_INCREMENT COMMENT 'PK',
      `gmt_created` datetime NOT NULL,
      `gmt_modified` datetime NOT NULL,
      PRIMARY KEY (`id`)
      ) DEFAULT CHARSET=utf8 COMMENT='Heartbeat sequence table';
      
      # Back up data to the intermediate table.
      INSERT INTO heatbeat_sequence_bak SELECT `id`,`gmt_created`,`gmt_modified` FROM heatbeat_sequence ORDER BY `id` DESC LIMIT 1;
      
      # Rename the heatbeat_sequence table and the intermediate table.
      # The heatbeat_sequence table provides auto-increment IDs and reports heartbeats.
      ALTER TABLE `heatbeat_sequence` RENAME TO `heatbeat_sequence_bak2`;
      ALTER TABLE `heatbeat_sequence_bak` RENAME TO `heatbeat_sequence`;
      
      # Delete the original table.
      DROP TABLE heatbeat_sequence_bak2;
      

   3. Run the following commands to back up the rm, cm, and cm_hb databases as SQL files and make sure that the sizes of the three files are not 0:

      mysqldump -hxxx.xxx.xxx.xxx -P<port> -u<username> -p<password> --triggers=false rm_340 > /home/admin/rm_340.sql
      
      mysqldump -hxxx.xxx.xxx.xxx -P<port> -u<username> -p<password> --triggers=false cm_340 > /home/admin/cm_340.sql
      
      mysqldump -hxxx.xxx.xxx.xxx -P<port> -u<username> -p<password> --triggers=false cm_hb_340 > /home/admin/cm_hb_340.sql
      

   4. Back up the config.yaml configuration file.

3. Load the downloaded OMS installation package to the local image repository of the Docker container.

   docker load -i <OMS installation package>
   

4. Confirm the following information:

   • The config.yaml configuration file is suitable for OMS V4.3.1 and the CM database for each region is as expected.

   • The three disk mount paths of OMS are the same as those before the upgrade.
     

     You can run the sudo docker inspect ${CONTAINER_NAME} | grep -A5 'Binds' command to view the paths of disks mounted to the old OMS container.

   • The image ID is correct.

5. Start the container of OMS V4.3.1.

   You can access the OMS console by using an HTTP or HTTPS URL. To securely access the OMS console, install an SSL certificate and mount it to the specified directory in the container. The certificate is not required for HTTP access.

   OMS_HOST_IP=xxx
   CONTAINER_NAME=oms_xxx
   IMAGE_TAG=feature_x.x.x
   
   docker run -dit --net host \
   -v /data/config.yaml:/home/admin/conf/config.yaml \
   -v /data/oms/oms_logs:/home/admin/logs \
   -v /data/oms/oms_store:/home/ds/store \
   -v /data/oms/oms_run:/home/ds/run \
   # If you mount the SSL certificate to the OMS container, you must set the following two parameters:
   -v /data/oms/https_crt:/etc/pki/nginx/oms_server.crt 
   -v /data/oms/https_key:/etc/pki/nginx/oms_server.key
   -e OMS_HOST_IP=${OMS_HOST_IP} \
   -e IS_UPGRADE=true \
   --privileged=true \
   --pids-limit -1 \
   --ulimit nproc=65535:65535 \
   --name ${CONTAINER_NAME} \
   work.oceanbase-dev.com/obartifact-store/oms:${IMAGE_TAG} 
   

6. Go to the new container.

   docker exec -it ${CONTAINER_NAME} bash  
   

7. Execute the .jar upgrade package.

   /opt/alibaba/java/bin/java -jar correction-1.0-SNAPSHOT-jar-with-dependencies.jar -mupgrade -y/home/admin/conf/config.yaml -ltrue
   

   Notice

   Replace the parameter values based on the actual situation.

   Parameter	Description
   -m	The running mode. The valid value is UPGRADE.
   -y	The absolute path of the OMS configuration file.
   -l	Specifies whether this upgrade node is the last one. In single-region scenarios, set this parameter to true.

8. After the upgrade JAR is executed, run the metadata initialization command in the root directory.

   python -m omsflow.scripts.units.oms_cluster_manager add_resource
   

9. Run the sh /root/docker_upgrade.sh command.

   • In the integrated deployment mode, you can run this command on any OMS node.

   • In the separated deployment mode, you can run this command on any management node.

10. On the System Parameters page, enable HA and configure the related parameters.

    1. Log in to the OMS console.

    2. In the left-side navigation pane, choose System Management > System Parameters.

    3. On the System Parameters page, find ha.config.

    4. Click the edit icon in the Value column of the parameter.

    5. In the Modify Value dialog box, set enable to true to enable HA, and record the time as T2.

    6. We recommend that you set the perceiveStoreClientCheckpoint parameter to true. After that, you do not need to record T1 and T2.

       If you set the perceiveStoreClientCheckpoint parameter to true, you can use the default value 30min of the refetchStoreIntervalMin parameter. HA is enabled, so the system starts the Store component based on the earliest request time of downstream components minus the value of the refetchStoreIntervalMin parameter. For example, if the earliest request time of the downstream Connector or JDBC-Connector component is 12:00:00 and the refetchStoreIntervalMin parameter is set to 30 minutes, the system starts the Store component at 11:30:00.

       If you set the perceiveStoreClientCheckpoint parameter to false, you need to modify the value of the refetchStoreIntervalMin parameter as needed. refetchStoreIntervalMin specifies the time interval, in minutes, for pulling data from the Store component. The value must be greater than T2 minus T1.

11. (Optional) To roll back the OMS upgrade, perform the following steps:

    1. Disable the HA feature based on Step 1.

    2. Stop the new container and record the time as T3.

       sudo docker stop ${CONTAINER_NAME}
       

    3. Connect to the MetaDB and run the following commands:

       drop database rm_340;
       drop database cm_340;
       drop database cm_hb_340;
       
       create database rm_340;
       create database cm_340;
       create database cm_hb_340;
       

    4. Restore the original databases based on the SQL files created in Step 2.

       mysql -hxxx.xxx.xxx.xxx -P<port> -u<username> -p<password> -e "source /home/admin/rm_340.sql" -Drm_340
       
       mysql -hxxx.xxx.xxx.xxx -P<port> -u<username> -p<password> -e "source /home/admin/cm_340.sql" -Dcm_340
       
       mysql -hxxx.xxx.xxx.xxx -P<port> -u<username> -p<password> -e "source /home/admin/cm_hb_340.sql" -Dcm_hb_340
       

    5. Restart the container of OMS V3.4.0.

       sudo docker restart ${CONTAINER_NAME}
       

    6. On the System Parameters page, enable HA.

       Note

       • We recommend that you set the perceiveStoreClientCheckpoint parameter to true.

       • The HA feature automatically starts disaster recovery and the Incr-Sync component. However, you must manually resume the Full-Import component.

12. After the upgrade is complete, clear the browser cache before you log in to OMS.