Microservices Engine:Migrate application configurations from an Apollo configuration center to an MSE Nacos configuration center

Migration description

The following table describes the parameters of the Apollo model and the MSE Nacos model.

In this topic, all configurations in a single Apollo environment are migrated as files to a Nacos namespace based on the following mapping rules:

• Configurations in different Apollo environments can be mapped to different Nacos instances or different namespaces of a Nacos instance. You can use one of the mapping methods based on your business requirements.

• The cluster parameter of Apollo is mapped to the group parameter of Nacos. The {appId}.{namespace}.{format} configuration of Apollo is mapped to the dataId parameter of Nacos.

• The appId parameter of Apollo is mapped to the appName parameter of Nacos.

Step 1: Export Apollo configurations

select distinct  a.NamespaceId,b.NamespaceName,c.`Comment` AS 'NamespaceDesc' ,b.AppId,b.ClusterName,a.Key,a.Type ,a.Value,a.Comment,a.LineNum from ITEM a left join Namespace b on a.NamespaceId=b.id  left join AppNamespace c on c.Name=b.NamespaceName where a.IsDeleted=0 order by a.NamespaceId,a.LineNum ;

Step 2: Convert the file format

After you export the Apollo configurations, you can obtain a .zip, .json, or .xlsx file. You must convert the file format to a format that can be directly imported to Nacos in the MSE console.

1. Run the following command to download the file format conversion tool: curl -O https://msesync.oss-cn-hangzhou.aliyuncs.com/ApolloConfigTransfer.jar.

2. Run the following command to execute the conversion program: java -DsourceFilePath={Full path of the exported Apollo file} -jar ApolloConfigTransfer.jar.

3. After the program is executed, a file named nacos_config_import_{Exported Apollo file name}_{Timestamp}.zip is available in the current directory.

Step 3: Import the file to Nacos

1. Log on to the MSE console, and select a region in the top navigation bar.

2. In the left-side navigation pane, choose Microservices Registry > Instances. Click the name of the instance.

3. In the left-side navigation pane, choose Configuration Management > Configurations.

4. On the page that appears, select a namespace from the Namespace drop-down list and click Import Configuration. In the Import Configuration dialog box, upload the file obtained in Step 2.

   Note

   After you perform the preceding operations, the configurations are migrated from Apollo to Nacos.

Step 4: Change the dependency

Change the dependency of Apollo to the dependency of Spring Cloud Alibaba in the application project.

<dependency>
    <groupId>com.ctrip.framework.apollo</groupId>
    <artifactId>apollo-client</artifactId>
    <version>{apollo.version}</version>
</dependency>

<dependency>
    <groupId>com.alibaba.cloud</groupId>
  <artifactId>spring-cloud-starter-alibaba-nacos-config</artifactId>
    <version>2.2.10</version>
</dependency>

Step 5: Modify the code

Applications support the following Apollo dynamic configuration methods. You can modify the related code based on the descriptions in this section.

@RestController
@RefreshScope
public class DemoController {
    
    @Value("testKey")
    String testKey = "value";

    
    @RequestMapping("/valuekey")
    public String getNacosTestKey() {
        return testKey;
    }
}

@Configuration
@ConfigurationProperties
public class CNStackInfoConfig {
    
    private String name;

    private int customerCount;


    public String getName() {
        return name;
    }

    public void setName(String name) {
        this.name = name;
    }

    public int getCustomerCount() {
        return customerCount;
    }

    public void setCustomerCount(int customerCount) {
        this.customerCount = customerCount;
    }
}

ConfigService.getAppConfig().getProperty("testkey", "defaulyv1");
ConfigService.getAppConfig("namespace").getProperty("testkey", "defaulyv1");

@NacosConfig(dataId="appId1.application.properties",group="group") 
Properties nacosConfigProperties;

private void method() {
    String value=nacosConfigProperties.getProperty("key","defaultValue");
}

    /**
     * notify listener
     * @param configChangeEvent
     */
    @ApolloConfigChangeListener(interestedKeyPrefixes = {"data."})
    public void apolloNotify(ConfigChangeEvent configChangeEvent) {
        System.out.println(configChangeEvent.changedKeys());
    }
    

@NacosConfigKeysListener(dataId="appId1.application.properties",group="group",interestedKeyPrefixes = {"data."})
public void apolloNotify(ConfigChangeEvent configChangeEvent) {
    System.out.println(configChangeEvent.changedKeys()); 
}

Step 6: Change the endpoint

1. Add Nacos configurations to the project code.

   ## Original Apollo configurations 
   # Environment-Dappllo.env={env}
   apollo.meta=http://127.0.0.1:8070
   apollo.bootstrap.enabled=true
   # Specify the namespace to which you want to add the configurations.
   apollo.bootstrap.namespaces=application,namespace1
   # Specify the cluster.
   apollo.bootstrap.cluster=default
   # Specify the ID of the application.
   app.id=app1

   Change the endpoint to the Nacos endpoint.

   # Specify dataId and group of the configurations that you added.
   spring.config.import[0]=nacos:app1.application.properties?group=default&refreshEnabled=true
   spring.config.import[1]=nacos:app1.namespace1.properties?group=default&refreshEnabled=true
   # Specify the MSE Nacos endpoint.
   spring.cloud.nacos.config.server-addr=mse-xxx-p.nacos-ans.mse.aliyuncs.com
   # Specify the MSE Nacos namespace.
   spring.cloud.nacos.config.namespace={Namespace ID that corresponds to the specified environment of the MSE Nacos configuration center, such as 5babe1ee-1352-xxxx-bd7b-7e7ce892e2ab}

2. Restart the service.