Quick start
Saturn includes two parts, Saturn Console and Saturn Executor .
Saturn Console is a GUI, used for job/Executor management, statistical report display, system configuration and other functions. It is also the brain of the entire scheduling system: assign job tasks to each Executor.
Saturn Executor is a worker that performs tasks: according to the requirements of the job configuration, it executes the job scripts and codes deployed in the container or physical machine where the Executor is located.
In order to allow users to have a perceptual understanding of Saturn, we provide two methods to quickly start Console and Executor.
As for the deployment of the production environment, please refer to the following deployment guide.
1 One-click start
First, please make sure that the following software is installed on this machine:
- JDK 7 or JDK 8
- Maven 3.0.4+
- node.js 8.7.0+
- above sea level 5.4.2+
- docker (unlimited version)
Then, git clone this warehouse to the local, checkout the corresponding version branch, and enter the quickstartdirectory. If it is a Windows system, please run it quickstart.bat, if it is a Linux/Unix/MacOS system, please run it quickstart.sh.
$ git clone https://github.com/vipshop/Saturn
$ git checkout develop
$ cd saturn-docker
$ chmod +x quickstart.sh
$ ./quickstart.sh
The quickstart script will do the following:
- Start the embedded ZooKeeper
- Start the embedded Saturn-Console
- Start the embedded Saturn-Executor (contains the implementation of a Java job)
- Add the Java job in Saturn-Console
After the startup is complete, you can visit Saturn-Console: http://localhost:9088
If you see the following interface, congratulations, your console has been started.
Click on the search bar on the homepage and a namespace called'mydomain' will appear. Click to enter and you will see a job named'demoJavaJob'. The job has 5 shards and is scheduled every 5 seconds.
An executor called'executor-1' schedules the job.
2 Docker start
$ git clone https://github.com/vipshop/Saturn
$ git checkout develop
$ cd saturn-docker
$ chmod +x quickstart-docker.sh
$ ./quickstart-docker.sh
The quickstart-docker.sh script will do the following:
- Build a basic image based on OpenJDK7
- Build Saturn-Console image based on OpenJDK7
- Build Saturn-Executor image based on OpenJDK7
- Start a ZooKeeper cluster container
- Start a Saturn-Console container
- Start two Saturn-Executor containers
- Add a Java job and a Shell job
After the startup is successful, you can visit Saturn-Console: http://localhost:9088