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 b53f7da Update user-manual document of elasticjob cloud (#1178)
b53f7da is described below
commit b53f7dac11cc65d901e5e8be40a0bb937d8b34f2
Author: Liang Zhang <[email protected]>
AuthorDate: Mon Jul 20 00:51:05 2020 +0800
Update user-manual document of elasticjob cloud (#1178)
* Update index
* Update deploy-guide.cn
* Update high-availability.cn
* Update web-console.cn
---
README.md | 2 +-
README_ZH.md | 2 +-
docs/content/dev-manual/roadmap.cn.md | 2 +-
docs/content/dev-manual/roadmap.en.md | 2 +-
docs/content/overview/_index.cn.md | 2 +-
docs/content/overview/_index.en.md | 2 +-
.../elasticjob-cloud/configuration/_index.cn.md | 4 +-
.../elasticjob-cloud/operation/_index.cn.md | 2 +-
.../elasticjob-cloud/operation/_index.en.md | 2 +-
.../elasticjob-cloud/operation/deploy-guide.cn.md | 55 ++++++++++------------
.../operation/high-availability.cn.md | 17 ++++---
.../elasticjob-cloud/operation/web-console.cn.md | 19 ++++----
.../elasticjob-cloud/usage/local-executor.cn.md | 2 +-
.../elasticjob-lite/operation/deploy-guide.cn.md | 9 +---
.../elasticjob-lite/operation/deploy-guide.en.md | 17 +++----
.../elasticjob-lite/operation/dump.cn.md | 2 +-
16 files changed, 65 insertions(+), 76 deletions(-)
diff --git a/README.md b/README.md
index 5c43db4..64b7576 100644
--- a/README.md
+++ b/README.md
@@ -87,7 +87,7 @@ Java 8 or above required.
### ZooKeeper
-Zookeeper or above required. [See details](https://zookeeper.apache.org/)
+ZooKeeper or above required. [See details](https://zookeeper.apache.org/)
### Mesos (ElasticJob-Cloud only)
diff --git a/README_ZH.md b/README_ZH.md
index 57f049f..2086211 100644
--- a/README_ZH.md
+++ b/README_ZH.md
@@ -82,7 +82,7 @@ ElasticJob 已于 2020 年 5 月 28 日成为 [Apache
ShardingSphere](https://sh
### ZooKeeper
-请使用 Zookeeper 3.6.0 及其以上版本。[详情参见](https://zookeeper.apache.org/)
+请使用 ZooKeeper 3.6.0 及其以上版本。[详情参见](https://zookeeper.apache.org/)
### Mesos（仅 ElasticJob-Cloud 使用）
diff --git a/docs/content/dev-manual/roadmap.cn.md
b/docs/content/dev-manual/roadmap.cn.md
index d370781..448480f 100644
--- a/docs/content/dev-manual/roadmap.cn.md
+++ b/docs/content/dev-manual/roadmap.cn.md
@@ -33,7 +33,7 @@ chapter = true
- [x] Idempotency
- [x] Reconcile
- [x] Registry Center
- - [x] Zookeeper
+ - [x] ZooKeeper
- [ ] Other Registry Center Supported
- [x] Lifecycle Management
- [x] Add/Remove
diff --git a/docs/content/dev-manual/roadmap.en.md
b/docs/content/dev-manual/roadmap.en.md
index 6437f65..c2b1b10 100644
--- a/docs/content/dev-manual/roadmap.en.md
+++ b/docs/content/dev-manual/roadmap.en.md
@@ -33,7 +33,7 @@ chapter = true
- [x] Idempotency
- [x] Reconcile
- [x] Registry Center
- - [x] Zookeeper
+ - [x] ZooKeeper
- [ ] Other Registry Center Supported
- [x] Lifecycle Management
- [x] Add/Remove
diff --git a/docs/content/overview/_index.cn.md
b/docs/content/overview/_index.cn.md
index 432e6a9..aaffbe2 100644
--- a/docs/content/overview/_index.cn.md
+++ b/docs/content/overview/_index.cn.md
@@ -89,7 +89,7 @@ ElasticJob 已于 2020 年 5 月 28 日成为 [Apache
ShardingSphere](https://sh
### ZooKeeper
-请使用 Zookeeper 3.6.0 及其以上版本。[详情参见](https://zookeeper.apache.org/)
+请使用 ZooKeeper 3.6.0 及其以上版本。[详情参见](https://zookeeper.apache.org/)
### Mesos（仅 ElasticJob-Cloud 使用）
diff --git a/docs/content/overview/_index.en.md
b/docs/content/overview/_index.en.md
index b7e1012..3a3497a 100644
--- a/docs/content/overview/_index.en.md
+++ b/docs/content/overview/_index.en.md
@@ -94,7 +94,7 @@ Java 8 or above required.
### ZooKeeper
-Zookeeper or above required. [See details](https://zookeeper.apache.org/)
+ZooKeeper or above required. [See details](https://zookeeper.apache.org/)
### Mesos (ElasticJob-Cloud only)
diff --git
a/docs/content/user-manual/elasticjob-cloud/configuration/_index.cn.md
b/docs/content/user-manual/elasticjob-cloud/configuration/_index.cn.md
index 91eae92..a3847f4 100644
--- a/docs/content/user-manual/elasticjob-cloud/configuration/_index.cn.md
+++ b/docs/content/user-manual/elasticjob-cloud/configuration/_index.cn.md
@@ -5,7 +5,7 @@ weight = 2
chapter = true
+++
-Elastic-Job-Cloud 提供应用发布及作业注册等 RESTful API， 可通过 curl 操作。
+ElasticJob-Cloud 提供应用发布及作业注册等 RESTful API， 可通过 curl 操作。
## 应用 API
@@ -33,7 +33,7 @@ url：app
**appName:**
-为 Elastic-Job-Cloud 的作业应用唯一标识。
+为 ElasticJob-Cloud 的作业应用唯一标识。
**appURL:**
diff --git a/docs/content/user-manual/elasticjob-cloud/operation/_index.cn.md
b/docs/content/user-manual/elasticjob-cloud/operation/_index.cn.md
index 0da1a9a..30923b4 100644
--- a/docs/content/user-manual/elasticjob-cloud/operation/_index.cn.md
+++ b/docs/content/user-manual/elasticjob-cloud/operation/_index.cn.md
@@ -5,4 +5,4 @@ weight = 3
chapter = true
+++
-TODO
+本章节是 ElasticJob-Cloud 的运维参考手册。
diff --git a/docs/content/user-manual/elasticjob-cloud/operation/_index.en.md
b/docs/content/user-manual/elasticjob-cloud/operation/_index.en.md
index aadf5c0..015d6df 100644
--- a/docs/content/user-manual/elasticjob-cloud/operation/_index.en.md
+++ b/docs/content/user-manual/elasticjob-cloud/operation/_index.en.md
@@ -5,4 +5,4 @@ weight = 3
chapter = true
+++
-TODO
+This chapter is a operation manual for ElasticJob-Cloud.
diff --git
a/docs/content/user-manual/elasticjob-cloud/operation/deploy-guide.cn.md
b/docs/content/user-manual/elasticjob-cloud/operation/deploy-guide.cn.md
index 134a760..1ce18c8 100755
--- a/docs/content/user-manual/elasticjob-cloud/operation/deploy-guide.cn.md
+++ b/docs/content/user-manual/elasticjob-cloud/operation/deploy-guide.cn.md
@@ -4,43 +4,40 @@ weight = 1
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. 启动 ElasticJob-Cloud-Scheduler 和 Mesos 指定作为注册中心的 ZooKeeper
+1. 启动 Mesos Master 和 Mesos Agent
+1. 解压 `elasticjob-cloud-scheduler-${version}.tar.gz`
+1. 执行 `bin\start.sh` 脚本启动 elasticjob-cloud-scheduler
## 作业部署步骤
-1. 确保Zookeeper, Mesos Master/Agent以及Elastic-Job-Cloud-Scheduler已启动。
-
-2.
将打包之后的作业tar.gz文件放至网络可访问的位置，如：ftp或http。打包的tar.gz文件中Main方法需要调用Elastic-Job-Cloud提供的JobBootstrap.execute方法。
+1. 确保 ZooKeeper, Mesos Master/Agent 以及 ElasticJob-Cloud-Scheduler 已正确启动
+1. 将打包作业的 tar.gz 文件放至网络可访问的位置，如：ftp或http。打包的 tar.gz 文件中 `main` 方法需要调用
ElasticJob-Cloud 提供的 `JobBootstrap.execute` 方法
+1. 使用 curl 命令调用 RESTful API
发布应用及注册作业。详情请参见：[配置指南](/cn/user-manual/elasticjob-cloud/configuration)
-3. 使用curl命令调用REST API注册APP及作业，详情参见：[RESTful API](/02-guide/cloud-restful-api)。
+## 调度器配置步骤
-# 附录
+可修改 `conf\elasticjob-cloud-scheduler.properties` 文件变更系统配置。
-* 配置：修改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 | 否 | |
作业事件追踪数据库密码
|
+| 属性名称 | 是否必填 | 默认值 | 描述
|
+| ------------------------ |:------- |:-------------------------
|:------------------------------------------------------------------------------------------
|
+| 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 |
ElasticJob-Cloud 所使用的 ZooKeeper 地址
|
+| zk_namespace | 否 | elasticjob-cloud |
ElasticJob-Cloud 所使用的 ZooKeeper 命名空间
|
+| zk_digest | 否 | |
ElasticJob-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杀进程。
+* 停止：不提供停止脚本，可直接使用 kill 命令终止进程。
diff --git
a/docs/content/user-manual/elasticjob-cloud/operation/high-availability.cn.md
b/docs/content/user-manual/elasticjob-cloud/operation/high-availability.cn.md
index c0aae0b..ab312b7 100755
---
a/docs/content/user-manual/elasticjob-cloud/operation/high-availability.cn.md
+++
b/docs/content/user-manual/elasticjob-cloud/operation/high-availability.cn.md
@@ -6,17 +6,20 @@ chapter = true
## 介绍
-调度器的高可用是通过运行几个指向同一个ZooKeeper集群的Elastic-Job-Cloud-Scheduler实例来实现的。ZooKeeper用于在当前主Elastic-Job-Cloud-Scheduler实例失败的情况下执行领导者选举。通过至少两个调度器实例来构成集群，集群中只有一个调度器实例提供服务，其他实例处于"待命"状态。当该实例失败时，集群会选举剩余实例中的一个来继续提供服务。
+调度器的高可用是通过运行几个指向同一个 ZooKeeper 集群的 ElasticJob-Cloud-Scheduler 实例来实现的。
+ZooKeeper 用于在当前主 ElasticJob-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相关配置为：
+每个 ElasticJob-Cloud-Scheduler 实例必须使用相同的 ZooKeeper 集群。
+例如，如果 ZooKeeper 的 Quorum 为
zk://1.2.3.4:2181,2.3.4.5:2181,3.4.5.6:2181/elasticjob-cloud，则
`elasticjob-cloud-scheduler.properties` 中 ZooKeeper 相关配置为：
```properties
-# Elastic-Job-Cloud's zookeeper address
+# ElasticJob-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
+# ElasticJob-Cloud's ZooKeeper namespace
+zk_namespace=elasticjob-cloud
+```
diff --git
a/docs/content/user-manual/elasticjob-cloud/operation/web-console.cn.md
b/docs/content/user-manual/elasticjob-cloud/operation/web-console.cn.md
index fe81dbe..10273e2 100755
--- a/docs/content/user-manual/elasticjob-cloud/operation/web-console.cn.md
+++ b/docs/content/user-manual/elasticjob-cloud/operation/web-console.cn.md
@@ -4,22 +4,21 @@ weight = 3
chapter = true
+++
-运维平台内嵌于elastic-job-cloud-scheduler的jar包中, 无需额外启动WEB付服务器,
可通过修改配置文件中http_port参数来调整启动端口,默认端口为8899，访问地址为http://{your_scheduler_ip}:8899。
+运维平台内嵌于 elasticjob-cloud-scheduler 的 jar 包中，无需额外启动 WEB 服务器。
+可通过修改配置文件中 http_port 参数来调整启动端口,默认端口为 8899，访问地址为
`http://{your_scheduler_ip}:8899`。
## 登录
-提供两种账户，管理员及访客，管理员拥有全部操作权限，访客仅拥有察看权限。默认管理员用户名和密码是root/root，访客用户名和密码是guest/guest，可通过conf\auth.properties修改管理员及访客用户名及密码。
+提供两种账户，管理员及访客，管理员拥有全部操作权限，访客仅拥有察看权限。
+默认管理员用户名和密码是 root/root，访客用户名和密码是 guest/guest，可通过 `conf\auth.properties`
修改管理员及访客用户名及密码。
## 功能列表
-* 作业APP管理（发布、修改、查看）
-
-* 作业管理（注册、修改、查看以及删除）
-
-* 作业状态查看（待运行、运行中、待失效转移）
-
-* 作业历史查看（运行轨迹、执行状态、历史dashboard）
+- 应用管理（发布、修改、查看）
+- 作业管理（注册、修改、查看以及删除）
+- 作业状态查看（待运行、运行中、待失效转移）
+- 作业历史查看（运行轨迹、执行状态、历史仪表盘）
## 设计理念
-运维平台采用纯静态HTML+JS方式与后台的RESTful
API交互，通过读取作业注册中心展示作业配置和状态，数据库展现作业运行轨迹及执行状态，或更新作业注册中心数据修改作业配置。
+运维平台采用纯静态 HTML + JavaScript 方式与后台的 RESTful API
交互，通过读取作业注册中心展示作业配置和状态，数据库展现作业运行轨迹及执行状态，或更新作业注册中心数据修改作业配置。
diff --git
a/docs/content/user-manual/elasticjob-cloud/usage/local-executor.cn.md
b/docs/content/user-manual/elasticjob-cloud/usage/local-executor.cn.md
index fdded84..c4148fc 100755
--- a/docs/content/user-manual/elasticjob-cloud/usage/local-executor.cn.md
+++ b/docs/content/user-manual/elasticjob-cloud/usage/local-executor.cn.md
@@ -4,7 +4,7 @@ weight = 2
chapter = true
+++
-在开发 Elastic-Job-Cloud 作业时，开发人员可以脱离 Mesos 环境，在本地运行和调试作业。
+在开发 ElasticJob-Cloud 作业时，开发人员可以脱离 Mesos 环境，在本地运行和调试作业。
可以利用本地运行模式充分的调试业务功能以及单元测试，完成之后再部署至 Mesos 集群。
本地运行作业无需安装 Mesos 环境。
diff --git
a/docs/content/user-manual/elasticjob-lite/operation/deploy-guide.cn.md
b/docs/content/user-manual/elasticjob-lite/operation/deploy-guide.cn.md
index 155dbbe..bf0afc7 100644
--- a/docs/content/user-manual/elasticjob-lite/operation/deploy-guide.cn.md
+++ b/docs/content/user-manual/elasticjob-lite/operation/deploy-guide.cn.md
@@ -6,18 +6,13 @@ chapter = true
## 应用部署
-1. 启动 ElasticJob-Lite 指定注册中心的 Zookeeper。
-
+1. 启动 ElasticJob-Lite 指定注册中心的 ZooKeeper。
1. 运行包含 ElasticJob-Lite 和业务代码的 jar 文件。不限于 jar 或 war 的启动方式。
-
1. 当作业服务器配置多网卡时，可通过设置系统变量 `elasticjob.preferred.network.interface`
指定网卡地址。ElasticJob 默认获取网卡列表中第一个非回环可用 IPV4 地址。
## 运维平台和 RESTFul API 部署(可选)
1. 解压缩 `elasticjob-lite-console-${version}.tar.gz` 并执行 `bin\start.sh`。
-
1. 打开浏览器访问 `http://localhost:8899/` 即可访问控制台。8899 为默认端口号，可通过启动脚本输入 `-p` 自定义端口号。
-
1. 访问 RESTFul API 方法同控制台。
-
-1. `elasticjob-lite-console-${version}.tar.gz`可通过 `mvn install` 编译获取。
+1. `elasticjob-lite-console-${version}.tar.gz` 可通过 `mvn install` 编译获取。
diff --git
a/docs/content/user-manual/elasticjob-lite/operation/deploy-guide.en.md
b/docs/content/user-manual/elasticjob-lite/operation/deploy-guide.en.md
index d6505c6..fb27b7d 100644
--- a/docs/content/user-manual/elasticjob-lite/operation/deploy-guide.en.md
+++ b/docs/content/user-manual/elasticjob-lite/operation/deploy-guide.en.md
@@ -6,19 +6,14 @@ chapter = true
## Application deployment
-1. Start the Zookeeper of the ElasticJob-Lite designated registry.
-
-2. Run the jar file containing ElasticJob-Lite and business code. It is not
limited to the startup mode of jar or war.
-
-3. When the job server is configured with multiple network cards, the network
card address can be specified by setting the system variable
`elasticjob.preferred.network.interface`. ElasticJob obtains the first
non-loopback available IPV4 address in the network card list by default.
+1. Start the ZooKeeper of the ElasticJob-Lite designated registry.
+1. Run the jar file containing ElasticJob-Lite and business code. It is not
limited to the startup mode of jar or war.
+1. When the job server is configured with multiple network cards, the network
card address can be specified by setting the system variable
`elasticjob.preferred.network.interface`. ElasticJob obtains the first
non-loopback available IPV4 address in the network card list by default.
## Operation and maintenance platform and RESTFul API deployment (optional)
1. Unzip `elasticjob-lite-console-${version}.tar.gz` and execute
`bin\start.sh`.
-
-2. Open the browser and visit `http://localhost:8899/` to access the console.
8899 is the default port number. You can customize the port number by entering
`-p` through the startup script.
-
-3. The method of accessing RESTFul API is the same as the console.
-
-4. `elasticjob-lite-console-${version}.tar.gz` can be obtained by compiling
`mvn install`.
+1. Open the browser and visit `http://localhost:8899/` to access the console.
8899 is the default port number. You can customize the port number by entering
`-p` through the startup script.
+1. The method of accessing RESTFul API is the same as the console.
+1. `elasticjob-lite-console-${version}.tar.gz` can be obtained by compiling
`mvn install`.
diff --git a/docs/content/user-manual/elasticjob-lite/operation/dump.cn.md
b/docs/content/user-manual/elasticjob-lite/operation/dump.cn.md
index 8f7872d..5fbf87b 100644
--- a/docs/content/user-manual/elasticjob-lite/operation/dump.cn.md
+++ b/docs/content/user-manual/elasticjob-lite/operation/dump.cn.md
@@ -16,7 +16,7 @@ chapter = true
## 执行导出命令
-导出命令完全参照 Zookeeper 的四字命令理念。
+导出命令完全参照 ZooKeeper 的四字命令理念。
**导出至标准输出**
