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 09:25:15 UTC
[shardingsphere-elasticjob] branch master updated: Update structure
of user manual (#1071)
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 581b663 Update structure of user manual (#1071)
581b663 is described below
commit 581b663a10dd8032d03ce37e2b1d05892b03c43c
Author: Liang Zhang <te...@163.com>
AuthorDate: Wed Jul 15 17:25:09 2020 +0800
Update structure of user manual (#1071)
* Update structure of user manual
* Update structure of cloud user manual
---
docs/content/user-manual/_index.cn.md | 15 +--
docs/content/user-manual/_index.en.md | 2 +-
.../_index.cn.md} | 2 +-
.../_index.en.md} | 2 +-
.../elasticjob-cloud/deploy-guide.cn.md | 47 +++++++
.../{ => elasticjob-cloud}/deploy-guide.en.md | 4 +-
.../user-manual/elasticjob-cloud/dev-guide.cn.md | 138 ++++++++++++++++++++
.../user-manual/elasticjob-cloud/dev-guide.en.md | 8 ++
.../elasticjob-cloud/high-availability.cn.md | 23 ++++
.../elasticjob-cloud/high-availability.en.md | 8 ++
.../elasticjob-cloud/local-executor.cn.md | 35 +++++
.../elasticjob-cloud/local-executor.en.md | 8 ++
.../user-manual/elasticjob-cloud/restful-api.cn.md | 145 +++++++++++++++++++++
.../user-manual/elasticjob-cloud/restful-api.en.md | 8 ++
.../user-manual/elasticjob-cloud/web-console.cn.md | 26 ++++
.../{ => elasticjob-cloud}/web-console.en.md | 4 +-
.../_index.cn.md} | 2 +-
.../_index.en.md} | 2 +-
.../{ => elasticjob-lite}/customized-hook.cn.md | 2 +-
.../{ => elasticjob-lite}/customized-hook.en.md | 2 +-
.../{ => elasticjob-lite}/deploy-guide.cn.md | 2 +-
.../{ => elasticjob-lite}/deploy-guide.en.md | 2 +-
.../user-manual/{ => elasticjob-lite}/dump.cn.md | 2 +-
.../user-manual/{ => elasticjob-lite}/dump.en.md | 2 +-
.../{ => elasticjob-lite}/event-trace.cn.md | 2 +-
.../{ => elasticjob-lite}/event-trace.en.md | 2 +-
.../{ => elasticjob-lite}/execution-monitor.cn.md | 2 +-
.../{ => elasticjob-lite}/execution-monitor.en.md | 2 +-
.../{ => elasticjob-lite}/job-api.cn.md | 2 +-
.../{ => elasticjob-lite}/job-api.en.md | 2 +-
.../{ => elasticjob-lite}/job-config.cn.md | 2 +-
.../{ => elasticjob-lite}/job-config.en.md | 2 +-
.../{ => elasticjob-lite}/job-listener.cn.md | 2 +-
.../{ => elasticjob-lite}/job-listener.en.md | 2 +-
.../{ => elasticjob-lite}/job-reconcile.cn.md | 2 +-
.../{ => elasticjob-lite}/job-reconcile.en.md | 2 +-
.../job-sharding-strategy.cn.md | 2 +-
.../job-sharding-strategy.en.md | 2 +-
.../{ => elasticjob-lite}/operation-manual.cn.md | 2 +-
.../{ => elasticjob-lite}/operation-manual.en.md | 2 +-
.../{ => elasticjob-lite}/web-console.cn.md | 2 +-
.../{ => elasticjob-lite}/web-console.en.md | 2 +-
42 files changed, 481 insertions(+), 46 deletions(-)
diff --git a/docs/content/user-manual/_index.cn.md b/docs/content/user-manual/_index.cn.md
index b53e718..88c95bd 100644
--- a/docs/content/user-manual/_index.cn.md
+++ b/docs/content/user-manual/_index.cn.md
@@ -5,16 +5,5 @@ weight = 4
chapter = true
+++
-# 本章导航
-
- - ElasticJob 提供了简单易用的[运维平台](/cn/user-manual/web-console/)，方便用户操作及查询作业。
-
- - [配置手册](/cn/user-manual/job-config/)介绍了如何通过 Java 和 Spring 两种方式配置。
-
- - 一般情况 ElasticJob 是通过平均分配算法的分片策略数据的，但也可以选择哈希及轮转等策略，或者自己定义[作业分片策略](/cn/user-manual/job-sharding-strategy/)。
-
- - 为了便于记录、查询、统计及监控作业运行情况，ElasticJob 提供了[事件追踪](/cn/user-manual/event-trace/)功能，也可自行对[作业运行状态监控](/cn/user-manual/execution-monitor/)。
-
- - 由于无法在生产环境调试，通过[dump](/cn/user-manual/dump/)可以把作业运行相关信息导出，方便开发者调试分析。
-
- - 最后，ElasticJob 还提供了其它扩展功能，如：[作业监听器](/cn/user-manual/job-listener/)、[自诊断修复](/cn/user-manual/job-reconcile/)、[定制化处理](/cn/user-manual/customized-hook/)及[操作手册](/cn/user-manual/operation-manual/)等。
+本章节详细阐述 ElasticJob 的 2 个相关产品 ElasticJob-Lite 和 ElasticJob-Cloud 的使用。
+
diff --git a/docs/content/user-manual/_index.en.md b/docs/content/user-manual/_index.en.md
index e8384d3..3b9ae7b 100644
--- a/docs/content/user-manual/_index.en.md
+++ b/docs/content/user-manual/_index.en.md
@@ -5,4 +5,4 @@ weight = 4
chapter = true
+++
-TODO
+This chapter describe how to use projects of ElasticJob: ElasticJob-Lite and ElasticJob-Cloud.
diff --git a/docs/content/user-manual/job-config.en.md b/docs/content/user-manual/elasticjob-cloud/_index.cn.md
similarity index 68%
copy from docs/content/user-manual/job-config.en.md
copy to docs/content/user-manual/elasticjob-cloud/_index.cn.md
index 7b1a895..dc313d6 100644
--- a/docs/content/user-manual/job-config.en.md
+++ b/docs/content/user-manual/elasticjob-cloud/_index.cn.md
@@ -1,6 +1,6 @@
+++
pre = "<b>4.2. </b>"
-title = "Job Configuration"
+title = "ElasticJob-Cloud"
weight = 2
chapter = true
+++
diff --git a/docs/content/user-manual/job-config.en.md b/docs/content/user-manual/elasticjob-cloud/_index.en.md
similarity index 68%
copy from docs/content/user-manual/job-config.en.md
copy to docs/content/user-manual/elasticjob-cloud/_index.en.md
index 7b1a895..dc313d6 100644
--- a/docs/content/user-manual/job-config.en.md
+++ b/docs/content/user-manual/elasticjob-cloud/_index.en.md
@@ -1,6 +1,6 @@
+++
pre = "<b>4.2. </b>"
-title = "Job Configuration"
+title = "ElasticJob-Cloud"
weight = 2
chapter = true
+++
diff --git a/docs/content/user-manual/elasticjob-cloud/deploy-guide.cn.md b/docs/content/user-manual/elasticjob-cloud/deploy-guide.cn.md
new file mode 100755
index 0000000..8f2bc19
--- /dev/null
+++ b/docs/content/user-manual/elasticjob-cloud/deploy-guide.cn.md
@@ -0,0 +1,47 @@
++++
+pre = "<b>4.2.2. </b>"
+title = "部署指南"
+weight = 2
+chapter = true
++++
+
+## Scheduler部署步骤
+
+1. 启动Elastic-Job-Cloud-Scheduler和Mesos指定注册中心的Zookeeper。
+
+2. 启动Mesos Master和Mesos Agent。
+
+3. 解压elastic-job-cloud-scheduler-${version}.tar.gz。可通过源码mvn install编译获取。
+
+4. 执行bin\start.sh脚本启动elastic-job-cloud-scheduler。
+
+## 作业部署步骤
+
+1. 确保Zookeeper, Mesos Master/Agent以及Elastic-Job-Cloud-Scheduler已启动。
+
+2. 将打包之后的作业tar.gz文件放至网络可访问的位置，如：ftp或http。打包的tar.gz文件中Main方法需要调用Elastic-Job-Cloud提供的JobBootstrap.execute方法。
+
+3. 使用curl命令调用REST API注册APP及作业，详情参见：[RESTful API](/02-guide/cloud-restful-api)。
+
+# 附录
+
+* 配置：修改conf\elastic-job-cloud-scheduler.properties文件。配置项说明如下：
+
+| 属性名称 | 必填 | 默认值 | 描述 |
+| -------------------------------- |:--------|:----------------------------|:-------------------------------------------------------------------------------------------|
+| hostname | 是 | | 服务器真实的IP或hostname，不能是127.0.0.1或localhost |
+| user | 否 | | Mesos framework使用的用户名称 |
+| mesos_url | 是 | zk://127.0.0.1:2181/mesos | Mesos所使用的Zookeeper地址 |
+| zk_servers | 是 | 127.0.0.1:2181 | Elastic-Job-Cloud所使用的Zookeeper地址 |
+| zk_namespace | 否 | elastic-job-cloud | Elastic-Job-Cloud所使用的Zookeeper命名空间 |
+| zk_digest | 否 | | Elastic-Job-Cloud所使用的Zookeeper登录凭证 |
+| http_port | 是 | 8899 | Restful API所使用的端口号 |
+| job_state_queue_size | 是 | 10000 | 堆积作业最大值, 超过此阀值的堆积作业将直接丢弃。阀值过大可能会导致Zookeeper无响应，应根据实测情况调整 |
+| event_trace_rdb_driver | 否 | | 作业事件追踪数据库驱动 |
+| event_trace_rdb_url | 否 | | 作业事件追踪数据库URL |
+| event_trace_rdb_username | 否 | | 作业事件追踪数据库用户名 |
+| event_trace_rdb_password | 否 | | 作业事件追踪数据库密码 |
+
+***
+
+* 停止：不提供停止脚本，可直接使用kill杀进程。
diff --git a/docs/content/user-manual/deploy-guide.en.md b/docs/content/user-manual/elasticjob-cloud/deploy-guide.en.md
old mode 100644
new mode 100755
similarity index 60%
copy from docs/content/user-manual/deploy-guide.en.md
copy to docs/content/user-manual/elasticjob-cloud/deploy-guide.en.md
index bfe51b7..7df5f88
--- a/docs/content/user-manual/deploy-guide.en.md
+++ b/docs/content/user-manual/elasticjob-cloud/deploy-guide.en.md
@@ -1,7 +1,7 @@
+++
-pre = "<b>4.10. </b>"
+pre = "<b>4.2.2. </b>"
title = "Deploy Guide"
-weight = 10
+weight = 2
chapter = true
+++
diff --git a/docs/content/user-manual/elasticjob-cloud/dev-guide.cn.md b/docs/content/user-manual/elasticjob-cloud/dev-guide.cn.md
new file mode 100755
index 0000000..988d506
--- /dev/null
+++ b/docs/content/user-manual/elasticjob-cloud/dev-guide.cn.md
@@ -0,0 +1,138 @@
++++
+pre = "<b>4.2.1. </b>"
+title = "开发指南"
+weight = 1
+chapter = true
++++
+
+## 0. 环境需求
+
+### Java
+
+请使用JDK1.7及其以上版本。[详情参见](http://www.oracle.com/technetwork/java/javase/downloads/index.html)
+
+### Zookeeper
+
+请使用Zookeeper 3.4.6及其以上版本。[详情参见](https://zookeeper.apache.org/doc/trunk/zookeeperStarted.html)
+
+### Maven
+
+请使用Maven 3.0.4及其以上版本。[详情参见](http://maven.apache.org/install.html)
+
+### Mesos
+
+请使用Mesos 0.28.0及其以上版本。[详情参见](http://mesos.apache.org/gettingstarted/)
+
+## 1. 作业开发
+
+Elastic-Job-Lite和Elastic-Job-Cloud提供统一作业接口，开发者仅需对业务作业进行一次开发，之后可根据不同的配置以及部署至不同的Lite或Cloud环境。
+
+Elastic-Job提供Simple、Dataflow和Script 3种作业类型。
+方法参数shardingContext包含作业配置、片和运行时信息。可通过getShardingTotalCount(), getShardingItem()等方法分别获取分片总数，运行在本作业服务器的分片序列号等。
+
+### a. Simple类型作业
+
+意为简单实现，未经任何封装的类型。需实现SimpleJob接口。该接口仅提供单一方法用于覆盖，此方法将定时执行。与Quartz原生接口相似，但提供了弹性扩缩容和分片等功能。
+
+```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: ...
+ }
+ }
+}
+```
+
+### b. Dataflow类型作业
+
+Dataflow类型用于处理数据流，需实现DataflowJob接口。该接口提供2个方法可供覆盖，分别用于抓取(fetchData)和处理(processData)数据。
+
+```java
+public class MyElasticJob implements DataflowJob<Foo> {
+
+ @Override
+ public List<Foo> fetchData(ShardingContext context) {
+ switch (context.getShardingItem()) {
+ case 0:
+ List<Foo> data = // get data from database by sharding item 0
+ return data;
+ case 1:
+ List<Foo> data = // get data from database by sharding item 1
+ return data;
+ case 2:
+ List<Foo> data = // get data from database by sharding item 2
+ return data;
+ // case n: ...
+ }
+ return result;
+ }
+
+ @Override
+ public void processData(ShardingContext shardingContext, List<Foo> data) {
+ // process data
+ // ...
+ }
+}
+```
+
+***
+
+**流式处理**
+
+可通过DataflowJobConfiguration配置是否流式处理。
+
+流式处理数据只有fetchData方法的返回值为null或集合长度为空时，作业才停止抓取，否则作业将一直运行下去；
+非流式处理数据则只会在每次作业执行过程中执行一次fetchData方法和processData方法，随即完成本次作业。
+
+如果采用流式作业处理方式，建议processData处理数据后更新其状态，避免fetchData再次抓取到，从而使得作业永不停止。
+流式数据处理参照TbSchedule设计，适用于不间歇的数据处理。
+
+### c. Script类型作业
+
+Script类型作业意为脚本类型作业，支持shell，python，perl等所有类型脚本。只需通过控制台或代码配置scriptCommandLine即可，无需编码。执行脚本路径可包含参数，参数传递完毕后，作业框架会自动追加最后一个参数为作业运行时信息。
+
+```
+#!/bin/bash
+echo sharding execution context is $*
+```
+
+作业运行时输出
+
+sharding execution context is {"jobName":"scriptElasticDemoJob","shardingTotalCount":10,"jobParameter":"","shardingItem":0,"shardingParameter":"A"}
+
+## 3. 作业启动
+
+### a. Java启动方式
+
+需定义Main方法并调用JobBootstrap.execute()，例子如下：
+
+```java
+public class JobDemo {
+
+ public static void main(final String[] args) {
+ JobBootstrap.execute();
+ }
+}
+```
+
+### b. Spring启动方式
+
+同Java启动方式，但需要通过REST API配置bean的名字和Spring配置文件位置，如：
+
+```json
+{..., "beanName":"simpleJobBean", "applicationContext":"yourDir/applicationContext.xml"}
+```
+
+之后将作业和用于执行Java Main方法的Shell脚本打包为gz.tar格式，然后使用Cloud提供的REST API将其部署至Elastic-Job-Cloud系统。如对如何打包不理解请参考我们提供的example。
diff --git a/docs/content/user-manual/elasticjob-cloud/dev-guide.en.md b/docs/content/user-manual/elasticjob-cloud/dev-guide.en.md
new file mode 100755
index 0000000..7b50d05
--- /dev/null
+++ b/docs/content/user-manual/elasticjob-cloud/dev-guide.en.md
@@ -0,0 +1,8 @@
++++
+pre = "<b>4.2.1. </b>"
+title = "Dev Guide"
+weight = 1
+chapter = true
++++
+
+TODO
diff --git a/docs/content/user-manual/elasticjob-cloud/high-availability.cn.md b/docs/content/user-manual/elasticjob-cloud/high-availability.cn.md
new file mode 100755
index 0000000..f9982eb
--- /dev/null
+++ b/docs/content/user-manual/elasticjob-cloud/high-availability.cn.md
@@ -0,0 +1,23 @@
++++
+pre = "<b>4.2.4. </b>"
+title = "高可用"
+weight = 4
+chapter = true
++++
+
+## 介绍
+
+调度器的高可用是通过运行几个指向同一个ZooKeeper集群的Elastic-Job-Cloud-Scheduler实例来实现的。ZooKeeper用于在当前主Elastic-Job-Cloud-Scheduler实例失败的情况下执行领导者选举。通过至少两个调度器实例来构成集群，集群中只有一个调度器实例提供服务，其他实例处于"待命"状态。当该实例失败时，集群会选举剩余实例中的一个来继续提供服务。
+
+## 配置
+
+每个Elastic-Job-Cloud-Scheduler实例必须使用相同的ZooKeeper集群。
+例如，如果Zookeeper的Quorum为zk://1.2.3.4:2181,2.3.4.5:2181,3.4.5.6:2181/elastic-job-cloud，则elastic-job-cloud-scheduler.properties中Zookeeper相关配置为：
+
+```properties
+# Elastic-Job-Cloud's zookeeper address
+zk_servers=1.2.3.4:2181,2.3.4.5:2181,3.4.5.6:2181
+
+# Elastic-Job-Cloud's zookeeper namespace
+zk_namespace=elastic-job-cloud
+```
\ No newline at end of file
diff --git a/docs/content/user-manual/elasticjob-cloud/high-availability.en.md b/docs/content/user-manual/elasticjob-cloud/high-availability.en.md
new file mode 100755
index 0000000..b2c7f62
--- /dev/null
+++ b/docs/content/user-manual/elasticjob-cloud/high-availability.en.md
@@ -0,0 +1,8 @@
++++
+pre = "<b>4.2.4. </b>"
+title = "High Available"
+weight = 4
+chapter = true
++++
+
+TODO
diff --git a/docs/content/user-manual/elasticjob-cloud/local-executor.cn.md b/docs/content/user-manual/elasticjob-cloud/local-executor.cn.md
new file mode 100755
index 0000000..a4b917b
--- /dev/null
+++ b/docs/content/user-manual/elasticjob-cloud/local-executor.cn.md
@@ -0,0 +1,35 @@
++++
+pre = "<b>4.2.6. </b>"
+title = "本地运行模式"
+weight = 6
+chapter = true
++++
+
+在开发`Elastic-Job-Cloud`作业时，开发人员可以脱离`Mesos`环境，在本地运行和调试作业。可以利用本地运行模式充分的调试业务功能以及单元测试，完成之后再部署至`Mesos`集群。
+
+本地运行作业无需安装`Mesos`环境。
+
+## 配置
+
+使用`io.elasticjob.cloud.executor.local.LocalCloudJobConfiguration`配置本地作业。
+
+```java
+LocalCloudJobConfiguration config = new LocalCloudJobConfiguration(
+ new SimpleJobConfiguration(JobCoreConfiguration.newBuilder("FooJob", "*/2 * * * * ?", 3) //1
+ .shardingItemParameters("0=Beijing,1=Shanghai,2=Guangzhou")
+ .jobParameter("dbName=dangdang").build(), "com.xxx.foo.FooJob"),
+ 1, //2
+ "testSimpleJob" , "applicationContext.xml"); //3
+```
+
+1. 配置作业类型和作业基本信息。
+1. 配置当前运行的作业是第几个分片。
+1. 配置Spring相关参数。
+
+## 运行
+
+使用`io.elasticjob.cloud.executor.local.LocalTaskExecutor`运行作业。
+
+```java
+new LocalTaskExecutor(localJobConfig).execute();
+```
diff --git a/docs/content/user-manual/elasticjob-cloud/local-executor.en.md b/docs/content/user-manual/elasticjob-cloud/local-executor.en.md
new file mode 100755
index 0000000..4e62257
--- /dev/null
+++ b/docs/content/user-manual/elasticjob-cloud/local-executor.en.md
@@ -0,0 +1,8 @@
++++
+pre = "<b>4.2.6. </b>"
+title = "Local Executor"
+weight = 6
+chapter = true
++++
+
+TODO
diff --git a/docs/content/user-manual/elasticjob-cloud/restful-api.cn.md b/docs/content/user-manual/elasticjob-cloud/restful-api.cn.md
new file mode 100755
index 0000000..4b8c004
--- /dev/null
+++ b/docs/content/user-manual/elasticjob-cloud/restful-api.cn.md
@@ -0,0 +1,145 @@
++++
+pre = "<b>4.2.3. </b>"
+title = "RESTful API"
+weight = 3
+chapter = true
++++
+
+Elastic-Job-Cloud提供APP发布及作业注册等RESTful API可通过curl操作。
+
+### 发布作业应用
+
+url：app
+
+方法：POST
+
+参数类型：application/json
+
+参数列表：
+
+| 属性名 | 类型 |是否必填 | 缺省值 | 描述 |
+| -----------------------------------|:------|:-------|:------|:---------------------------------------------------------------------------------|
+|appName |String |是 | | 作业应用名称。为Elastic-Job-Cloud的作业应用唯一标识 |
+|appURL |String |是 | | 作业应用所在路径。必须是可以通过网络访问到的路径 |
+|cpuCount |double |否 | 1 | 作业应用启动所需要的CPU数量 |
+|memoryMB |double |否 | 128 | 作业应用启动所需要的内存MB |
+|bootstrapScript |String |是 | | 启动脚本，如：bin\start.sh |
+|appCacheEnable |bool |否 | true | 每次执行作业时是否从缓存中读取应用。禁用则每次执行任务均从应用仓库下载应用至本地 |
+|eventTraceSamplingCount |int |否 | 0 | 常驻作业事件采样率统计条数，默认不采样全部记录。为避免数据量过大，可对频繁调度的常驻作业配置采样率，即作业每执行N次，才会记录作业执行及追踪相关数据|
+
+```shell
+curl -l -H "Content-type: application/json" -X POST -d '{"appName":"foo_app","appURL":"http://app_host:8080/foo-job.tar.gz","cpuCount":0.1,"memoryMB":64.0,"bootstrapScript":"bin/start.sh","appCacheEnable":true,"eventTraceSamplingCount":0}' http://elastic_job_cloud_host:8899/api/app
+```
+
+### 修改作业应用配置
+
+url：app
+
+方法：PUT
+
+参数类型：application/json
+
+参数列表：
+
+| 属性名 | 类型 |是否必填 | 缺省值 | 描述 |
+| -----------------------------------|:------|:-------|:------|:---------------------------------------------------------------------------------|
+|appName |String |是 | | 作业应用名称。为Elastic-Job-Cloud的作业应用唯一标识 |
+|appCacheEnable |bool |是 | true | 每次执行作业时是否从缓存中读取应用。禁用则每次执行任务均从应用仓库下载应用至本地 |
+|eventTraceSamplingCount |int |否 | 0 | 常驻作业事件采样率统计条数，默认不采样全部记录。为避免数据量过大，可对频繁调度的常驻作业配置采样率，即作业每执行N次，才会记录作业执行及追踪相关数据|
+
+```shell
+curl -l -H "Content-type: application/json" -X PUT -d '{"appName":"foo_app","appCacheEnable":true}' http://elastic_job_cloud_host:8899/api/app
+```
+
+### 注册作业
+
+url：job/register
+
+方法：POST
+
+参数类型：application/json
+
+参数列表：
+
+| 属性名 | 类型 |是否必填 | 缺省值 | 描述 |
+| -----------------------------------|:------|:-------|:------|:---------------------------------------------------------------------------------|
+|jobName |String |是 | | 作业名称。为Elastic-Job-Cloud的作业唯一标识 |
+|appName |String |是 | | 作业应用名称。 |
+|jobClass |String |是 | | 作业实现类 |
+|jobType |Enum |是 | | 作业类型。SIMPLE，DATAFLOW，SCRIPT |
+|jobExecutionType |Enum |是 | | 作业执行类型。TRANSIENT为瞬时作业，DAEMON为常驻作业 |
+|cron |String |是 | | cron表达式，用于配置作业触发时间 |
+|shardingTotalCount |int |是 | | 作业分片总数 |
+|cpuCount |double |是 | | 单片作业所需要的CPU数量，最小值为0.001 |
+|memoryMB |double |是 | | 单片作业所需要的内存MB，最小值为1 |
+|shardingItemParameters |String |否 | | 分片序列号和参数用等号分隔，多个键值对用逗号分隔<br />分片序列号从0开始，不可大于或等于作业分片总数<br />如：<br/>0=a,1=b,2=c|
+|jobParameter |String |否 | | 作业自定义参数<br />作业自定义参数，可通过传递该参数为作业调度的业务方法传参，用于实现带参数的作业<br />例：每次获取的数据量、作业实例从数据库读取的主键等 |
+|failover |boolean|否 |false | 是否开启失效转移，开启表示如果作业在一次任务执行中途宕机，允许将该次未完成的任务在另一作业节点上补偿执行 |
+|misfire |boolean|否 |false | 是否开启错过任务重新执行 |
+|beanName |String |否 | | Spring容器中配置的bean名称 |
+|applicationContext |String |否 | | Spring方式配置Spring配置文件相对路径以及名称，如：META-INF\applicationContext.xml |
+|streamingProcess |boolean|否 |false | DATAFLOW类型作业，是否流式处理数据<br />如果流式处理数据, 则fetchData不返回空结果将持续执行作业<br />如果非流式处理数据, 则处理数据完成后作业结束<br />|
+|scriptCommandLine |String |否 | | SCRIPT类型作业命令行执行脚本 |
+|jobProperties |String |否 | | 作业定制化属性，目前支持job_exception_handler和executor_service_handler，用于扩展异常处理和自定义作业处理线程池 |
+|description |String |否 | | 作业描述信息 |
+
+注册的作业可用Java和Spring两种启动方式，作业启动在[开发指南](/01-start/dev-guide/)中有说明，这里只举例说明两种方式如何注册。
+
+使用Transient的Script类型作业可直接将shell上传至appURL，而无需打成java包。如果只有单个shell文件可无需压缩。如是复杂shell或python等应用，仍可上传tar包，支持各种常见压缩格式。
+
+**Java启动方式作业注册**
+
+```shell
+curl -l -H "Content-type: application/json" -X POST -d '{"jobName":"foo_job","appName":"foo_app","jobClass":"yourJobClass","jobType":"SIMPLE","jobExecutionType":"TRANSIENT","cron":"0/5 * * * * ?","shardingTotalCount":5,"cpuCount":0.1,"memoryMB":64.0,"failover":true,"misfire":true}' http://elastic_job_cloud_host:8899/api/job/register
+```
+
+**Spring启动方式作业注册**
+
+```shell
+curl -l -H "Content-type: application/json" -X POST -d '{"jobName":"foo_job","appName":"foo_app","jobClass":"yourJobClass","beanName":"yourBeanName","applicationContext":"applicationContext.xml","jobType":"SIMPLE","jobExecutionType":"TRANSIENT","cron":"0/5 * * * * ?","shardingTotalCount":5,"cpuCount":0.1,"memoryMB":64.0,"failover":false,"misfire":true}' http://elastic_job_cloud_masterhost:8899/api/job/register
+```
+
+### 修改作业配置
+
+url：job/update
+
+方法：PUT
+
+参数类型：application/json
+
+参数：同注册作业
+
+```shell
+curl -l -H "Content-type: application/json" -X PUT -d
+'{"jobName":"foo_job","appName":"foo_app","jobClass":"yourJobClass","jobType":"SIMPLE","jobExecutionType":"TRANSIENT","cron":"0/5 * * * * ?","shardingTotalCount":5,"cpuCount":0.1,"memoryMB":64.0,"failover":true,"misfire":true}' http://elastic_job_cloud_host:8899/api/job/update
+```
+
+### 注销作业
+
+url：job/deregister
+
+方法：DELETE
+
+参数类型：application/json
+
+参数：作业名称
+
+```shell
+curl -l -H "Content-type: application/json" -X DELETE -d 'foo_job' http://elastic_job_cloud_host:8899/api/job/deregister
+```
+
+### 触发一次作业
+
+url：job/trigger
+
+方法：POST
+
+参数类型：application/json
+
+参数：作业名称
+
+说明：即事件驱动，通过调用API而非定时的触发作业。目前仅对Transient作业类型生效。
+
+```shell
+curl -l -H "Content-type: application/json" -X POST -d 'foo_job' http://elastic_job_cloud_host:8899/api/job/trigger
+```
diff --git a/docs/content/user-manual/elasticjob-cloud/restful-api.en.md b/docs/content/user-manual/elasticjob-cloud/restful-api.en.md
new file mode 100755
index 0000000..1f240c7
--- /dev/null
+++ b/docs/content/user-manual/elasticjob-cloud/restful-api.en.md
@@ -0,0 +1,8 @@
++++
+pre = "<b>4.2.3. </b>"
+title = "RESTful API"
+weight = 3
+chapter = true
++++
+
+TODO
diff --git a/docs/content/user-manual/elasticjob-cloud/web-console.cn.md b/docs/content/user-manual/elasticjob-cloud/web-console.cn.md
new file mode 100755
index 0000000..6892971
--- /dev/null
+++ b/docs/content/user-manual/elasticjob-cloud/web-console.cn.md
@@ -0,0 +1,26 @@
++++
+pre = "<b>4.2.5. </b>"
+title = "运维平台"
+weight = 5
+chapter = true
++++
+
+运维平台内嵌于elastic-job-cloud-scheduler的jar包中, 无需额外启动WEB付服务器, 可通过修改配置文件中http_port参数来调整启动端口,默认端口为8899，访问地址为http://{your_scheduler_ip}:8899。
+
+## 登录
+
+提供两种账户，管理员及访客，管理员拥有全部操作权限，访客仅拥有察看权限。默认管理员用户名和密码是root/root，访客用户名和密码是guest/guest，可通过conf\auth.properties修改管理员及访客用户名及密码。
+
+## 功能列表
+
+* 作业APP管理（发布、修改、查看）
+
+* 作业管理（注册、修改、查看以及删除）
+
+* 作业状态查看（待运行、运行中、待失效转移）
+
+* 作业历史查看（运行轨迹、执行状态、历史dashboard）
+
+## 设计理念
+
+运维平台采用纯静态HTML+JS方式与后台的RESTful API交互，通过读取作业注册中心展示作业配置和状态，数据库展现作业运行轨迹及执行状态，或更新作业注册中心数据修改作业配置。
diff --git a/docs/content/user-manual/web-console.en.md b/docs/content/user-manual/elasticjob-cloud/web-console.en.md
old mode 100644
new mode 100755
similarity index 58%
copy from docs/content/user-manual/web-console.en.md
copy to docs/content/user-manual/elasticjob-cloud/web-console.en.md
index a30e174..c7feb00
--- a/docs/content/user-manual/web-console.en.md
+++ b/docs/content/user-manual/elasticjob-cloud/web-console.en.md
@@ -1,7 +1,7 @@
+++
-pre = "<b>4.11. </b>"
+pre = "<b>4.2.5. </b>"
title = "Console"
-weight = 11
+weight = 5
chapter = true
+++
diff --git a/docs/content/user-manual/job-api.en.md b/docs/content/user-manual/elasticjob-lite/_index.cn.md
similarity index 70%
copy from docs/content/user-manual/job-api.en.md
copy to docs/content/user-manual/elasticjob-lite/_index.cn.md
index abbc72b..e4058b0 100644
--- a/docs/content/user-manual/job-api.en.md
+++ b/docs/content/user-manual/elasticjob-lite/_index.cn.md
@@ -1,6 +1,6 @@
+++
pre = "<b>4.1. </b>"
-title = "Job API"
+title = "ElasticJob-Lite"
weight = 1
chapter = true
+++
diff --git a/docs/content/user-manual/job-api.en.md b/docs/content/user-manual/elasticjob-lite/_index.en.md
similarity index 70%
copy from docs/content/user-manual/job-api.en.md
copy to docs/content/user-manual/elasticjob-lite/_index.en.md
index abbc72b..e4058b0 100644
--- a/docs/content/user-manual/job-api.en.md
+++ b/docs/content/user-manual/elasticjob-lite/_index.en.md
@@ -1,6 +1,6 @@
+++
pre = "<b>4.1. </b>"
-title = "Job API"
+title = "ElasticJob-Lite"
weight = 1
chapter = true
+++
diff --git a/docs/content/user-manual/customized-hook.cn.md b/docs/content/user-manual/elasticjob-lite/customized-hook.cn.md
similarity index 94%
rename from docs/content/user-manual/customized-hook.cn.md
rename to docs/content/user-manual/elasticjob-lite/customized-hook.cn.md
index 67abbe2..e11a48f 100644
--- a/docs/content/user-manual/customized-hook.cn.md
+++ b/docs/content/user-manual/elasticjob-lite/customized-hook.cn.md
@@ -1,5 +1,5 @@
+++
-pre = "<b>4.7. </b>"
+pre = "<b>4.1.7. </b>"
title = "定制化处理"
weight = 7
chapter = true
diff --git a/docs/content/user-manual/customized-hook.en.md b/docs/content/user-manual/elasticjob-lite/customized-hook.en.md
similarity index 71%
rename from docs/content/user-manual/customized-hook.en.md
rename to docs/content/user-manual/elasticjob-lite/customized-hook.en.md
index d1502d3..e68913b 100644
--- a/docs/content/user-manual/customized-hook.en.md
+++ b/docs/content/user-manual/elasticjob-lite/customized-hook.en.md
@@ -1,5 +1,5 @@
+++
-pre = "<b>4.7. </b>"
+pre = "<b>4.1.7. </b>"
title = "Customization"
weight = 10
chapter = true
diff --git a/docs/content/user-manual/deploy-guide.cn.md b/docs/content/user-manual/elasticjob-lite/deploy-guide.cn.md
similarity index 96%
rename from docs/content/user-manual/deploy-guide.cn.md
rename to docs/content/user-manual/elasticjob-lite/deploy-guide.cn.md
index 75571d3..2bee7ee 100644
--- a/docs/content/user-manual/deploy-guide.cn.md
+++ b/docs/content/user-manual/elasticjob-lite/deploy-guide.cn.md
@@ -1,5 +1,5 @@
+++
-pre = "<b>4.10. </b>"
+pre = "<b>4.1.10. </b>"
title = "部署指南"
weight = 10
chapter = true
diff --git a/docs/content/user-manual/deploy-guide.en.md b/docs/content/user-manual/elasticjob-lite/deploy-guide.en.md
similarity index 72%
rename from docs/content/user-manual/deploy-guide.en.md
rename to docs/content/user-manual/elasticjob-lite/deploy-guide.en.md
index bfe51b7..6a8d6c7 100644
--- a/docs/content/user-manual/deploy-guide.en.md
+++ b/docs/content/user-manual/elasticjob-lite/deploy-guide.en.md
@@ -1,5 +1,5 @@
+++
-pre = "<b>4.10. </b>"
+pre = "<b>4.1.10. </b>"
title = "Deploy Guide"
weight = 10
chapter = true
diff --git a/docs/content/user-manual/dump.cn.md b/docs/content/user-manual/elasticjob-lite/dump.cn.md
similarity index 99%
rename from docs/content/user-manual/dump.cn.md
rename to docs/content/user-manual/elasticjob-lite/dump.cn.md
index ac8aed1..5fa47db 100644
--- a/docs/content/user-manual/dump.cn.md
+++ b/docs/content/user-manual/elasticjob-lite/dump.cn.md
@@ -1,5 +1,5 @@
+++
-pre = "<b>4.8. </b>"
+pre = "<b>4.1.8. </b>"
title = "Dump 作业运行信息"
weight = 8
chapter = true
diff --git a/docs/content/user-manual/dump.en.md b/docs/content/user-manual/elasticjob-lite/dump.en.md
similarity index 75%
rename from docs/content/user-manual/dump.en.md
rename to docs/content/user-manual/elasticjob-lite/dump.en.md
index 7263369..e206510 100644
--- a/docs/content/user-manual/dump.en.md
+++ b/docs/content/user-manual/elasticjob-lite/dump.en.md
@@ -1,5 +1,5 @@
+++
-pre = "<b>4.8. </b>"
+pre = "<b>4.1.8. </b>"
title = "Dump Job Runtime Info"
weight = 6
chapter = true
diff --git a/docs/content/user-manual/event-trace.cn.md b/docs/content/user-manual/elasticjob-lite/event-trace.cn.md
similarity index 99%
rename from docs/content/user-manual/event-trace.cn.md
rename to docs/content/user-manual/elasticjob-lite/event-trace.cn.md
index 2745197..41f923a 100644
--- a/docs/content/user-manual/event-trace.cn.md
+++ b/docs/content/user-manual/elasticjob-lite/event-trace.cn.md
@@ -1,5 +1,5 @@
+++
-pre = "<b>4.6. </b>"
+pre = "<b>4.1.6. </b>"
title = "事件追踪"
weight = 6
chapter = true
diff --git a/docs/content/user-manual/event-trace.en.md b/docs/content/user-manual/elasticjob-lite/event-trace.en.md
similarity index 72%
rename from docs/content/user-manual/event-trace.en.md
rename to docs/content/user-manual/elasticjob-lite/event-trace.en.md
index 604358a..5bc4d3b 100644
--- a/docs/content/user-manual/event-trace.en.md
+++ b/docs/content/user-manual/elasticjob-lite/event-trace.en.md
@@ -1,5 +1,5 @@
+++
-pre = "<b>4.6. </b>"
+pre = "<b>4.1.6. </b>"
title = "Event Trace"
weight = 6
chapter = true
diff --git a/docs/content/user-manual/execution-monitor.cn.md b/docs/content/user-manual/elasticjob-lite/execution-monitor.cn.md
similarity index 94%
rename from docs/content/user-manual/execution-monitor.cn.md
rename to docs/content/user-manual/elasticjob-lite/execution-monitor.cn.md
index 74f6e0a..1cc954a 100644
--- a/docs/content/user-manual/execution-monitor.cn.md
+++ b/docs/content/user-manual/elasticjob-lite/execution-monitor.cn.md
@@ -1,5 +1,5 @@
+++
-pre = "<b>4.9. </b>"
+pre = "<b>4.1.9. </b>"
title = "作业运行状态监控"
weight = 9
chapter = true
diff --git a/docs/content/user-manual/execution-monitor.en.md b/docs/content/user-manual/elasticjob-lite/execution-monitor.en.md
similarity index 74%
rename from docs/content/user-manual/execution-monitor.en.md
rename to docs/content/user-manual/elasticjob-lite/execution-monitor.en.md
index cf93406..79f961a 100644
--- a/docs/content/user-manual/execution-monitor.en.md
+++ b/docs/content/user-manual/elasticjob-lite/execution-monitor.en.md
@@ -1,5 +1,5 @@
+++
-pre = "<b>4.9. </b>"
+pre = "<b>4.1.9. </b>"
title = "Execution Monitor"
weight = 9
chapter = true
diff --git a/docs/content/user-manual/job-api.cn.md b/docs/content/user-manual/elasticjob-lite/job-api.cn.md
similarity index 99%
rename from docs/content/user-manual/job-api.cn.md
rename to docs/content/user-manual/elasticjob-lite/job-api.cn.md
index 5395d03..fdbd5f0 100644
--- a/docs/content/user-manual/job-api.cn.md
+++ b/docs/content/user-manual/elasticjob-lite/job-api.cn.md
@@ -1,5 +1,5 @@
+++
-pre = "<b>4.1. </b>"
+pre = "<b>4.1.1. </b>"
title = "作业 API"
weight = 1
chapter = true
diff --git a/docs/content/user-manual/job-api.en.md b/docs/content/user-manual/elasticjob-lite/job-api.en.md
similarity index 71%
rename from docs/content/user-manual/job-api.en.md
rename to docs/content/user-manual/elasticjob-lite/job-api.en.md
index abbc72b..3c8a624 100644
--- a/docs/content/user-manual/job-api.en.md
+++ b/docs/content/user-manual/elasticjob-lite/job-api.en.md
@@ -1,5 +1,5 @@
+++
-pre = "<b>4.1. </b>"
+pre = "<b>4.1.1. </b>"
title = "Job API"
weight = 1
chapter = true
diff --git a/docs/content/user-manual/job-config.cn.md b/docs/content/user-manual/elasticjob-lite/job-config.cn.md
similarity index 99%
rename from docs/content/user-manual/job-config.cn.md
rename to docs/content/user-manual/elasticjob-lite/job-config.cn.md
index a4d2795..4d78b1a7 100644
--- a/docs/content/user-manual/job-config.cn.md
+++ b/docs/content/user-manual/elasticjob-lite/job-config.cn.md
@@ -1,5 +1,5 @@
+++
-pre = "<b>4.2. </b>"
+pre = "<b>4.1.2. </b>"
title = "作业配置"
weight = 2
chapter = true
diff --git a/docs/content/user-manual/job-config.en.md b/docs/content/user-manual/elasticjob-lite/job-config.en.md
similarity index 74%
rename from docs/content/user-manual/job-config.en.md
rename to docs/content/user-manual/elasticjob-lite/job-config.en.md
index 7b1a895..3f56cbd 100644
--- a/docs/content/user-manual/job-config.en.md
+++ b/docs/content/user-manual/elasticjob-lite/job-config.en.md
@@ -1,5 +1,5 @@
+++
-pre = "<b>4.2. </b>"
+pre = "<b>4.1.2. </b>"
title = "Job Configuration"
weight = 2
chapter = true
diff --git a/docs/content/user-manual/job-listener.cn.md b/docs/content/user-manual/elasticjob-lite/job-listener.cn.md
similarity index 99%
rename from docs/content/user-manual/job-listener.cn.md
rename to docs/content/user-manual/elasticjob-lite/job-listener.cn.md
index dbbe287..b3a4378 100644
--- a/docs/content/user-manual/job-listener.cn.md
+++ b/docs/content/user-manual/elasticjob-lite/job-listener.cn.md
@@ -1,5 +1,5 @@
+++
-pre = "<b>4.4. </b>"
+pre = "<b>4.1.4. </b>"
title = "作业监听器"
weight = 4
chapter = true
diff --git a/docs/content/user-manual/job-listener.en.md b/docs/content/user-manual/elasticjob-lite/job-listener.en.md
similarity index 73%
rename from docs/content/user-manual/job-listener.en.md
rename to docs/content/user-manual/elasticjob-lite/job-listener.en.md
index 5f2c167..8f215a8 100644
--- a/docs/content/user-manual/job-listener.en.md
+++ b/docs/content/user-manual/elasticjob-lite/job-listener.en.md
@@ -1,5 +1,5 @@
+++
-pre = "<b>4.4. </b>"
+pre = "<b>4.1.4. </b>"
title = "Job Listener"
weight = 4
chapter = true
diff --git a/docs/content/user-manual/job-reconcile.cn.md b/docs/content/user-manual/elasticjob-lite/job-reconcile.cn.md
similarity index 98%
rename from docs/content/user-manual/job-reconcile.cn.md
rename to docs/content/user-manual/elasticjob-lite/job-reconcile.cn.md
index 830a4b7..044777f 100644
--- a/docs/content/user-manual/job-reconcile.cn.md
+++ b/docs/content/user-manual/elasticjob-lite/job-reconcile.cn.md
@@ -1,5 +1,5 @@
+++
-pre = "<b>4.5. </b>"
+pre = "<b>4.1.5. </b>"
title = "自诊断修复"
weight = 5
chapter = true
diff --git a/docs/content/user-manual/job-reconcile.en.md b/docs/content/user-manual/elasticjob-lite/job-reconcile.en.md
similarity index 72%
rename from docs/content/user-manual/job-reconcile.en.md
rename to docs/content/user-manual/elasticjob-lite/job-reconcile.en.md
index 05e1a87..102aca4 100644
--- a/docs/content/user-manual/job-reconcile.en.md
+++ b/docs/content/user-manual/elasticjob-lite/job-reconcile.en.md
@@ -1,5 +1,5 @@
+++
-pre = "<b>4.5. </b>"
+pre = "<b>4.1.5. </b>"
title = "Reconcile"
weight = 5
chapter = true
diff --git a/docs/content/user-manual/job-sharding-strategy.cn.md b/docs/content/user-manual/elasticjob-lite/job-sharding-strategy.cn.md
similarity index 99%
rename from docs/content/user-manual/job-sharding-strategy.cn.md
rename to docs/content/user-manual/elasticjob-lite/job-sharding-strategy.cn.md
index 417e810..79a15b9 100644
--- a/docs/content/user-manual/job-sharding-strategy.cn.md
+++ b/docs/content/user-manual/elasticjob-lite/job-sharding-strategy.cn.md
@@ -1,5 +1,5 @@
+++
-pre = "<b>4.3. </b>"
+pre = "<b>4.1.3. </b>"
title = "作业分片策略"
weight = 3
chapter = true
diff --git a/docs/content/user-manual/job-sharding-strategy.en.md b/docs/content/user-manual/elasticjob-lite/job-sharding-strategy.en.md
similarity index 75%
rename from docs/content/user-manual/job-sharding-strategy.en.md
rename to docs/content/user-manual/elasticjob-lite/job-sharding-strategy.en.md
index 20f9b8d..b678877 100644
--- a/docs/content/user-manual/job-sharding-strategy.en.md
+++ b/docs/content/user-manual/elasticjob-lite/job-sharding-strategy.en.md
@@ -1,5 +1,5 @@
+++
-pre = "<b>4.3. </b>"
+pre = "<b>4.1.3. </b>"
title = "Job Sharding Strategy"
weight = 3
chapter = true
diff --git a/docs/content/user-manual/operation-manual.cn.md b/docs/content/user-manual/elasticjob-lite/operation-manual.cn.md
similarity index 99%
rename from docs/content/user-manual/operation-manual.cn.md
rename to docs/content/user-manual/elasticjob-lite/operation-manual.cn.md
index 742c731..9d648d4 100644
--- a/docs/content/user-manual/operation-manual.cn.md
+++ b/docs/content/user-manual/elasticjob-lite/operation-manual.cn.md
@@ -1,5 +1,5 @@
+++
-pre = "<b>4.12. </b>"
+pre = "<b>4.1.12. </b>"
title = "操作手册"
weight = 12
chapter = true
diff --git a/docs/content/user-manual/operation-manual.en.md b/docs/content/user-manual/elasticjob-lite/operation-manual.en.md
similarity index 71%
rename from docs/content/user-manual/operation-manual.en.md
rename to docs/content/user-manual/elasticjob-lite/operation-manual.en.md
index 88c68e8..889cd6f 100644
--- a/docs/content/user-manual/operation-manual.en.md
+++ b/docs/content/user-manual/elasticjob-lite/operation-manual.en.md
@@ -1,5 +1,5 @@
+++
-pre = "<b>4.12. </b>"
+pre = "<b>4.1.12. </b>"
title = "Operator"
weight = 12
chapter = true
diff --git a/docs/content/user-manual/web-console.cn.md b/docs/content/user-manual/elasticjob-lite/web-console.cn.md
similarity index 98%
rename from docs/content/user-manual/web-console.cn.md
rename to docs/content/user-manual/elasticjob-lite/web-console.cn.md
index d7469ba..09f36ba 100644
--- a/docs/content/user-manual/web-console.cn.md
+++ b/docs/content/user-manual/elasticjob-lite/web-console.cn.md
@@ -1,5 +1,5 @@
+++
-pre = "<b>4.11. </b>"
+pre = "<b>4.1.11. </b>"
title = "运维平台"
weight = 11
chapter = true
diff --git a/docs/content/user-manual/web-console.en.md b/docs/content/user-manual/elasticjob-lite/web-console.en.md
similarity index 71%
rename from docs/content/user-manual/web-console.en.md
rename to docs/content/user-manual/elasticjob-lite/web-console.en.md
index a30e174..98b6cae 100644
--- a/docs/content/user-manual/web-console.en.md
+++ b/docs/content/user-manual/elasticjob-lite/web-console.en.md
@@ -1,5 +1,5 @@
+++
-pre = "<b>4.11. </b>"
+pre = "<b>4.1.11. </b>"
title = "Console"
weight = 11
chapter = true