Upgrade OMS Community Edition in single-node deployment mode

This topic describes how to upgrade OceanBase Migration Service (OMS) Community Edition in single-node deployment mode to V4.2.8.

Upgrade procedure

1. Back up the database.

   1. Suspend the container of OMS Community Edition V4.2.7 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 cluster management (CM) heartbeat database specified in the configuration file and delete some useless records to reduce the backup time.

      # Log in to the CM heartbeat database specified in the configuration file.
      mysql -hxxx.xxx.xxx.1 -P<port> -u<username> -p<password> -Dcm_hb_427
      
      # Delete useless records.
      # The heatbeat_sequence table provides auto-increment IDs and reports heartbeats.
      delete from heatbeat_sequence where id < (select max(id) from heatbeat_sequence); 
      
      

   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.1 -P<port> -u<username> -p<password> --triggers=false rm_427 > /home/admin/rm_427.sql
      
      mysqldump -hxxx.xxx.xxx.1 -P<port> -u<username> -p<password> --triggers=false cm_427 > /home/admin/cm_427.sql
      
      mysqldump -hxxx.xxx.xxx.1 -P<port> -u<username> -p<password> --triggers=false cm_hb_427 > /home/admin/cm_hb_427.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_427, cm_427, and cm_hb_427	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 specify the values based on the actual environment.

2. Load the downloaded OMS Community Edition installation package to the local image repository of the Docker container.

   docker load -i <Installation package of OMS Community Edition>
   

3. Start a new container for OMS Community Edition V4.2.8.

   You can access the console of OMS Community Edition by using an HTTP or HTTPS URL. To securely access the console of OMS Community Edition, 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 for OMS Community Edition V4.2.8, make sure that the three disk mount paths of OMS Community Edition are the same as those before the upgrade.
     You can run the sudo docker inspect ${CONTAINER_NAME} | grep -A5 'Binds' command to view the disk mount paths before the upgrade, which are paths to the disks mounted to the old container of OMS Community Edition.

   • The IS_UPGRADE parameter is provided in OMS Community Edition V3.3.1 and later. This parameter is provided only to support OMS upgrades and must be specified when you upgrade OMS.

   • You need to replace work.oceanbase-dev.com/obartifact-store/oms:${IMAGE_TAG} with the image name specified in the docker load -i command.

   OMS_HOST_IP=xxx
   CONTAINER_NAME=oms_xxx
   IMAGE_TAG=feature_x.x.x-ce
   
   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.
   IMAGE_TAG	The unique identifier of the loaded image. After you load the OMS Community Edition installation package 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 Community Edition is deployed to respectively store the runtime log files of OMS Community Edition, 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 Community Edition. If you mount an SSL certificate, the NGINX service in the container of OMS Community Edition runs in HTTPS mode. In this case, you can access the console of OMS Community Edition by using only the HTTPS URL.
   IS_UPGRADE	To upgrade OMS Community Edition, you must set the IS_UPGRADE parameter to true. 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.

4. Go to the new container.

   docker exec -it ${CONTAINER_NAME} bash  
   

   Note

   CONTAINER_NAME specifies the name of the container.

5. Perform metadata initialization in the root directory.

   sleep 300
   bash /root/docker_init.sh
   

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

   If the execution of the preceding commands return the Version before 4.1.1 is not allowed to upgrade. error, perform the following operations:

   1. Verify that the version of OMS Community Edition to be upgraded is not earlier than V4.1.1.

   2. Execute the following SQL statements in the rm database:

      CREATE TABLE IF NOT EXISTS `oms_version` (    
         `version` varchar(64) NOT NULL COMMENT 'version',    
         `gmt_modified` timestamp NOT NULL DEFAULT CURRENT_TIMESTAMP,    
         PRIMARY KEY (`version`)
         ) DEFAULT CHARSET = utf8mb4 COMMENT = 'version table';
      
      REPLACE INTO `oms_version`(`version`) VALUES('x.x.x-CE');  -- Specify the version number of OMS Community Edition before the upgrade.
      

   3. Run the initialization command again.

6. 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 console of OMS Community Edition.

   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.

7. (Optional) To roll back OMS Community Edition, perform the following steps:

   1. Suspend the new container and record the time as T3.

      sudo docker stop ${CONTAINER_NAME}
      

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

      drop database rm_427;
      drop database cm_427;
      drop database cm_hb_427;
      
      create database rm_427;
      create database cm_427;
      create database cm_hb_427;
      

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

      mysql -hxxx.xxx.xxx.1 -P<port> -u<username> -p<password> -e "source /home/admin/rm_427.sql" -Drm_427
      
      mysql -hxxx.xxx.xxx.1 -P<port> -u<username> -p<password> -e "source /home/admin/cm_427.sql" -Dcm_427
      
      mysql -hxxx.xxx.xxx.1 -P<port> -u<username> -p<password> -e "source /home/admin/cm_hb_427.sql" -Dcm_hb_427
      

   4. Restart the old container of OMS Community Edition V4.2.7.

      sudo docker restart ${CONTAINER_NAME}
      

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