diff --git a/pom.xml b/pom.xml
index 2a3fc49d..4ab9057c 100644
--- a/pom.xml
+++ b/pom.xml
@@ -87,7 +87,7 @@
${java.version}
-
+
org.apache.maven.plugins
maven-source-plugin
@@ -121,9 +121,9 @@
maven-javadoc-plugin
${maven-javadoc-plugin.version}
-
+
false
-
+
-Xdoclint:none
@@ -164,7 +164,7 @@
-
+
dev
@@ -173,7 +173,7 @@
-
+
org.apache.maven.plugins
maven-compiler-plugin
@@ -185,7 +185,7 @@
${java.version}
-
+
org.apache.maven.plugins
maven-jar-plugin
diff --git a/powerjob-client/pom.xml b/powerjob-client/pom.xml
index 8a8a6621..71f1c2ba 100644
--- a/powerjob-client/pom.xml
+++ b/powerjob-client/pom.xml
@@ -37,7 +37,7 @@
${powerjob.common.version}
-
+
org.junit.jupiter
junit-jupiter-api
diff --git a/powerjob-common/pom.xml b/powerjob-common/pom.xml
index b1e2d8e3..22125af3 100644
--- a/powerjob-common/pom.xml
+++ b/powerjob-common/pom.xml
@@ -76,7 +76,7 @@
${commons.io.version}
-
+
org.junit.jupiter
junit-jupiter-api
diff --git a/powerjob-common/src/main/java/com/github/kfcfans/powerjob/common/model/DeployedContainerInfo.java b/powerjob-common/src/main/java/com/github/kfcfans/powerjob/common/model/DeployedContainerInfo.java
index 56a0c7f0..67e8deda 100644
--- a/powerjob-common/src/main/java/com/github/kfcfans/powerjob/common/model/DeployedContainerInfo.java
+++ b/powerjob-common/src/main/java/com/github/kfcfans/powerjob/common/model/DeployedContainerInfo.java
@@ -6,7 +6,7 @@ import lombok.Data;
import lombok.NoArgsConstructor;
/**
- * 已部署的容器信息
+ * The class for deployed container.
*
* @author tjq
* @since 2020/5/18
@@ -16,12 +16,20 @@ import lombok.NoArgsConstructor;
@AllArgsConstructor
public class DeployedContainerInfo implements OmsSerializable {
- // 容器ID
+ /**
+ * Id of the container.
+ */
private Long containerId;
- // 版本
+ /**
+ * Version of the container.
+ */
private String version;
- // 部署时间
+ /**
+ * Deploy timestamp.
+ */
private long deployedTime;
- // 机器地址(无需上报)
+ /**
+ * Address of the server. Report is not required.
+ */
private String workerAddress;
}
diff --git a/powerjob-common/src/main/java/com/github/kfcfans/powerjob/common/model/GitRepoInfo.java b/powerjob-common/src/main/java/com/github/kfcfans/powerjob/common/model/GitRepoInfo.java
index 2ef2fa69..75a8c964 100644
--- a/powerjob-common/src/main/java/com/github/kfcfans/powerjob/common/model/GitRepoInfo.java
+++ b/powerjob-common/src/main/java/com/github/kfcfans/powerjob/common/model/GitRepoInfo.java
@@ -3,19 +3,27 @@ package com.github.kfcfans.powerjob.common.model;
import lombok.Data;
/**
- * Git代码库信息
+ * The class for Git Repository.
*
* @author tjq
* @since 2020/5/17
*/
@Data
public class GitRepoInfo {
- // 仓库地址
+ /**
+ * Address of Git repository.
+ */
private String repo;
- // 分支名称
+ /**
+ * Name of the branch.
+ */
private String branch;
- // 用户名
+ /**
+ * username of Git.
+ */
private String username;
- // 密码
+ /**
+ * Password of Git.
+ */
private String password;
}
diff --git a/powerjob-server/pom.xml b/powerjob-server/pom.xml
index 83885a05..46956b5a 100644
--- a/powerjob-server/pom.xml
+++ b/powerjob-server/pom.xml
@@ -17,7 +17,7 @@
2.9.2
2.3.4.RELEASE
3.4.2
-
+
8.0.19
19.7.0.0
7.4.1.jre8
@@ -32,7 +32,7 @@
1.2.68
1.0.1
-
+
true
@@ -136,42 +136,42 @@
test
-
+
net.lingala.zip4j
zip4j
${zip4j.version}
-
+
org.eclipse.jgit
org.eclipse.jgit
${jgit.version}
-
+
commons-net
commons-net
${commons.net.version}
-
+
org.apache.maven.shared
maven-invoker
${mvn.invoker.version}
-
+
com.alibaba
fastjson
${fastjson.version}
-
+
com.aliyun
alibaba-dingtalk-service-sdk
@@ -185,7 +185,6 @@
-
io.springfox
@@ -201,7 +200,7 @@
-
+
@@ -215,7 +214,7 @@
build-info
- repackage
+ repackage
diff --git a/powerjob-server/src/main/java/com/github/kfcfans/powerjob/server/OhMyApplication.java b/powerjob-server/src/main/java/com/github/kfcfans/powerjob/server/OhMyApplication.java
index ddb10420..bbcc5c64 100644
--- a/powerjob-server/src/main/java/com/github/kfcfans/powerjob/server/OhMyApplication.java
+++ b/powerjob-server/src/main/java/com/github/kfcfans/powerjob/server/OhMyApplication.java
@@ -7,7 +7,7 @@ import org.springframework.boot.autoconfigure.SpringBootApplication;
import org.springframework.scheduling.annotation.EnableScheduling;
/**
- * SpringBoot 启动入口
+ * SpringBoot entry.
*
* @author tjq
* @since 2020/3/29
@@ -26,16 +26,16 @@ public class OhMyApplication {
public static void main(String[] args) {
- // 完成前置工作
+ // Print tips before starting.
pre();
- // 先启动 ActorSystem
+ // Init ActorSystem
OhMyServer.init();
- // 再启动SpringBoot
+ // Start SpringBoot application.
try {
SpringApplication.run(OhMyApplication.class, args);
- }catch (Throwable t) {
+ } catch (Throwable t) {
log.error(TIPS);
throw t;
}
diff --git a/powerjob-server/src/main/resources/application-daily.properties b/powerjob-server/src/main/resources/application-daily.properties
index 18bb67ef..a0b1c299 100644
--- a/powerjob-server/src/main/resources/application-daily.properties
+++ b/powerjob-server/src/main/resources/application-daily.properties
@@ -1,7 +1,7 @@
oms.env=DAILY
logging.config=classpath:logback-dev.xml
-####### 外部数据库配置(需要用户更改为自己的数据库配置) #######
+####### Database properties(Configure according to the the environment) #######
spring.datasource.core.driver-class-name=com.mysql.cj.jdbc.Driver
spring.datasource.core.jdbc-url=jdbc:mysql://localhost:3306/powerjob-daily?useUnicode=true&characterEncoding=UTF-8&serverTimezone=Asia/Shanghai
spring.datasource.core.username=root
@@ -9,11 +9,12 @@ spring.datasource.core.password=No1Bug2Please3!
spring.datasource.core.hikari.maximum-pool-size=20
spring.datasource.core.hikari.minimum-idle=5
-####### mongoDB配置,非核心依赖,通过配置 oms.mongodb.enable=false 来关闭 #######
+####### MongoDB properties(Non-core configuration properties) #######
+####### configure oms.mongodb.enable=false to disable mongodb #######
oms.mongodb.enable=true
spring.data.mongodb.uri=mongodb+srv://zqq:No1Bug2Please3!@cluster0.wie54.gcp.mongodb.net/powerjob_daily?retryWrites=true&w=majority
-####### 邮件配置(不需要邮件报警可以删除以下配置来避免报错) #######
+####### Email properties(Comment out the mail properties if you do not have needs) #######
spring.mail.host=smtp.163.com
spring.mail.username=zqq@163.com
spring.mail.password=GOFZPNARMVKCGONV
@@ -21,18 +22,19 @@ spring.mail.properties.mail.smtp.auth=true
spring.mail.properties.mail.smtp.starttls.enable=true
spring.mail.properties.mail.smtp.starttls.required=true
-####### 钉钉报警配置(不需要钉钉报警可以删除以下配置来避免报错) #######
+####### DingTalk properties(Comment out the DingTalk properties if you do not have needs) #######
oms.alarm.ding.app-key=dingauqwkvxxnqskknfv
oms.alarm.ding.app-secret=XWrEPdAZMPgJeFtHuL0LH73LRj-74umF2_0BFcoXMfvnX0pCQvt0rpb1JOJU_HLl
oms.alarm.ding.agent-id=847044348
-####### 资源清理配置 #######
+####### Resource cleaning properties #######
oms.instanceinfo.retention=1
oms.container.retention.local=1
oms.container.retention.remote=-1
-####### 缓存配置 #######
+####### Cache properties #######
oms.instance.metadata.cache.size=1024
-####### 精确获取 server 的百分比,0~100,100代表每次 worker 获取 server 都会进行完整的探活流程,不存在脑裂问题,但有性能开销 #######
+####### Threshold in fetching server(0~100). 100 means full detection of server, in which #######
+####### split-brain could be avoided while performance overhead would increase. #######
oms.accurate.select.server.percentage = 50
\ No newline at end of file
diff --git a/powerjob-server/src/main/resources/application-pre.properties b/powerjob-server/src/main/resources/application-pre.properties
index 496d84ab..f0f27100 100644
--- a/powerjob-server/src/main/resources/application-pre.properties
+++ b/powerjob-server/src/main/resources/application-pre.properties
@@ -1,7 +1,7 @@
oms.env=PRE
logging.config=classpath:logback-product.xml
-####### 数据库配置 #######
+####### Database properties(Configure according to the the environment) #######
spring.datasource.core.driver-class-name=com.mysql.cj.jdbc.Driver
spring.datasource.core.jdbc-url=jdbc:mysql://remotehost:3306/powerjob-pre?useUnicode=true&characterEncoding=UTF-8&serverTimezone=Asia/Shanghai
spring.datasource.core.username=root
@@ -9,11 +9,12 @@ spring.datasource.core.password=No1Bug2Please3!
spring.datasource.core.hikari.maximum-pool-size=20
spring.datasource.core.hikari.minimum-idle=5
-####### mongoDB配置,非核心依赖,通过配置 oms.mongodb.enable=false 来关闭 #######
+####### MongoDB properties(Non-core configuration properties) #######
+####### configure oms.mongodb.enable=false to disable mongodb #######
oms.mongodb.enable=true
spring.data.mongodb.uri=mongodb://remotehost:27017/powerjob-pre
-####### 邮件配置(不需要邮件报警可以删除以下配置来避免报错) #######
+####### Email properties(Comment out the mail properties if you do not have needs) #######
spring.mail.host=smtp.qq.com
spring.mail.username=zqq
spring.mail.password=qqz
@@ -21,18 +22,19 @@ spring.mail.properties.mail.smtp.auth=true
spring.mail.properties.mail.smtp.starttls.enable=true
spring.mail.properties.mail.smtp.starttls.required=true
-####### 钉钉报警配置(不需要钉钉报警可以删除以下配置来避免报错) #######
+####### DingTalk properties(Comment out the DingTalk properties if you do not have needs) #######
oms.alarm.ding.app-key=dingauqwkvxxnqskknfv
oms.alarm.ding.app-secret=XWrEPdAZMPgJeFtHuL0LH73LRj-74umF2_0BFcoXMfvnX0pCQvt0rpb1JOJU_HLl
oms.alarm.ding.agent-id=847044348
-####### 资源清理配置 #######
+####### Resource cleaning properties #######
oms.instanceinfo.retention=3
oms.container.retention.local=3
oms.container.retention.remote=-1
-####### 缓存配置 #######
+####### Cache properties #######
oms.instance.metadata.cache.size=1024
-####### 精确获取 server 的百分比,0~100,100代表每次 worker 获取 server 都会进行完整的探活流程,不存在脑裂问题,但有性能开销 #######
+####### Threshold in fetching server(0~100). 100 means full detection of server, in which #######
+####### split-brain could be avoided while performance overhead would increase. #######
oms.accurate.select.server.percentage = 50
\ No newline at end of file
diff --git a/powerjob-server/src/main/resources/application-product.properties b/powerjob-server/src/main/resources/application-product.properties
index 15ee98e4..8b6baad6 100644
--- a/powerjob-server/src/main/resources/application-product.properties
+++ b/powerjob-server/src/main/resources/application-product.properties
@@ -1,7 +1,7 @@
oms.env=PRODUCT
logging.config=classpath:logback-product.xml
-####### 数据库配置 #######
+####### Database properties(Configure according to the the environment) #######
spring.datasource.core.driver-class-name=com.mysql.cj.jdbc.Driver
spring.datasource.core.jdbc-url=jdbc:mysql://localhost:3306/powerjob-product?useUnicode=true&characterEncoding=UTF-8&serverTimezone=Asia/Shanghai
spring.datasource.core.username=root
@@ -9,11 +9,12 @@ spring.datasource.core.password=No1Bug2Please3!
spring.datasource.core.hikari.maximum-pool-size=20
spring.datasource.core.hikari.minimum-idle=5
-####### mongoDB配置,非核心依赖,通过配置 oms.mongodb.enable=false 来关闭 #######
+####### MongoDB properties(Non-core configuration properties) #######
+####### configure oms.mongodb.enable=false to disable mongodb #######
oms.mongodb.enable=true
spring.data.mongodb.uri=mongodb://localhost:27017/powerjob-product
-####### 邮件配置(不需要邮件报警可以删除以下配置来避免报错) #######
+####### Email properties(Comment out the mail properties if you do not have needs) #######
spring.mail.host=smtp.qq.com
spring.mail.username=zqq
spring.mail.password=qqz
@@ -21,18 +22,19 @@ spring.mail.properties.mail.smtp.auth=true
spring.mail.properties.mail.smtp.starttls.enable=true
spring.mail.properties.mail.smtp.starttls.required=true
-####### 钉钉报警配置(不需要钉钉报警可以删除以下配置来避免报错) #######
+####### DingTalk properties(Comment out the DingTalk properties if you do not have needs) #######
oms.alarm.ding.app-key=
oms.alarm.ding.app-secret=
oms.alarm.ding.agent-id=
-####### 资源清理配置 #######
+####### Resource cleaning properties #######
oms.instanceinfo.retention=7
oms.container.retention.local=7
oms.container.retention.remote=-1
-####### 缓存配置 #######
+####### Cache properties #######
oms.instance.metadata.cache.size=2048
-####### 精确获取 server 的百分比,0~100,100代表每次 worker 获取 server 都会进行完整的探活流程,不存在脑裂问题,但有性能开销 #######
+####### Threshold in fetching server(0~100). 100 means full detection of server, in which #######
+####### split-brain could be avoided while performance overhead would increase. #######
oms.accurate.select.server.percentage = 50
\ No newline at end of file
diff --git a/powerjob-server/src/main/resources/application.properties b/powerjob-server/src/main/resources/application.properties
index d91d0684..002de73c 100644
--- a/powerjob-server/src/main/resources/application.properties
+++ b/powerjob-server/src/main/resources/application.properties
@@ -1,4 +1,4 @@
-# http 服务端口
+# Http server port
server.port=7700
spring.profiles.active=daily
@@ -7,14 +7,14 @@ spring.jpa.open-in-view=false
spring.data.mongodb.repositories.type=none
logging.level.org.mongodb=warn
-# 文件上传配置
+# Configuration for uploading files.
spring.servlet.multipart.enabled=true
spring.servlet.multipart.file-size-threshold=0
spring.servlet.multipart.max-file-size=209715200
spring.servlet.multipart.max-request-size=209715200
-###### PowerJob 自身配置(该配置只允许存在于 application.properties 文件中) ######
-# akka ActorSystem 服务端口
+###### PowerJob self-owned configuration (The following properties should exist in application.properties only). ######
+# Akka ActorSystem port.
oms.akka.port=10086
-# 表前缀(默认无表前缀,有需求直接填入表前缀即可,比如 pj_ )
+# Prefix for all tables. Default empty string. Config if you have needs, i.e. pj_
oms.table-prefix=
\ No newline at end of file
diff --git a/powerjob-server/src/main/resources/logback-dev.xml b/powerjob-server/src/main/resources/logback-dev.xml
index ec9b4011..3fdd2c66 100644
--- a/powerjob-server/src/main/resources/logback-dev.xml
+++ b/powerjob-server/src/main/resources/logback-dev.xml
@@ -1,18 +1,18 @@
-
+
-
-
+
+
-
+
-
+
${CONSOLE_LOG_PATTERN}
@@ -20,13 +20,13 @@
-
+
-
+
-
+
diff --git a/powerjob-server/src/main/resources/logback-product.xml b/powerjob-server/src/main/resources/logback-product.xml
index 2be6e263..9ccddcd9 100644
--- a/powerjob-server/src/main/resources/logback-product.xml
+++ b/powerjob-server/src/main/resources/logback-product.xml
@@ -1,20 +1,20 @@
-
+
-
+
-
+
+ Log path, pay attention to permission, logs may be unable to generate.
+ Bug recording: Setting `~/logs`, is unable to create folder in user home directory,
+ a folder with the name ~ is created in project folder.
+ -->
-
-
+
${LOG_PATH}/powerjob-server-error.log
@@ -31,9 +31,9 @@
DENY
-
+
-
+
${LOG_PATH}/powerjob-server-web.log
@@ -49,9 +49,9 @@
-
+
-
+
${LOG_PATH}/powerjob-server-application.log
@@ -64,7 +64,7 @@
true
-
+
diff --git a/powerjob-worker-agent/pom.xml b/powerjob-worker-agent/pom.xml
index 94ea9386..4761e8b2 100644
--- a/powerjob-worker-agent/pom.xml
+++ b/powerjob-worker-agent/pom.xml
@@ -50,7 +50,6 @@
-
@@ -63,7 +62,7 @@
- repackage
+ repackage
diff --git a/powerjob-worker-samples/src/main/resources/application.properties b/powerjob-worker-samples/src/main/resources/application.properties
index 17bfa59f..79e356e3 100644
--- a/powerjob-worker-samples/src/main/resources/application.properties
+++ b/powerjob-worker-samples/src/main/resources/application.properties
@@ -1,15 +1,13 @@
server.port=8081
-
spring.jpa.open-in-view=false
-
-########### powerjob-worker 配置(老配置 powerjob.xxx 即将废弃,请使用 powerjob.worker.xxx) ###########
-# akka 工作端口,可选,默认 27777
+########### PowerJob-worker properties. ###########
+# Akka port, default is 27777
powerjob.worker.akka-port=27777
-# 接入应用名称,用于分组隔离,推荐填写 本 Java 项目名称
+# Application name, used for grouping applications. Recommend to set the same value as project name.
powerjob.worker.app-name=powerjob-agent-test
-# 调度服务器地址,IP:Port 或 域名,多值逗号分隔
+# Address of PowerJob-server node(s). Ip:port or domain. Multiple addresses should be separated with comma.
powerjob.worker.server-address=127.0.0.1:7700,127.0.0.1:7701
-# 持久化方式,可选,默认 disk
+# Store strategy of H2 database. disk or memory. Default value is disk.
powerjob.worker.store-strategy=disk
-# 返回值最大长度,默认 8096
+# Max length of result. Results that are longer than the value will be truncated.
powerjob.worker.max-result-length=4096
\ No newline at end of file