# Saturn

**Repository Path**: bitters/Saturn

## Basic Information

- **Project Name**: Saturn
- **Description**: saturn
- **Primary Language**: Unknown
- **License**: Apache-2.0
- **Default Branch**: master
- **Homepage**: None
- **GVP Project**: No

## Statistics

- **Stars**: 0
- **Forks**: 3
- **Created**: 2017-02-28
- **Last Updated**: 2021-06-05

## Categories & Tags

**Categories**: Uncategorized

**Tags**: None

## README

# ![logo](https://github.com/vipshop/Saturn/blob/doc/saturn-logo.jpg)

[![Build Status](https://secure.travis-ci.org/vipshop/Saturn.png?branch=develop)](https://travis-ci.org/vipshop/Saturn)

## Special thanks

Saturn is originated from Dangdang's [elastic job](https://github.com/dangdangdotcom/elastic-job), we enhance it according to our requirement and understandings. Special thanks to Zhang Liang@dangdang who give us a lot of help and suggestions.

The product roadmap refer to [RoadMap](https://github.com/vipshop/Saturn/wiki/Saturn-Roadmap-CN)

WeChat Group: Please add group owner named `duffqiu` to join us!

## 1 Product Description

The VIP's distributed job schedule platform. It supports java and shell jobs with sharding, tolerance, high availability...

### 1.1 Feature Map

- see [Amazing Feature Destription](https://github.com/vipshop/Saturn/wiki/Saturn-Amazing-Feature-Description)

### 1.2 User Guide
- see [Quick Start Guide](https://github.com/vipshop/Saturn/wiki/Quick-Start)
- see [Quick Start with Docker Container](https://github.com/vipshop/Saturn/wiki/Quick-Start---Docker)
- see [User Guide CN](https://github.com/vipshop/Saturn/wiki/%E4%BD%BF%E7%94%A8%E6%8C%87%E5%BC%95(%E5%AE%8C%E6%95%B4))


## 2 System Design

### 2.1 Entity Model
see [Entity Model](https://github.com/vipshop/Saturn/wiki/Saturn-Entity-Model)

### 2.2 Artichecture
see [Architecture Description CN](https://github.com/vipshop/Saturn/wiki/Saturn%E6%9E%B6%E6%9E%84%E6%96%87%E6%A1%A3)

## 3 Production Development Guide
### 3.1  Development Guide for Java
- see [Development Guide for Java CN](https://github.com/vipshop/Saturn/wiki/saturn%E5%BC%80%E5%8F%91%E6%8C%87%E5%BC%95%E4%B9%8Bjava)
- see [Development Guide for Shell CN](https://github.com/vipshop/Saturn/wiki/saturn%E5%BC%80%E5%8F%91%E6%8C%87%E5%BC%95%E4%B9%8Bshell)

## 4 Operation
### 4.1 Gray Upgrade
- see [Gray Upgrade Process](https://github.com/vipshop/Saturn/wiki/Saturn-Job-Gray-Upgrade-Process)

### 4.2 Production Deployment Guide
- see [Console Deployment](https://github.com/vipshop/Saturn/wiki/saturn部署文档之console)
- see [Executor Deployment](https://github.com/vipshop/Saturn/wiki/Saturn部署文档之executor)

## 5 The team

[The Saturn Wow Team](https://github.com/vipshop/Saturn/wiki/Saturn's-Wow-Team)

## 6 Powered by Saturn

[Organizations using Saturn](https://github.com/vipshop/Saturn/wiki/Organizations-using-Saturn)

## 7 Presentation

[All Meetup Materials](https://github.com/vipshop/Saturn/wiki/Presentation)