Upgrade OMS in single-node deployment mode

2024-12-02 07:52:46  Updated

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

Background

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

  • The current OMS version is V3.2.1 or a version later than V3.2.1 and earlier than V4.0.2.

    Notice

    To upgrade OMS of a version earlier than V3.2.1, you must upgrade it first to V3.2.1.

  • The current version is V4.0.2 or later.

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

  • Check the prerequisites below.

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

Upgrade OMS from V4.0.2 or later to V4.2.4

  1. If high availability (HA) is enabled, disable it first.

    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 false to disable HA.

  2. Back up the databases.

    1. Suspend the container of OMS V4.2.0 and record the time T1.

      sudo docker stop ${CONTAINER_NAME}

      Note

      CONTAINER_NAME specifies the name of the container.

    2. Log in to the cluster management (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_423

# 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 the heartbeat.
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_423 > /home/admin/rm_423.sql

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

mysqldump -hxxx.xxx.xxx.xxx -P<port> -u<username> -p<password> --triggers=false cm_hb_423 > /home/admin/cm_hb_423.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_423, cm_423, and cm_hb_423 Specifies to back up the rm, cm, and cm_hb databases to 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.

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

    docker load -i <OMS installation package>

  4. Start the new container of OMS V4.2.4.

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

    Notice

    • Before you start the container of OMS V4.2.4, make sure that the three disk mounting 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 -e IS_UPGRADE=true parameter is provided in OMS V3.3.1 or later. This parameter is provided only to support OMS upgrades and must be specified when you upgrade OMS.

    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 in 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.2.4, the value is oms_424.
    IMAGE_TAG The unique identifier of the loaded image. After you load the OMS installation package by using Docker, run the docker images command to obtain the [IMAGE ID] or [REPOSITORY:TAG] of the loaded image. The obtained value is the unique identifier of the loaded image.
    /data/oms/oms_logs
    /data/oms/oms_store
    /data/oms/oms_run    		 You can replace /data/oms/oms_logs, /data/oms/oms_store, and /data/oms/oms_run with the mount directories created on the server where OMS is deployed. The mount directories store the logs generated during the operation of OMS and files generated by the store and synchronization components, respectively, to persistently retain the files on the server.
    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 OMS container. 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 To upgrade OMS, you must set the IS_UPGRADE parameter to true.
    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.

  5. Go to the new container.

    docker exec -it ${CONTAINER_NAME} bash

  6. Perform metadata initialization in the root directory.

    bash /root/docker_init.sh

    After you run the preceding command, the script automatically implements schema changes of the three OMS databases.

  7. After the docker_init.sh script is executed, verify that the server list is normal and all servers are in the Online state.

    1. Log in to the OMS console.

    2. In the left-side navigation pane, choose OPS & Monitoring > Server.

    3. On the Servers page, check whether the server list is normal. Check whether all servers are in the Online state.

  8. 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 T2.

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

      After 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 based on your business needs, which specifies the time interval, in minutes, for pulling data from the Store component. The value must be greater than T2 minus T1.

  9. (Optional) To roll back, perform the following steps:

    1. Disable the HA feature based on Step 1.

    2. Suspend the new container and record the time T3.

      sudo docker stop ${CONTAINER_NAME}

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

      drop database rm_423;
drop database cm_423;
drop database cm_hb_423;

create database rm_423;
create database cm_423;
create database cm_hb_423;

    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_423.sql" -Drm_423

mysql -hxxx.xxx.xxx.xxx -P<port> -u<username> -p<password> -e "source /home/admin/cm_423.sql" -Dcm_423

mysql -hxxx.xxx.xxx.xxx -P<port> -u<username> -p<password> -e "source /home/admin/cm_hb_423.sql" -Dcm_hb_423

    5. Restart the container of OMS V4.2.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 recover the Full-Import component.

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

Upgrade OMS to V4.2.4 from V3.2.1 or a version later than V3.2.1 and earlier than V4.0.2

Prerequisites

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

    Run the following command to check whether tasks with duplicate names exist:

    • Data migration task

      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 task

      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 is as follows:

    • Data migration task

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

    • Data synchronization task

      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 Database data source as both the destination of one data synchronization task and the source of another task, 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 destination of one data synchronization task and the source of another task, contact OMS Technical Support. If the query result is empty, proceed with the upgrade operations.

Procedure

The following procedure takes the upgrade of OMS from V3.4.0 to V4.2.4 as an example.

  1. If HA is enabled, disable it first.

  2. Back up the databases.

    1. Suspend the container of OMS V3.4.0 and record the time 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 the heartbeat.
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

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

    docker load -i <OMS installation package>

  4. Start the new container of OMS V4.2.4.

    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.

    Notice

    • Before you start the container of OMS V4.2.4, make sure that the three disk mounting 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 -e IS_UPGRADE=true parameter is provided in OMS V3.3.1 or later. This parameter is provided only to support OMS upgrades and must be specified when you upgrade OMS.

    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 in 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}

  5. Go to the new container.

    docker exec -it ${CONTAINER_NAME} bash

  6. Run the following command to make the OMS console enter the STOPPED state:

    supervisorctl stop oms_console

  7. After the CM/Supervisor component is started, run the following command to execute the upgrade package in the .jar format.

    Notice

    Replace the parameter values based on the actual situation.

    /opt/alibaba/java/bin/java -jar correction-1.0-SNAPSHOT-jar-with-dependencies.jar -mupgrade -y/home/admin/conf/config.yaml -ltrue
    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. In multi-region scenarios, set this parameter to false for the first several regions, and to true for the last region only.
    Note: In multi-region, multi-node scenarios, you need to execute the upgrade package in the .jar format only for the first node in each region. When you perform an upgrade for the last region, set the -l parameter to true.

  8. Perform metadata initialization in the root directory.

    bash /root/docker_init.sh

    After you run the preceding command, the script automatically implements schema changes of the three OMS databases.

  9. After the docker_init.sh script is executed, verify that the server list is normal and all servers are in the Online state.

  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 T2.

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

      After 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 based on your business needs, which 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, perform the following steps:

    1. Disable the HA feature based on Step 1.

    2. Suspend the new container and record the time 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 recover the Full-Import component.

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

Last
Next

OceanBaseOceanBase

OceanBase, A Highly Scalable Database for Transactional, Analytical, and AI Workloads.

Company

About OceanBaseContact UsPartner

Product

OceanBase CloudOceanBase EnterpriseQuick StartDownloadPricing

Resources

DocsBlogWhite PaperTrust Center

Follow us

LinkedInLinkedInDiscordDiscordTwitterTwitterYoutubeYoutubeForumForumGitHubGitHubStack OverflowStack Overflow

© OceanBase 2024. All rights reserved | Cloud Service Agreement | Privacy Policy | Legal | Security

Contact Us