Skip to content
Nacos 配置中心安全问题汇总及解决方案 Know more

NacosSync user guide

NacosSync migration user guide

Guide purposes

  • Understand NacosSync service
  • Start NacosSync service
  • By a simple example, demonstrates how to register to the Zookeeper Dubbo client migrated to Nacos.


  • NacosSync is a support for a variety of registry of synchronous components,based on the Spring boot development framework,Data layer uses the Spring Data JPA,follow the standard JPA access codes,support for multiple data storage,Default to Hibernate implementation, support table created automatically update more conveniently.
  • Using efficient event driven asynchronous model, support a variety of custom events, make the synchronization task processing time delay control in 3s, 8C16G stand-alone can support 6 k synchronization tasks.
  • NacosSync in addition to the standalone deployment, but also provides high availability cluster deployment patterns, NacosSync is stateless design, such as task status data migration to the database, the cluster expansion is very convenient.
  • Abstraction is out of Sync core component interface, through annotations to distinguish synchronous type, allowing developers to easily according to their own needs, different registry to expand, has now supports synchronous type:
    • Nacos to Nacos data synchronization
    • Zookeeper to Nacos data synchronization
    • Nacos to the Zookeeper data synchronization
    • Eureka to Nacos data synchronization
    • Consul to Nacos data synchronization

System module architecture:

The console
Provides concise Web console operation, support for internationalization.

Synchronization task management page

Registry management page


Usage scenarios:

  • Multiple network communication between the Region of Shared services, break the service call restriction of the Region.


  • Two-way synchronization function, support Dubbo + Zookeeper service smooth migration to Dubbo + Naocs, enjoy Nacos more high quality service.



Preparatory work

Before you start the service, you need to install the following services:

Get the installation package

There are two ways to obtain NacosSync installation package:

  • Direct download NacosSync binary installation package:nacosSync.${version}.zip
  • Download NacosSync source to build from the Github


cd nacosSync/
mvn clean package -U

The path of the target file:


Unpack the installation package, project file directory structure:

├── bin
│   ├── nacosSync.sql
│   ├──
│   └──
├── conf
│   ├──
│   └── logback-spring.xml
├── logs
└── nacosSync-server.${version}.jar

Initialize the database

The system default configuration database is Mysql, can also support other relational database. 1.The database construction, the default database name for “nacos_Sync”. 2.The database table don’t need to create separately, using the hibernate automatically by default build table function. 3.If you do not support automatic table, you can use the system’s own build table SQL script, the script in the bin directory.

Database configuration

Database configuration file on conf/


Start server

Terminal window
$ nacosSync/bin:
sh restart

Check system status

1.Check system log

The path of the log in nacosSync/logs/nacosSync.log, check whether there are abnormal information.

2.Check system port

Port is the default system 8081, you can define your own

Terminal window
$netstat -ano|grep 8081
tcp 0 0* LISTEN off (0.00/0/0)


Access path:


If there is no problem, check NacosSync has begun, normal NacosSync deployment structure:image.png

Starting migration

Migration information

Dubbo service deployment information:image.png

The migration of services:

Service NameVersionGroup Name

Add the registry cluster information

1.Click on the “cluster configuration” button in the left navigation bar, a new cluster, first add a Zookeeper cluster, select the cluster type for ZK. image.png

Note: the cluster name can customize, but once confirmed, cannot be modified, otherwise increase task based on the cluster, after NacosSync restart, success will not resume.

2.The same steps, increase Nacos cluster. image.png

3.After the completion of the add, can inquire on the list: image.png

Add the synchronization task

  1. Add a sync task, from Zookeeper cluster synchronization to Nacos cluster, synchronous granularity is service, it is called a Zookeeper cluster source cluster, Nacos cluster called target cluster. imagesd.png

Add finished, can be in service sync list, view has add synchronization task: image.png

  1. The synchronization is completed, check whether the data synchronization to success Nacos cluster, can query through the Nacos console. image.png

  2. At the moment, the data has been successfully from Zookeeper cluster synchronization to Nacos cluster, the deployment structure is as follows: image.png

Dubbo clients to connect to Nacos registry

Dubbo Consumer client migration

Dubbo has supported Nacos registry, support version 2.5 +, need to add a Nacos registry of Dubbo extensions depends on:


Increase Nacos client depends on:


Configuration Dubbo Consumer Dubbo profile Consumer. The yaml, let the client can find Nacos cluster.

name: dubbo-consumer
version: 1.0.0
group: zk
address: nacos://

Don’t need to modify the code, configuration after the update, you can restart your application into law.

Consumer release is completed, the deployment of the structure is as follows: image.png

Dubbo Provider migration

Before you upgrade the Provider, you need to ensure that the Provider of services, are already configured in NacosSync, synchronous way from Nacos synchronization to Zookeeper, because the Provider connected to Nacos upgrade, you need to make sure that the old Dubbo Consumer client can subscribe to the Provider’s address in the Zookeeper, now, we add a sync task: image.png


Note: Nacos synchronization to the Zookeeper service, do not need to fill in the version number, you in choosing the source cluster, the version number of the input box automatically hidden.

Sync task is completed, you can upgrade the Provider, upgrade the Provider method, reference to upgrade the Consumer steps.

New deployment structure

  • In the process of upgrading, there will be new and old versions of the client at the same time, the deployment structure is as follows:


  • All client migration is completed, the deployment structure is as follows:


Now, the Zookeeper cluster, NacosSync cluster can get offline.


  • Synchronization task after adding, you need to ensure that the service is successful sync to the target cluster, can through the console the target cluster.
  • NacosSync support high availability cluster pattern deployment, you only need to put the database can be configured to the same.
  • Comb if not clear subscription and published service, suggested can do services are two-way synchronous.
  • Dubbo client currently does not support Nacos weighting function, if you are using the weight function, need to reconsider the plan.