Smoothly migrate Spring Cloud applications to SAE

1. Select an application

Start with underlying providers — services that have no upstream dependencies. If the call trace is complex or difficult to map, select any application to start.

2. Add dependencies and update configuration

a. Add the Nacos discovery dependency

Add spring-cloud-starter-alibaba-nacos-discovery to pom.xml:

<dependency>
    <groupId>org.springframework.cloud</groupId>
    <artifactId>spring-cloud-starter-alibaba-nacos-discovery</artifactId>
    <version>{Version}</version>
</dependency>

b. Configure the Nacos server address

Add the following to application.properties:

spring.cloud.nacos.discovery.server-addr=127.0.0.1:8848

c. Add the multi-registry migration dependency

By default, Spring Cloud allows only one registry. Adding a second registry causes an error. The edas-sc-migration-starter dependency removes this restriction and enables simultaneous registration with multiple registries.

Add it to pom.xml:

<dependency>
    <groupId>com.alibaba.edas</groupId>
    <artifactId>edas-sc-migration-starter</artifactId>
    <version>1.0.2</version>
</dependency>

3. Update the RibbonClients configuration

To subscribe to services from multiple registries, set @RibbonClients to use MigrationRibbonConfiguration in the main class.

Before:

@SpringBootApplication
public class ConsumerApplication {
    public static void main(String[] args) {
        SpringApplication.run(ConsumerApplication.class, args);
    }
}

After:

@SpringBootApplication
@RibbonClients(defaultConfiguration = MigrationRibbonConfiguration.class)
public class ConsumerApplication {
    public static void main(String[] args) {
        SpringApplication.run(ConsumerApplication.class, args);
    }
}

After deploying these changes — either on-premises or on SAE — you can control which registries the application registers with or subscribes to using Spring Cloud Config or Nacos Config, without restarting the application. For details, see Dynamically adjust service registration and subscription policies and Manage application configurations.

4. Deploy the application on SAE

Deploy the application based on your requirements. For details, see Deploy applications.

5. Verify the migration

Use either of the following methods:

Option 1: Check business behavior

Confirm that your business runs as expected after deployment.

Option 2: Check service subscription monitoring

If Spring Boot Actuator is enabled, access the following endpoint to view the RibbonServerList for each subscribed service. The serverGroup field in metaInfo shows which registry a node belongs to.

Remove migration dependencies

After all applications are on SAE, remove the original registry configuration and the edas-sc-migration-starter dependency.

Migrate SLB or update DNS settings

After migrating your applications, handle your SLB instance and domain name configuration:

SLB instance

Domain name

Migrate storage and message queues

If your application uses Alibaba Cloud services such as ApsaraDB RDS and Message Queue, you do not need to migrate storage or message queues. If your application is not deployed on Alibaba Cloud, join DingTalk group 32874633 for technical support.

Adjust the subscription policy

By default, SAE subscribes to and aggregates service data from all related registries.

To subscribe to specific registries only, set the spring.cloud.edas.migration.subscribes property:

# Subscribe to services from both Eureka and Nacos
spring.cloud.edas.migration.subscribes=nacos,eureka

# Subscribe to services from Nacos only
spring.cloud.edas.migration.subscribes=nacos

Adjust the registration policy

By default, SAE registers with all related registries.

To exclude specific registries, set the spring.cloud.edas.migration.registry.excludes property:

# Register with all registries (default — leave blank)
spring.cloud.edas.migration.registry.excludes=

# Disable registration with Eureka only
spring.cloud.edas.migration.registry.excludes=eureka

# Disable registration with Nacos and Eureka
spring.cloud.edas.migration.registry.excludes=nacos,eureka

Use SAE's configuration management feature to update this property at runtime without restarting your applications.