Microservices Engine:Migrate applications from Application Configuration Management to MSE Nacos instances

Spring Cloud Alibaba applications

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

Replace

spring.cloud.nacos.config.endpoint=${Public or internal endpoint of Application Configuration Management}

With

spring.cloud.nacos.config.server-addr=${Public or internal endpoint of your MSE Nacos instance}

Specify the ID of a namespace in your MSE Nacos instance in the following configuration:

spring.cloud.nacos.config.namespace =${ID of a namespace in your MSE Nacos instance}

For more information about the sample demo, see acm2nacos-spring-cloud-example.

You can use the following method to check whether your application is a Spring Cloud Alibaba application:

If the following dependency is found in your pom.xml file, your application is a Spring Cloud Alibaba application.

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

• You can obtain the public or internal endpoint of your MSE Nacos instance from the Basic Information page of the instance.

• If you use the default namespace, the namespace does not have an ID. In this case, you can leave the namespace ID empty. If your destination namespace has an ID, you can obtain the namespace ID from the Namespace page of your MSE Nacos instance in the MSE console.

If you want to access the MSE Nacos instance over the Internet, you must add the public IP address of your client to the public IP address whitelist of your MSE Nacos instance to ensure connectivity.

Java applications

• If ACM-Java-SDK is used, the following dependency exists in your pom.xml file.

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

  In this case, you can directly add the following parameter to the JVM runtime parameters and redeploy your application to complete the migration.

  -DDIAMOND.SERVER.IPS=${Public or internal endpoint of your MSE Nacos instance}

  Modify the namespace information in the code.

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

• If you want to use the Nacos client instead of the Application Configuration Management client after the migration, follow the subsequent instructions.

• If Nacos-Java-SDK is used, the following dependency exists in your pom.xml file:

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

In this case, you can set ${} in the following code to the registered endpoint of your MSE Nacos instance, set {namespaceId} to the namespace ID of your MSE Nacos instance, and then redeploy your application to complete the migration. If the default namespace is used, leave {namespaceId} empty.

properties.put("serverAddr", ${Public or internal endpoint of your MSE Nacos instance});
properties.put("namespace", "{namespaceId}");

When you start your application, add the following parameter to complete the migration.

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

Golang applications

• If ACM-golang-SDK is used, you must set ${endpoint} to the registered 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 Nacos-golang-SDK is used, you must set ${serverAddr} to the registered endpoint of your MSE Nacos instance.

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

Python applications

• If ACM-Python-SDK is used, you must set ${endpoint} to the registered endpoint of your MSE Nacos instance and ${namespace_id} to the namespace ID of your MSE Nacos instance.

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

• If Nacos-Python-SDK is used, you must set ${server_address} to the registered endpoint of your MSE Nacos instance and ${namespace_id} to the namespace ID of your MSE Nacos instance.

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

Node.js applications

• If ACM-Nodejs-SDK is used, you must set ${endpoint} to the registered endpoint of your MSE Nacos instance and ${namespace_id} to the namespace ID of your MSE Nacos instance.

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

• If Nacos-Nodejs-SDK is used, you must set ${server_address} to the registered endpoint of your MSE Nacos instance and ${namespace_id} to the namespace ID of your MSE Nacos instance.

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

C# applications

Set ${server_address} to the registered endpoint of your MSE Nacos instance and namespace_id to the namespace ID of your MSE Nacos instance.

{
  "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 infomation"
  }
}

C++ applications

• If ACM-CPP-SDK is used, you must set ${endpoint} to the registered endpoint of your MSE Nacos instance and $namespace_id to the namespace ID of your MSE Nacos instance.

  // Initialize configuration service and the console will retrieve the following parameters through the sample code.
   ACM::init("${endpoint}","$namespace_id","$accessKey","$secretKey");

• If Nacos-CPP-SDK is used, you must set ${server_address} to the registered endpoint of your MSE Nacos instance.

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