Microservices Engine:Migrate from ACM to MSE Nacos

Migrate Spring Cloud Alibaba applications

If your application is a Spring Cloud Alibaba application, modify the bootstrap.properties configuration file.

Replace the following content:

spring.cloud.nacos.config.endpoint=${ACM_PUBLIC/INTERNAL_ENDPOINT}

with:

spring.cloud.nacos.config.server-addr=${MSE_NACOS_PUBLIC/INTERNAL_ENDPOINT}

Also, update the namespace to your MSE Nacos namespace:

spring.cloud.nacos.config.namespace=${MSE_NACOS_NAMESPACE_ID}

For a runnable demo, see acm2nacos-spring-cloud-example.

To verify whether your application is a Spring Cloud Alibaba application:

Check the pom.xml file for the following dependency:

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

• You can find the public and internal endpoints of your MSE Nacos instance on its Basic Information page.

• The default namespace in MSE Nacos has no ID, so you can leave the parameter empty. If you use a non-default namespace, you can find its ID on the Namespaces page of your instance.

If you use a public endpoint for deployment, you must add the client IP addresses to the whitelist to ensure connectivity. Set a whitelist

Migrate Java applications

• If you use the ACM-Java-SDK, your pom.xml file contains the following dependency:

  <dependency>
      <groupId>com.alibaba.edas.acm</groupId>
      <artifactId>acm-sdk</artifactId>
  </dependency>

  To migrate, add the following JVM argument and redeploy the application.

  -DDIAMOND.SERVER.IPS=${MSE_NACOS_PUBLIC/INTERNAL_ENDPOINT}

  Also, modify the namespace setting in your code.

  properties.put("namespace", "${namespaceId}");

• If you use an ACM client and want to switch to a Nacos client, follow the instructions for migrating Nacos-Java-SDK users.

• If you use the Nacos-Java-SDK, your pom.xml file contains the following dependency:

<dependency>
  <groupId>com.alibaba.nacos</groupId>
  <artifactId>nacos-client</artifactId>
</dependency>

Replace the ${...} placeholder with the MSE public or internal endpoint and ${namespaceId} with the MSE namespace ID, then redeploy the application. If you use the default namespace, leave the namespace parameter empty.

properties.put("serverAddr", ${MSE_NACOS_PUBLIC/INTERNAL_ENDPOINT});
properties.put("namespace", "${namespaceId}");

Add the following argument at startup to complete the migration.

 -Dnacos.cache.data.init.snapshot=false

Migrate Golang applications

• If you use the ACM-golang-SDK, replace ${endpoint} with the public/internal endpoint of your MSE Nacos instance.

  clientConfig := constant.ClientConfig{
          Endpoint:       ${endpoint} + ":8080",
          NamespaceId:    namespaceId,
          AccessKey:      MSE_AK,
          SecretKey:      MSE_SK,
          TimeoutMs:      5 * 1000,
          ListenInterval: 30 * 1000,
      }

• If you use the Nacos-golang-SDK, replace ${serverAddr} with the public/internal endpoint of your MSE Nacos instance.

  sc := []constant.ServerConfig{
      {
      IpAddr: "${serverAddr}",
      Port:   8848,
      },
  }

Migrate Python applications

• If you use the ACM-Python-SDK, replace ${endpoint} with the public/internal endpoint of your MSE Nacos instance and ${namespace_id} with its namespace ID.

  ENDPOINT = "${endpoint}"
  NAMESPACE = "${namespace_id}"
  c = acm.ACMClient(ENDPOINT, NAMESPACE, AK, SK)

• If you use the Nacos-Python-SDK, replace ${server_address} with the public/internal endpoint of your MSE Nacos instance and ${namespace_id} with its namespace ID.

  SERVER_ADDRESSES = "${server_address}"
  NAMESPACE = "${namespace_id}"
  client = nacos.NacosClient(SERVER_ADDRESSES, namespace=NAMESPACE)

Migrate Node.js applications

• If you use the ACM-Nodejs-SDK, replace ${endpoint} with the public/internal endpoint of your MSE Nacos instance and ${namespace_id} with its namespace ID.

  // for find address mode
  const configClient = new NacosConfigClient({
    endpoint: '${endpoint}',
    namespace: '${namespace_id}',
    accessKey: 'MSE_AK',
    secretKey: 'MSE_SK',
    requestTimeout: 6000,
  });

• If you use the Nacos-Nodejs-SDK, replace ${server_address} with the public/internal endpoint of your MSE Nacos instance and ${namespace_id} with its namespace ID.

  const configClient = new NacosConfigClient({
    serverAddr: '${server_address}',
    namespace: '${namespace_id}',
    accessKey: 'MSE_AK',
    secretKey: 'MSE_SK',
    requestTimeout: 6000,
  });

Migrate C# applications

Replace ${server_address} with the public/internal endpoint of your MSE Nacos instance and ${namespace_id} with its namespace ID.

{
  "NacosConfig": {
    "Listeners": [
      {
        "Optional": false,
        "DataId": "common",
        "Group": "DEFAULT_GROUP"
      },
      {
        "Optional": false,
        "DataId": "demo",
        "Group": "DEFAULT_GROUP"
      }
    ],
    "Namespace": "namespace_id",  // Please set the value of Namespace ID.
    "ServerAddresses": [ "http://${server_address}:8848/" ],
    "UserName": "test2",
    "Password": "123456",
    "AccessKey": "MSE_AK",
    "SecretKey": "MSE_SK",
    "EndPoint": "acm.aliyun.com",
    "ConfigFilterAssemblies": ["YouPrefix.AssemblyName"],
    "ConfigFilterExtInfo": "some ext information"
  }
}

Migrate C++ applications

• If you use the ACM-CPP-SDK, replace ${endpoint} with the public/internal endpoint of your MSE Nacos instance and ${namespace_id} with its namespace ID.

  // Initializes the configuration service using the following parameters.
   ACM::init("${endpoint}","$namespace_id","$accessKey","$secretKey");

• If you use the Nacos-CPP-SDK, replace ${server_address} with the public/internal endpoint of your MSE Nacos instance.

  Properties props;
  props[PropertyKeyConst::SERVER_ADDR] = "${server_address}:8848";//Server address