docs: update README

This commit is contained in:
bigeagle 2016-04-29 22:09:55 +08:00
parent 4b52b9b53b
commit 5ef50090e9
No known key found for this signature in database
GPG Key ID: 9171A4571C27920A

View File

@ -12,35 +12,40 @@ tunasync
- Manager: Centural instance on status and job management - Manager: Centural instance on status and job management
- Worker: Runs mirror jobs - Worker: Runs mirror jobs
+------------+ +---+ +---+
+----------+ +---+ worker configs +---+ +----------+ +----------+ | Client API | | | Job Status | | +----------+ +----------+
| Status | | |+-----------------> | w +--->| mirror +---->| mirror | +------------+ | +----------------->| |--->| mirror +---->| mirror |
| Manager | | | | o | | config | | provider | +------------+ | | | w | | config | | provider |
+----------+ | W | start/stop job | r | +----------+ +----+-----+ | Worker API | | H | | o | +----------+ +----+-----+
| E |+-----------------> | k | | +------------+ | T | Job Control | r | |
+----------+ | B | | e | +------------+ | +------------+ | T +----------------->| k | +------------+ |
| Job | | | update status | r |<------+ mirror job |<----+ | Job/Status | | P | Start/Stop/... | e | | mirror job |<----+
|Controller| | | <-----------------+| | +------------+ | Management | | S | | r | +------^-----+
+----------+ +---+ +---+ +------------+ | | Update Status | | +---------+---------+
+------------+ | <------------------+ | | Scheduler |
| BoltDB | | | | | +-------------------+
+------------+ +---+ +---+
# Job Run Process # Job Run Process
PreSyncing Syncing Success
+-----------+ +-----------+ +-------------+ +--------------+ +-----------+ +-----------+ +-------------+ +--------------+
| pre-job +--+->| job run +--->| post-job +-+-->| post-success | | pre-job +--+->| job run +--->| post-exec +-+-->| post-success |
+-----------+ ^ +-----------+ +-------------+ | +--------------+ +-----------+ ^ +-----------+ +-------------+ | +--------------+
| | | |
| +-----------------+ | | +-----------------+ | Failed
+------+ post-fail |<---------+ +------+ post-fail |<---------+
+-----------------+ +-----------------+
``` ```
## TODO ## TODO
- [ ] split to `tunasync-manager` and `tunasync-worker` instances - [x] split to `tunasync-manager` and `tunasync-worker` instances
- [ ] use HTTP as communication protocol - [x] use HTTP as communication protocol
- [ ] implement manager as status server first, and use python worker - [x] implement manager as status server first, and use python worker
- [ ] implement go worker - [x] implement go worker
- Web frontend for `tunasync-manager` - Web frontend for `tunasync-manager`
- [ ] start/stop/restart job - [ ] start/stop/restart job
- [ ] enable/disable mirror - [ ] enable/disable mirror
@ -48,6 +53,7 @@ tunasync
- [ ] config file structure - [ ] config file structure
- [ ] support multi-file configuration (`/etc/tunasync.d/mirror-enabled/*.conf`) - [ ] support multi-file configuration (`/etc/tunasync.d/mirror-enabled/*.conf`)
## Generate Self-Signed Certificate ## Generate Self-Signed Certificate
Fisrt, create root CA Fisrt, create root CA