You are viewing a plain text version of this content. The canonical link for it is here.
Posted to notifications@shardingsphere.apache.org by zh...@apache.org on 2020/07/15 07:47:14 UTC
[shardingsphere-elasticjob] branch master updated: Update overview
(#1068)
This is an automated email from the ASF dual-hosted git repository.
zhangliang pushed a commit to branch master
in repository https://gitbox.apache.org/repos/asf/shardingsphere-elasticjob.git
The following commit(s) were added to refs/heads/master by this push:
new 4df6e8a Update overview (#1068)
4df6e8a is described below
commit 4df6e8ae846b22599b843a5e60b17a40a84e9888
Author: Liang Zhang <te...@163.com>
AuthorDate: Wed Jul 15 15:47:06 2020 +0800
Update overview (#1068)
* Update image URL
* Update overview
* Update readme
---
README.md | 80 ++-------------------
README_ZH.md | 79 ++------------------
docs/content/dev-manual/lite-design.cn.md | 4 +-
docs/content/overview/_index.cn.md | 45 ++++++++----
docs/content/overview/_index.en.md | 45 ++++++++----
docs/content/user-manual/dump.cn.md | 2 +-
docs/layouts/partials/logo.html | 2 +-
docs/static/img/architecture/elasticjob_cloud.png | Bin 0 -> 126749 bytes
.../{elastic_job_lite.png => elasticjob_lite.png} | Bin
.../static/img/{elastic-job.png => elasticjob.png} | Bin
10 files changed, 83 insertions(+), 174 deletions(-)
diff --git a/README.md b/README.md
index ea9e4b4..e04312e 100644
--- a/README.md
+++ b/README.md
@@ -1,6 +1,6 @@
# [ElasticJob - distributed scheduled job solution](http://shardingsphere.apache.org/elasticjob/)
-**Official website: http://shardingsphere.apache.org/elasticjob/**
+**Official website: https://shardingsphere.apache.org/elasticjob/**
[](https://starchart.cc/apache/shardingsphere-elasticjob-lite)
@@ -28,7 +28,11 @@ Welcome communicate with community via [mail list](mailto:dev@shardingsphere.apa
### ElasticJob Lite
-
+
+
+### ElasticJob Cloud
+
+
## Features
@@ -47,7 +51,7 @@ Welcome communicate with community via [mail list](mailto:dev@shardingsphere.apa
- Misfired
- Self diagnose and recover when distribute environment unstable
-- Job Dependency(TODO)
+- Job Dependency (TODO)
- DAG based job dependency
- DAG based job item dependency
@@ -60,73 +64,3 @@ Welcome communicate with community via [mail list](mailto:dev@shardingsphere.apa
- Job administration
- Job event trace query
- Registry center management
-
-## [Roadmap](ROADMAP.md)
-
-## Quick Start
-
-### Add maven dependency
-
-```xml
-<!-- import elastic-job lite core -->
-<dependency>
- <groupId>org.apache.shardingsphere.elasticjob</groupId>
- <artifactId>elasticjob-lite-core</artifactId>
- <version>${lasted.release.version}</version>
-</dependency>
-
-<!-- import other module if need -->
-<dependency>
- <groupId>org.apache.shardingsphere.elasticjob</groupId>
- <artifactId>elasticjob-lite-spring</artifactId>
- <version>${lasted.release.version}</version>
-</dependency>
-```
-### Job development
-
-```java
-public class MyElasticJob implements SimpleJob {
-
- @Override
- public void execute(ShardingContext context) {
- switch (context.getShardingItem()) {
- case 0:
- // do something by sharding item 0
- break;
- case 1:
- // do something by sharding item 1
- break;
- case 2:
- // do something by sharding item 2
- break;
- // case n: ...
- }
- }
-}
-```
-
-### Job configuration
-
-```xml
-<?xml version="1.0" encoding="UTF-8"?>
-<beans xmlns="http://www.springframework.org/schema/beans"
- xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
- xmlns:elasticjob="http://shardingsphere.apache.org/schema/elasticjob"
- xsi:schemaLocation="http://www.springframework.org/schema/beans
- http://www.springframework.org/schema/beans/spring-beans.xsd
- http://shardingsphere.apache.org/schema/elasticjob
- http://shardingsphere.apache.org/schema/elasticjob/elasticjob.xsd
- ">
- <!--configure registry center -->
- <elasticjob:zookeeper id="regCenter" server-lists="yourhost:2181" namespace="elastic-job" base-sleep-time-milliseconds="1000" max-sleep-time-milliseconds="3000" max-retries="3" />
-
- <!--configure job snapshot service -->
- <elasticjob:snapshot id="jobSnapshot" registry-center-ref="regCenter" dump-port="9999"/>
-
- <!--configure job class -->
- <bean id="simpleJob" class="xxx.MyElasticJob" />
-
- <!--configure job -->
- <elasticjob:simple id="oneOffElasticJob" job-ref="simpleJob" registry-center-ref="regCenter" cron="0/10 * * * * ?" sharding-total-count="3" sharding-item-parameters="0=A,1=B,2=C" />
-</beans>
-```
diff --git a/README_ZH.md b/README_ZH.md
index 9d73b6e..994c236 100644
--- a/README_ZH.md
+++ b/README_ZH.md
@@ -1,6 +1,6 @@
# [ElasticJob - 分布式作业调度解决方案](http://shardingsphere.apache.org/elasticjob/)
-**官方网站: http://shardingsphere.apache.org/elasticjob/**
+**官方网站: https://shardingsphere.apache.org/elasticjob/**
[](https://starchart.cc/apache/shardingsphere-elasticjob-lite)
@@ -26,7 +26,11 @@ ElasticJob 已于 2020 年 5 月 28 日成为 [Apache ShardingSphere](https://sh
### ElasticJob Lite
-
+
+
+### ElasticJob Cloud
+
+
## 功能列表
@@ -58,74 +62,3 @@ ElasticJob 已于 2020 年 5 月 28 日成为 [Apache ShardingSphere](https://sh
- 作业管控端
- 作业执行历史数据追踪
- 注册中心管理
-
-## [Roadmap](ROADMAP.md)
-
-## 快速入门
-
-### 引入maven依赖
-
-```xml
-<!-- 引入elasticjob-lite核心模块 -->
-<dependency>
- <groupId>org.apache.shardingsphere.elasticjob</groupId>
- <artifactId>elasticjob-lite-core</artifactId>
- <version>${latest.release.version}</version>
-</dependency>
-
-<!-- 使用springframework自定义命名空间时引入 -->
-<dependency>
- <groupId>org.apache.shardingsphere.elasticjob</groupId>
- <artifactId>elasticjob-lite-spring</artifactId>
- <version>${latest.release.version}</version>
-</dependency>
-```
-
-### 作业开发
-
-```java
-public class MyElasticJob implements SimpleJob {
-
- @Override
- public void execute(ShardingContext context) {
- switch (context.getShardingItem()) {
- case 0:
- // do something by sharding item 0
- break;
- case 1:
- // do something by sharding item 1
- break;
- case 2:
- // do something by sharding item 2
- break;
- // case n: ...
- }
- }
-}
-```
-
-### 作业配置
-
-```xml
-<?xml version="1.0" encoding="UTF-8"?>
-<beans xmlns="http://www.springframework.org/schema/beans"
- xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
- xmlns:elasticjob="http://shardingsphere.apache.org/schema/elasticjob"
- xsi:schemaLocation="http://www.springframework.org/schema/beans
- http://www.springframework.org/schema/beans/spring-beans.xsd
- http://shardingsphere.apache.org/schema/elasticjob
- http://shardingsphere.apache.org/schema/elasticjob/elasticjob.xsd
- ">
- <!--配置作业注册中心 -->
- <elasticjob:zookeeper id="regCenter" server-lists="yourhost:2181" namespace="elastic-job" base-sleep-time-milliseconds="1000" max-sleep-time-milliseconds="3000" max-retries="3" />
-
- <!--配置任务快照服务 -->
- <elasticjob:snapshot id="jobSnapshot" registry-center-ref="regCenter" dump-port="9999"/>
-
- <!--配置作业类 -->
- <bean id="simpleJob" class="xxx.MyElasticJob" />
-
- <!--配置作业 -->
- <elasticjob:simple id="oneOffElasticJob" job-ref="simpleJob" registry-center-ref="regCenter" cron="0/10 * * * * ?" sharding-total-count="3" sharding-item-parameters="0=A,1=B,2=C" />
-</beans>
-```
diff --git a/docs/content/dev-manual/lite-design.cn.md b/docs/content/dev-manual/lite-design.cn.md
index e602d50..92c27ab 100644
--- a/docs/content/dev-manual/lite-design.cn.md
+++ b/docs/content/dev-manual/lite-design.cn.md
@@ -70,8 +70,8 @@ leader节点是内部使用的节点，如果对作业框架原理不感兴趣
### 作业启动
-
+
### 作业执行
-
+
diff --git a/docs/content/overview/_index.cn.md b/docs/content/overview/_index.cn.md
index 7da861a..a8e6aaf 100644
--- a/docs/content/overview/_index.cn.md
+++ b/docs/content/overview/_index.cn.md
@@ -30,18 +30,39 @@ ElasticJob 已于 2020 年 5 月 28 日成为 [Apache ShardingSphere](https://sh
### ElasticJob Lite
-
+
+
+### ElasticJob Cloud
+
+
## 功能列表
-* 分布式调度协调
-* 弹性扩容缩容
-* 失效转移
-* 错过执行作业重触发
-* 作业分片一致性，保证同一分片在分布式环境中仅一个执行实例
-* 自诊断并修复分布式不稳定造成的问题
-* 支持并行调度
-* 支持作业生命周期操作
-* 丰富的作业类型
-* Spring 整合以及命名空间提供
-* 运维平台
+- 弹性调度
+ - 支持任务在分布式场景下的分片和高可用
+ - 能够水平扩展任务的吞吐量和执行效率
+ - 任务处理能力随资源配备弹性伸缩
+
+- 资源分配
+ - 在适合的时间将适合的资源分配给任务并使其生效
+ - 相同任务聚合至相同的执行器统一处理
+ - 动态调配追加资源至新分配的任务
+
+- 作业治理
+ - 失效转移
+ - 错过作业重新执行
+ - 自诊断修复
+
+- 作业依赖(TODO)
+ - 基于有向无环图（DAG）的作业间依赖
+ - 基于有向无环图（DAG）的作业分片间依赖
+
+- 作业开放生态
+ - 可扩展的作业类型统一接口
+ - 丰富的作业类型库，如数据流、脚本、HTTP、文件、大数据等
+ - 易于对接业务作业，能够与 Spring 依赖注入无缝整合
+
+- 可视化管控端
+ - 作业管控端
+ - 作业执行历史数据追踪
+ - 注册中心管理
diff --git a/docs/content/overview/_index.en.md b/docs/content/overview/_index.en.md
index aa4c4e0..d6e23e3 100644
--- a/docs/content/overview/_index.en.md
+++ b/docs/content/overview/_index.en.md
@@ -35,18 +35,39 @@ Welcome communicate with community via [mail list](mailto:dev@shardingsphere.apa
### ElasticJob Lite
-
+
+
+### ElasticJob Cloud
+
+
## Features
-* Distributed schedule job coordinate
-* Elastic scale in and scale out supported
-* Failover
-* Misfired jobs refire
-* Sharding consistently, same sharding item for a job only one running instance
-* Self diagnose and recover when distribute environment unstable
-* Parallel scheduling supported
-* Job lifecycle operation
-* Lavish job types
-* Spring integrated and namespace supported
-* Web console
+- Elastic Schedule
+ - Support job sharding and high availability in distributed system
+ - Scale out for throughput and efficiency improvement
+ - Job processing capacity is flexible and scalable with the allocation of resources
+
+- Resource Assign
+ - Execute job on suitable time and assigned resources
+ - Aggregation same job to same job executor
+ - Append resources to newly assigned jobs dynamically
+
+- Job Governance
+ - Failover
+ - Misfired
+ - Self diagnose and recover when distribute environment unstable
+
+- Job Dependency (TODO)
+ - DAG based job dependency
+ - DAG based job item dependency
+
+- Job Open Ecosystem
+ - Unify job api for extension
+ - Support rich job type lib, such as dataflow, script, HTTP, file, big data
+ - Focus business SDK, can work with Spring IOC
+
+- Admin Console
+ - Job administration
+ - Job event trace query
+ - Registry center management
diff --git a/docs/content/user-manual/dump.cn.md b/docs/content/user-manual/dump.cn.md
index 8757410..ac8aed1 100644
--- a/docs/content/user-manual/dump.cn.md
+++ b/docs/content/user-manual/dump.cn.md
@@ -66,7 +66,7 @@ dump 命令完全参照 Zookeeper 的四字命令理念
echo "dump@jobName" | nc <任意一台作业服务器IP> 9888
```
-
+
导出至文件
diff --git a/docs/layouts/partials/logo.html b/docs/layouts/partials/logo.html
index 056b4a0..7407616 100644
--- a/docs/layouts/partials/logo.html
+++ b/docs/layouts/partials/logo.html
@@ -1 +1 @@
-<img src="https://shardingsphere.apache.org/elasticjob/current/lite/img/elastic-job.png" />
\ No newline at end of file
+<img src="https://shardingsphere.apache.org/elasticjob/current/img/elasticjob.png" />
diff --git a/docs/static/img/architecture/elasticjob_cloud.png b/docs/static/img/architecture/elasticjob_cloud.png
new file mode 100755
index 0000000..24fb722
Binary files /dev/null and b/docs/static/img/architecture/elasticjob_cloud.png differ
diff --git a/docs/static/img/architecture/elastic_job_lite.png b/docs/static/img/architecture/elasticjob_lite.png
similarity index 100%
rename from docs/static/img/architecture/elastic_job_lite.png
rename to docs/static/img/architecture/elasticjob_lite.png
diff --git a/docs/static/img/elastic-job.png b/docs/static/img/elasticjob.png
similarity index 100%
rename from docs/static/img/elastic-job.png
rename to docs/static/img/elasticjob.png