Microservices Engine:Migrate application configurations from Apollo to MSE Nacos

How Apollo concepts map to Nacos

Apollo and Nacos organize configurations differently. Before you start, understand how the two models relate to each other.

Configurations in different Apollo environments can map to different Nacos instances or different namespaces within a single instance. Choose whichever approach fits your deployment model.

Step 1: Export configurations from Apollo

Export your Apollo configurations using one of the following methods.

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 exported file

Convert the exported file from Step 1 (.zip, .json, or .xlsx) to a format that MSE Nacos can import.

1. Download the format conversion tool:

      curl -O https://msesync.oss-cn-hangzhou.aliyuncs.com/ApolloConfigTransfer.jar

2. Run the conversion tool. Replace <exported-file-path> with the full path to the exported Apollo file:

      java -DsourceFilePath=<exported-file-path> -jar ApolloConfigTransfer.jar

3. After the tool finishes, a file named nacos_config_import_{original-filename}_{timestamp}.zip appears in the current directory. This file is ready for import.

Step 3: Import configurations into MSE 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 your Nacos instance.

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

4. Select the target namespace from the Namespace drop-down list.

5. Click Import Configuration and upload the .zip file from Step 2.

After the import completes, your Apollo configurations are available in MSE Nacos.

Step 4: Update the Maven dependency

Replace the Apollo client dependency with the Spring Cloud Alibaba Nacos Config starter in your pom.xml.

Before (Apollo):

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

After (Spring Cloud Alibaba Nacos):

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

Step 5: Update the application code

Apollo supports several dynamic configuration patterns. Replace each pattern with its Nacos equivalent as described below.

@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;
    }
}

// Apollo Config API
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");
}

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

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

Step 6: Switch the configuration endpoint

Replace the Apollo bootstrap configuration with the Nacos configuration endpoint.

Before (Apollo):

## Apollo configurations
# Environment: -Dappllo.env={env}
apollo.meta=http://127.0.0.1:8070
apollo.bootstrap.enabled=true
# Namespaces to load
apollo.bootstrap.namespaces=application,namespace1
# Cluster
apollo.bootstrap.cluster=default
# Application ID
app.id=app1

After (Nacos):

# Import specific configurations by dataId and group
spring.config.import[0]=nacos:app1.application.properties?group=default&refreshEnabled=true
spring.config.import[1]=nacos:app1.namespace1.properties?group=default&refreshEnabled=true

# MSE Nacos endpoint
spring.cloud.nacos.config.server-addr=mse-xxx-p.nacos-ans.mse.aliyuncs.com

# MSE Nacos namespace (use the namespace ID from the MSE console)
spring.cloud.nacos.config.namespace=<namespace-id>

Replace the following placeholders with your actual values:

After you update the configuration, restart the application.

Verify the migration

After the application restarts, verify that the migration succeeded:

1. Check configuration loading: Review the application startup logs. Confirm that configurations load from the Nacos endpoint without errors.

2. Validate dynamic refresh: Change a configuration value in the MSE Nacos console. Verify that the application picks up the new value without a restart.

3. Test application behavior: Run your functional test suite. Confirm that the application behaves as expected with the migrated configurations.