Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

https://github.com/BinChengZhao/delicate

A lightweight and distributed task scheduling platform written in rust. （一个轻量的分布式的任务调度平台通过rust编写）
https://github.com/BinChengZhao/delicate

actix-web async cron crontab distributed-systems rust scheduler scheduling wip

Last synced: about 2 months ago
JSON representation

A lightweight and distributed task scheduling platform written in rust. （一个轻量的分布式的任务调度平台通过rust编写）

Lists

README 

        
# Delicate   

[![Build](https://github.com/BinChengZhao/delicate/workflows/CI/badge.svg)](

https://github.com/BinChengZhao/delicate/actions)

[![License](https://img.shields.io/badge/license-MIT%2FApache--2.0-blue.svg)](

https://github.com/BinChengZhao/delicate)

## English | [简体中文](./README_zhCN.md)



- [delicate](#delicate)

  - [What is delicate](#what-is-delicate)

  - [Features](#features)

  - [Benchmark](#benchmark)

  - [Get Started](#get-started)

    - [Setting up delicate](#setting-up-delicate)

  - [Quick start](#quick-start)

  - [Documentation](https://delicate-rs.github.io/Roadmap.html)

  - [Roadmap](#roadmap)

  - [Contributing](#contributing)

  - [License](#license)



## What is delicate



    delicate logo




`delicate` A lightweight and distributed task scheduling platform written in rust.:



## features

- **Friendly UI:** [Front-end] Convenient management of tasks & executors, monitoring their status and supporting manual maintenance etc.



- **Flexible Operations:** Flexible task operations, support for limiting the maximum number of parallelism in a single node, time zone settings corresponding to cron expressions, scheduling modes (single, fixed number, constantly repeating), the ability to manually trigger tasks at any time, manually terminate task instances, and view task logs online.



- **High Availability:**  Delicate supports unlimited horizontal expansion. It's easy to achieve high availability and performance by deploying as many Delicate servers and executors.



- **High Performance:** Lightweight and essential features speed up the performance, The basic resource overhead for `delicate` is roughly (less than 0.1% cpu usage, with about 10m of memory.)



- **Observability:**  There are many meaningful statistics periodically in a readable way.



- **Upgrade:**  Dynamic upgrade of the system (upgrade is done by obtaining the latest source code and performing database migration.



- **Reusability:**  Excutor provides `restful-api` that allows user applications to maintain custom tasks.



- **Permission Management:**  Permission management function based on casbin implementation, continuously optimize the experience.



The architecture of delicate:



![architecture](./doc/src/architecture.svg)

![topology](./doc/src/topology.svg)



## Project rendering



Click me



![](./doc/src/_media/dashboard.jpg)

![](./doc/src/_media/executor_create.jpg)

![](./doc/src/_media/executor_list.jpg)

![](./doc/src/_media/group_create.jpg)

![](./doc/src/_media/group_inner_bind.jpg)

![](./doc/src/_media/login_en.jpg)

![](./doc/src/_media/task_edit.jpg)

![](./doc/src/_media/task_list_operation.jpg)

![](./doc/src/_media/task_log_kill.jpg)

![](./doc/src/_media/task_log_logs_2.jpg)

![](./doc/src/_media/task_log_logs.jpg)

![](./doc/src/_media/user_list.jpg)



## Benchmark

Task take about 6,424 ns (+/- 52) per scheduling on CentOS Linux release 7.6.1810 (Core)  (varies by OS/hardware).



System: CentOS Linux release 7.6.1810 (Core) - 4cores/8G.



Single node: delicate-executor 



Task creation, peak cpu consumption 3%, qps: 17000+



Task cancellation, peak cpu consumption 3%, qps: 18000+



Task manual scheduling, peak cpu consumption 3.5%, qps: 14000+



Task removal, peak cpu consumption 3%, qps: 14000+



health_check, peak cpu consumption 4%, qps: 2600+



The peak memory consumption is all within 60M (varies by OS/hardware).



The rest of the overall indicators await bench.



## Get Started



The basic common usage of delicate is to quickly set up for the backend servers and executors. We split it into multiple simple steps to illustrate the delicate concepts and operations.



The source code installation requires:

 * [rustc](https://www.rust-lang.org/tools/install) (minimum-supported version of `rustc` is **1.54**.) 

 * libmysqlclient-dev & libpq-dev & libssl-dev



### Setting up delicate



1. install the rust suite: ` curl --proto '=https' --tlsv1.2 -sSf https://sh.rustup.rs | sh ` or ` curl --tlsv1.2 -sSf https://sh.rustup.rs | sh ` or `curl https://sh.rustup.rs -sSf | sh`  .  （It is possible to encounter a curl error and need to retry several times, These problems are usually due to the fact that the curl version is too low, or the network is unstable.）



2. initialize cargo in the current shell, ` source $HOME/.cargo/env ` .  



3. Get the delicate source code and compile it ( this is an example, please get the corresponding Tag version according to your needs ) : ` git clone https://github.com/BinChengZhao/delicate.git ` .



4. ` cd delicate/ ` .



5. ` cargo check ` , check for environment dependencies etc.



6. when error: linker `cc` not found: solution : ` yum -y install gcc ` .



7. when ` --- stderr thread 'main' panicked at 'Without `*` set in .env: NotPresent'` then you need to set the environment variable, using the project's  template.env ` .



8. ` cp template.env .env ` and start modifying the configuration. 



9. Compile the executable with ` cargo build --release ` after passing it.



10. Start delicate-scheduler: ` nohup target/release/delicate-scheduler >> scheduler.log 2>&1 &` on the machine where the server is deployed .



11. start delicate-executor: ` nohup target/release/delicate-executor >> executor.log 2>&1 & ` on the machine performing the task .



12. Please refer to `delicate-web/README.md` for the deployment of front-end resources.



13. `delicate-scheduler` & `delicate-web` need to be under the same domain (such as `api.delicate.com` & `web.delicate.com`), so as to avoid cross-domain issues, Both `delicate-scheduler` & `delicate-web` can be deployed in clustered versions, accessible via reverse proxy.



## Quick start

[Quick-start](./doc/src/quick_start.md)



## Documentation



See [reference](./doc/src/reference.md) for more information.



## To Do List

- [x] I18n (English & Chinese).

- [x] Permission Management.

- [ ] Multiple login protocols, LDAP CAS .

- [ ] Machine resource panel, online view of processes, memory, cpu, etc.

- [ ] Database back-end support Postgres.

- [ ]  `scheduler & executor` communication using RPC, but currently there are problems with dependencies (RPC framework (`tonic ｜ tarpc`) both depend on tokio 1,current actix-web stable version 3, does not support integration with tokio 1 ).

- [ ] Task flow support.

- [ ] Dynamic executor load adjustment, where the resource group adjusts the task load of the task execution nodes according to the machine metrics.



## Roadmap 



See [delicate Roadmap](./doc/src/Roadmap.md) for details.



## Contributing



:balloon: Thanks for your help improving the project! We are so happy to have

you! We have a contributing guide to help you get involved in the Delicate

project.



[Rust-guide](./CONTRIBUTING.md)

[Js-guide](./delicate-web/CONTRIBUTING.md)



## Thanks

Sincere thanks to my friend `Walker-os` who helped me solve a lot of front-end resource problems and speed up the release of delicate and `Liping Wang` help me beautify the logo.



# Stargazers over time



[![Stargazers over time](https://starchart.cc/BinChengZhao/delicate.svg)](https://starchart.cc/BinChengZhao/delicate)



## License



Licensed under either of



 * MIT license ([LICENSE-MIT](LICENSE-MIT) or http://opensource.org/licenses/MIT)



#### Contribution



Unless you explicitly state otherwise, any contribution intentionally submitted

for inclusion in the work by you, as defined in the Apache-2.0 license, shall be

dual licensed as above, without any additional terms or conditions.