1. Execute the following command to compile and generate the ShardingSphere-Scaling binary package:
git clone;
cd shardingsphere;
mvn clean install -Prelease;

The binary package’s directory is:/shardingsphere-distribution/shardingsphere-scaling-distribution/target/apache-shardingsphere-${latest.release.version}-shardingsphere-scaling-bin.tar.gz

  1. Unzip the distribution package, modify the configuration file conf/server.yaml, we should ensure the port does not conflict with others, and modify the resume from break-point(optional) server lists:
port: 8888
blockQueueSize: 10000
workerThread: 30

  name: scalingJob
    type: ZooKeeper
    serverLists: localhost:2181
      retryIntervalMilliseconds: 10000
  1. Start up ShardingSphere-Scaling:
sh bin/
  1. See the log file logs/stdout.log,ensure startup successfully.

  2. Ensure startup successfully by curl.

curl -X GET http://localhost:8888/scaling/job/list



Shutdown ShardingSphere-Scaling

sh bin/


The existing configuration items are as follows, We can modify them in conf/server.yaml

Name Description Default value
port Listening port of HTTP server 8888
blockQueueSize Queue size of data transmission channel 10000
workerThread Worker thread pool size, the number of migration task threads allowed to run concurrently 30
resumeBreakPoint Resume from break-point service