From da4d57e16254e4fead32a615e4589781ba01db46 Mon Sep 17 00:00:00 2001 From: terrymanu Date: Fri, 5 Feb 2016 19:08:34 +0800 Subject: [PATCH] update docs for #16 --- .../com/dangdang/ddframe/job/api/JobConfiguration.java | 10 +++++----- .../ddframe/reg/zookeeper/ZookeeperConfiguration.java | 1 + elastic-job-doc/content/post/directory_structure.md | 4 ---- elastic-job-doc/content/post/release_notes.md | 4 ++++ elastic-job-doc/content/post/usage.md | 2 +- elastic-job-doc/content/post/user_guide.md | 6 ++++-- 6 files changed, 15 insertions(+), 12 deletions(-) diff --git a/elastic-job-core/src/main/java/com/dangdang/ddframe/job/api/JobConfiguration.java b/elastic-job-core/src/main/java/com/dangdang/ddframe/job/api/JobConfiguration.java index 36501f8fad..d3eb6eacd5 100644 --- a/elastic-job-core/src/main/java/com/dangdang/ddframe/job/api/JobConfiguration.java +++ b/elastic-job-core/src/main/java/com/dangdang/ddframe/job/api/JobConfiguration.java @@ -134,6 +134,11 @@ public class JobConfiguration { */ private boolean misfire = true; + /** + * 作业辅助监控端口. + */ + private int monitorPort = -1; + /** * 作业分片策略实现类全路径. * @@ -159,9 +164,4 @@ public class JobConfiguration { * 如果可覆盖, 每次启动作业都以本地配置为准. */ private boolean overwrite; - - /** - * 作业辅助监控端口. - */ - private int monitorPort = -1; } diff --git a/elastic-job-core/src/main/java/com/dangdang/ddframe/reg/zookeeper/ZookeeperConfiguration.java b/elastic-job-core/src/main/java/com/dangdang/ddframe/reg/zookeeper/ZookeeperConfiguration.java index 6596b010c1..0d86547b9e 100644 --- a/elastic-job-core/src/main/java/com/dangdang/ddframe/reg/zookeeper/ZookeeperConfiguration.java +++ b/elastic-job-core/src/main/java/com/dangdang/ddframe/reg/zookeeper/ZookeeperConfiguration.java @@ -90,6 +90,7 @@ public class ZookeeperConfiguration extends AbstractRegistryCenterConfiguration /** * 内嵌Zookeeper的数据存储路径. + * 为空表示不开启内嵌Zookeeper. */ private String nestedDataDir; diff --git a/elastic-job-doc/content/post/directory_structure.md b/elastic-job-doc/content/post/directory_structure.md index ca15651b62..5c390671f5 100644 --- a/elastic-job-doc/content/post/directory_structure.md +++ b/elastic-job-doc/content/post/directory_structure.md @@ -22,10 +22,6 @@ weight=4 使用示例。 -## elastic-job-test - -测试`elastic-job`使用的公用类，使用方无需关注。 - ## elastic-job-doc 使用`markdown`生成文档的项目，使用方无需关注。 diff --git a/elastic-job-doc/content/post/release_notes.md b/elastic-job-doc/content/post/release_notes.md index c445fd0837..bbfd1fdf3d 100644 --- a/elastic-job-doc/content/post/release_notes.md +++ b/elastic-job-doc/content/post/release_notes.md @@ -6,6 +6,10 @@ weight=1 # Release Notes +## 1.0.4-snapshot +1. 精简项目模块，移除elastic-job-test模块 +1. 功能提升Issuse#16，提供内嵌zookeeper，简化开发环境 + ## 1.0.3 1. 修正Issuse#30，注册中心宕机较长时间后重新恢复，作业仍然无法继续执行 1. 修正Issuse#36，任务在控制台暂停之后，无法恢复运行 diff --git a/elastic-job-doc/content/post/usage.md b/elastic-job-doc/content/post/usage.md index bcb024e3ed..4b593e561b 100644 --- a/elastic-job-doc/content/post/usage.md +++ b/elastic-job-doc/content/post/usage.md @@ -12,7 +12,7 @@ weight=5 ## 安装Zookeeper -请使用`Zookeeper 3.4.6`及其以上版本。[详情参见](https://zookeeper.apache.org/doc/trunk/zookeeperStarted.html) +请使用`Zookeeper 3.4.6`及其以上版本。[详情参见](https://zookeeper.apache.org/doc/trunk/zookeeperStarted.html)。或使用`elastic-job`自带的内嵌`Zookeeper` ## 安装Maven diff --git a/elastic-job-doc/content/post/user_guide.md b/elastic-job-doc/content/post/user_guide.md index 06c6a73eb5..a90a75d578 100644 --- a/elastic-job-doc/content/post/user_guide.md +++ b/elastic-job-doc/content/post/user_guide.md @@ -165,7 +165,7 @@ public class XXXSimpleJob extends AbstractSimpleElasticJob { |failover |boolean|否 |false| 是否开启失效转移
仅`monitorExecution`开启，失效转移才有效 | |misfire |boolean|否 |true | 是否开启错过任务重新执行 | |jobShardingStrategyClass |String |否 |true | 作业分片策略实现类全路径
默认使用平均分配策略
详情参见：[作业分片策略](http://dangdangdotcom.github.io/elastic-job/post/job_strategy) | -|description |String |否 | | 作业描述信息 | +|description |String |否 | | 作业描述信息 | | disabled |boolean|否 |false| 作业是否禁止启动
可用于部署作业时，先禁止启动，部署结束后统一启动 | | overwrite |boolean|否 |false| 本地配置是否可覆盖注册中心配置
如果可覆盖，每次启动作业都以本地配置为准 | @@ -181,7 +181,9 @@ public class XXXSimpleJob extends AbstractSimpleElasticJob { |maxRetries |int |`是` | | 最大重试次数 | |sessionTimeoutMilliseconds |int |否 |60000| 会话超时时间
单位：毫秒 | |connectionTimeoutMilliseconds |int |否 |15000| 连接超时时间
单位：毫秒 | -|digest |String |否 |无验证| 连接Zookeeper的权限令牌
缺省为不需要权限验证 | +|digest |String |否 |无验证| 连接`Zookeeper`的权限令牌
缺省为不需要权限验证 | +|nestedPort |int |否 |-1 | 内嵌`Zookeeper`的端口号
-1表示不开启内嵌`Zookeeper` | +|nestedDataDir |String |否 | | 内嵌`Zookeeper`的数据存储路径
为空表示不开启内嵌`Zookeeper` | ### 基于Spring但不使用命名空间