Updated on 2022-09-23 GMT+08:00

Migrating Metadata

Scenario

On the console, you can migrate RocketMQ metadata from another cloud or self-hosted RocketMQ to your DMS RocketMQ instance.

Prerequisites

A RocketMQ instance has been purchased.

Step 1: Obtain RocketMQ Metadata from Another Cloud or Self-Hosted RocketMQ

  1. Go to the RocketMQ installation directory and query the cluster name with the following command:

    sh ./bin/mqadmin clusterList -n {nameserver address and port number}

    For example, if the nameserver address and port number are 192.168.0.65:8100, run the following command:

    sh ./bin/mqadmin clusterList -n 192.168.0.65:8100

  2. Run the following command to export metadata:

    sh ./bin/mqadmin exportMetadata -n {nameserver address and port number} -c {RocketMQ cluster name} -f {Path for storing the exported metadata file}

    For example, if the nameserver address and port number are 192.168.0.65:8100, the RocketMQ cluster name is DmsCluster, and the path for storing exported metadata files is /tmp/rocketmq/export, run the following command:

    sh ./bin/mqadmin exportMetadata -n 192.168.0.65:8100 -c DmsCluster -f /tmp/rocketmq/export

Step 2: Migrate Metadata on the Console

  1. Log in to the DMS for RocketMQ console.
  2. Click a RocketMQ instance to go to the instance details page.
  3. In the navigation pane, choose Metadata Migration.
  4. Click Create Migration Task.
  5. Configure the migration task by referring to Table 1.

    Table 1 Migration task parameters

    Parameter

    Description

    Task Name

    Unique name of the migration task.

    Overwrite

    • If this option is enabled, configurations in the metadata file with the same name as the uploaded file will be modified.

      Assume that Topic01 on the source instance has three read queues, and Topic01 on the DMS instance has two read queues. If Overwrite is enabled, Topic01 on the DMS instance will have three read queues after migration.

    • If this option is disabled, migration of the metadata file with the same name as the uploaded file will fail.

      Assume that the source instance has Topic01 and Topic02, and the DMS instance has Topic01 and Topic03. If Overwrite is disabled, migration of the source Topic01 will fail.

    Metadata

    Upload the RocketMQ metadata obtained from another cloud or self-hosted RocketMQ.

  6. Click OK.

    After the migration is complete, view Task Status in the migration task list.

    • If Task Status is Complete, all metadata has been successfully migrated.
    • If Task Status is Failed, some or all metadata fails to be migrated. Click the migration task name to go to the migration task details page. In the Migration Result area, view the name of the topic or consumer group that fails to be migrated and the failure cause.
      Figure 1 Migration result