Upgrade OMS Community Edition in single-node deployment mode

This topic describes how to upgrade OceanBase Migration Service (OMS) to V3.3.1-CE in single-node deployment mode.

Upgrade procedure

1. Back up the databases.

   1. Suspend the container of OMS Community Edition V3.3.0-CE and record the time T1.

      sudo docker stop ${CONTAINER_NAME}
      

      Notice:

      CONTAINER_NAME specifies the name of the container.

   2. Log on to the cluster management (CM) heartbeat database specified in the configuration file and delete some useless records to reduce the backup time.

      # Log on to the CM heartbeat database specified in the configuration file.
      mysql -hxxx.xxx.xxx.1 -P<port> -u<username> -p<password> -Dcm_hb_330
      
      # Delete useless records.
      # Obtain the auto-increment ID from heatbeat_sequence, which reports the heartbeat.
      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_330 > /home/admin/rm_330.sql
      
      mysqldump -hxxx.xxx.xxx.1 -P<port> -u<username> -p<password> --triggers=false cm_330 > /home/admin/cm_330.sql
      
      mysqldump -hxxx.xxx.xxx.1 -P<port> -u<username> -p<password> --triggers=false cm_hb_330 > /home/admin/cm_hb_330.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_330, cm_330, and cm_hb_330	Specify 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.

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

   docker load -i <Storage path of the OMS image>
   

3. Start a new container for OMS Community Edition V3.3.1.

   You can access the OMS Community Edition console by using an HTTP or HTTPS URL. To securely access the OMS Community Edition 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 Community Edition V3.3.1-CE, make sure that the three disk mounting 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 paths.

   • The -e IS_UPGRADE=true parameter is provided in OMS Community Edition V3.3.1-CE. This parameter is provided only to support OMS Community Edition upgrade and must be specified when you upgrade OMS Community Edition.

   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.
   IMAGE_TAG	The tag of the image in the feature_x.x.x-ce format.
   /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 Community Edition is deployed. The mount directories store the logs generated during the operating 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 Community Edition container. If you mount an SSL certificate, the NGINX service in the OMS Community Edition container runs in HTTPS mode. In this case, you can access the OMS Community Edition console by using only the HTTPS URL.
   IS_UPGRADE	To upgrade OMS Community Edition, 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.

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.

   bash /root/docker_init.sh
   

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

6. After the docker_init.sh script is executed, confirm whether the server list is normal and whether all servers are in the Online state.

   1. Log on to the OMS Community Edition 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.

7. Optional. To roll back, perform the following steps:

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

      sudo docker stop ${CONTAINER_NAME}
      

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

      drop database rm_330;
      drop database cm_330;
      drop database cm_hb_330;
      
      create database rm_330;
      create database cm_330;
      create database cm_hb_330;
      

   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_330.sql" -Drm_330
      
      mysql -hxxx.xxx.xxx.1 -P<port> -u<username> -p<password> -e "source /home/admin/cm_330.sql" -Dcm_330
      
      mysql -hxxx.xxx.xxx.1 -P<port> -u<username> -p<password> -e "source /home/admin/cm_hb_330.sql" -Dcm_hb_330
      

   4. Restart the old container of OMS Community Edition V3.3.0.

      sudo docker restart ${CONTAINER_NAME}
      

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