You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@dolphinscheduler.apache.org by le...@apache.org on 2021/10/29 04:30:50 UTC
[dolphinscheduler-website] branch master updated: add plugin
version description (#477)
This is an automated email from the ASF dual-hosted git repository.
leonbao pushed a commit to branch master
in repository https://gitbox.apache.org/repos/asf/dolphinscheduler-website.git
The following commit(s) were added to refs/heads/master by this push:
new 2e5d358 add plugin version description (#477)
2e5d358 is described below
commit 2e5d3589bb2cba04ee728d27ddea1ed8583e3ea2
Author: Kirs <ac...@163.com>
AuthorDate: Fri Oct 29 12:30:45 2021 +0800
add plugin version description (#477)
* add plugin version description
* add plugin version description
* fix typo
---
development/en-us/backend/spi/alert.md | 8 +++++++-
development/en-us/backend/spi/registry.md | 8 +++++---
development/en-us/backend/spi/task.md | 6 ++++--
development/zh-cn/backend/spi/alert.md | 8 ++++++--
development/zh-cn/backend/spi/registry.md | 8 +++++---
development/zh-cn/backend/spi/task.md | 6 ++++--
6 files changed, 31 insertions(+), 13 deletions(-)
diff --git a/development/en-us/backend/spi/alert.md b/development/en-us/backend/spi/alert.md
index 9957be5..9505a6d 100644
--- a/development/en-us/backend/spi/alert.md
+++ b/development/en-us/backend/spi/alert.md
@@ -96,8 +96,14 @@ The specific design of alert_spi can be found in issue: [Alert Plugin Design](ht
In fact, it's very easy to implement a plugin by yourself, you only need to care about the plugin extension interface. In Alert you only need to care about the AlertChannelFactory and AlertChannel. We would recommend that you follow the design specifications of other built-in plugins so that when your idea is good enough, you can donate it to the community without having to change it too much.
-When you have finished developing the relevant code, configure the relevant plug-ins in alert.properties (or just configure a plug-in directory and it will load all the plug-ins in that directory).
+When you complete the development of the relevant code, you need to execute `mvn -U install -Dmaven.test.skip=true` to install the plug-in and generate the plug-in jar of the alert. The directory is: dolphinscheduler-dist/target/dolphinscheduler-dist-${VERSION}/lib/plugin/alert (the version number will change with the main version number)
+Note: ${VERSION} needs to be manually modified according to the current version.
+
+alert.properties configuration
+```
+alert.plugin.dir=../../../../dolphinscheduler-dist/target/dolphinscheduler-dist-${VERSION}/lib/plugin/alert
+```
Then, you can happily start using your own plugins.
diff --git a/development/en-us/backend/spi/registry.md b/development/en-us/backend/spi/registry.md
index a4094c1..b6f69b6 100644
--- a/development/en-us/backend/spi/registry.md
+++ b/development/en-us/backend/spi/registry.md
@@ -2,13 +2,15 @@
#### How to use it？
-First you need to execute the `mvn -U install package -Prelease -Dmaven.test.skip=true` to install the plugin for generating the plugin JAR of the registry. The directory is: dolphinscheduler-dist/target/dolphinscheduler-dist-1.3.6-SNAPSHOT/lib/plugin/registry.
+Note: ${VERSION} needs to be manually modified according to the current version.
+
+First you need to execute the `mvn -U install -Prelease -Dmaven.test.skip=true` to install the plugin for generating the plugin JAR of the registry. The directory is: dolphinscheduler-dist/target/dolphinscheduler-dist-${VERSION}/lib/plugin/registry.
Next, please follow the configuration below (using zookeeper as an example).
| parameter | default | description |
| :---------------------: | :----------------------------------------------------------: | :--------------------------------------: |
-| registry.plugin.dir | ./dolphinscheduler-dist/target/dolphinscheduler-dist-1.3.6-SNAPSHOT/lib/plugin/registry | Registration Center Plugin Directory |
+| registry.plugin.dir | ./dolphinscheduler-dist/target/dolphinscheduler-dist-${VERSION}/lib/plugin/registry | Registration Center Plugin Directory |
| registry.plugin.name | zookeeper | Registration Center specific plugin name |
| registry.plugin.binding | registry | Dolphinscheduler plugin category |
| registry.servers | 127.0.0.1:2181 | ZK connection address |
@@ -19,7 +21,7 @@ For the specific configuration information, please refer to the parameter inform
1: registry plugin not found
-Please check if `mvn -U install package -Prelease -Dmaven.test.skip=true` is executed. Besides, please check if the directory is configured in registry.plugin.dir in the configuration file contains the relevant plugins.
+Please check if `mvn -U install -Dmaven.test.skip=true` is executed. Besides, please check if the directory is configured in registry.plugin.dir in the configuration file contains the relevant plugins.
2：registry connect timeout
diff --git a/development/en-us/backend/spi/task.md b/development/en-us/backend/spi/task.md
index e0e557f..74eb8dd 100644
--- a/development/en-us/backend/spi/task.md
+++ b/development/en-us/backend/spi/task.md
@@ -2,7 +2,9 @@
#### How to use development environment?
-First you need to execute the `mvn -U install package -Dmaven.test.skip=true` to install the plugin for generating the plugin JAR of the registry. The directory is: dolphinscheduler-dist/target/dolphinscheduler-dist-1.3.6-SNAPSHOT/lib/plugin/task (The version number will follow the change of the main version number)
+Note: ${VERSION} needs to be manually modified according to the current version.
+
+First you need to execute the `mvn -U install -Dmaven.test.skip=true` to install the plugin for generating the plugin JAR of the registry. The directory is: dolphinscheduler-dist/target/dolphinscheduler-dist-${VERSION}/lib/plugin/task (The version number will follow the change of the main version number)
Executing this command will generate all plugins provided by default for all modules.
@@ -10,7 +12,7 @@ Next, configure the plugin directory in (dolphinscheduler-server/src/main/resour
```
task.plugin.dir config the #task.plugin.dir config the Task Plugin dir . WorkerServer while find and load the Task Plugin Jar from this dir when deploy and start WorkerServer on the server .
-task.plugin.dir=dolphinscheduler-dist/target/dolphinscheduler-dist-1.3.6-SNAPSHOT/lib/plugin/task
+task.plugin.dir=dolphinscheduler-dist/target/dolphinscheduler-dist-${VERSION}/lib/plugin/task
```
The following configurations can be used for local development debugging, for example:
diff --git a/development/zh-cn/backend/spi/alert.md b/development/zh-cn/backend/spi/alert.md
index 574d92b..66f98cf 100644
--- a/development/zh-cn/backend/spi/alert.md
+++ b/development/zh-cn/backend/spi/alert.md
@@ -92,9 +92,13 @@ alert_spi 具体设计可见 issue：[Alert Plugin Design](https://github.com/ap
事实上，自我实现一款插件及其简单，仅仅关心插件扩展接口即可，Alert 中你只需要关心 AlertChannelFactory 以及 AlertChannel。我们更建议你按照其他内置插件的设计规范来去开发，这样当你的idea足够好的时候，你无需做过多更改即可捐献给社区。
-当你完成相关代码开发的时候在 alert.properties 配置相关插件（或者仅仅配置一个插件目录，他会加载该目录下的所有插件）。
-
+注意：${VERSION} 需要根据当前版本手动修改。
+当你完成相关代码开发的时候, 你需要执行 `mvn -U install -Dmaven.test.skip=true` 安装插件，生成注册中心的插件 jar。目录是：dolphinscheduler-dist/target/dolphinscheduler-dist-${VERSION}/lib/plugin/alert（版本号会跟随主版本号变更）
+alert.properties 配置
+```
+alert.plugin.dir=../../../../dolphinscheduler-dist/target/dolphinscheduler-dist-${VERSION}/lib/plugin/alert
+```
然后，接下来就可以开始愉快的使用你自己的插件了。
事实上，自定义插件化开发确实如同我们描绘的那么简单，并没有想象中的多么困难。
diff --git a/development/zh-cn/backend/spi/registry.md b/development/zh-cn/backend/spi/registry.md
index 380df01..e3e668f 100644
--- a/development/zh-cn/backend/spi/registry.md
+++ b/development/zh-cn/backend/spi/registry.md
@@ -2,13 +2,15 @@
#### 如何使用？
-首先你需要执行 `mvn -U install package -Dmaven.test.skip=true` 安装插件，生成注册中心的插件 jar。目录是：dolphinscheduler-dist/target/dolphinscheduler-dist-1.3.6-SNAPSHOT/lib/plugin/registry
+首先你需要执行 `mvn -U install -Dmaven.test.skip=true` 安装插件，生成注册中心的插件 jar。目录是：dolphinscheduler-dist/target/dolphinscheduler-dist-${VERSION}/lib/plugin/registry
+
+注意：${VERSION} 需要根据当前版本手动修改
其次进行以下配置（以 zookeeper 为例）
|参数 |默认值| 描述|
|--|--|--|
-registry.plugin.dir|./dolphinscheduler-dist/target/dolphinscheduler-dist-1.3.6-SNAPSHOT/lib/plugin/registry/zookeeper | 注册中心插件目录
+registry.plugin.dir|./dolphinscheduler-dist/target/dolphinscheduler-dist-${VERSION}/lib/plugin/registry/zookeeper | 注册中心插件目录
registry.plugin.name|zookeeper|注册中心具体插件名称
registry.plugin.binding|registry|DolphinScheduler 插件类别
registry.servers|127.0.0.1:2181|zk 连接地址
@@ -21,7 +23,7 @@ registry.servers|127.0.0.1:2181|zk 连接地址
1: registry plugin not found
-请检查是否有执行 `mvn -U install package -Prelease -Dmaven.test.skip=true` ，此外，请检查配置文件中的 registry.plugin.dir 中配置的目录是否有相关插件。
+请检查是否有执行 `mvn -U install -Dmaven.test.skip=true` ，此外，请检查配置文件中的 registry.plugin.dir 中配置的目录是否有相关插件。
2：registry connect timeout
diff --git a/development/zh-cn/backend/spi/task.md b/development/zh-cn/backend/spi/task.md
index 796baff..6553cc9 100644
--- a/development/zh-cn/backend/spi/task.md
+++ b/development/zh-cn/backend/spi/task.md
@@ -2,14 +2,16 @@
#### 开发环境如何使用？
-首先你需要执行 `mvn -U install package -Dmaven.test.skip=true` 安装插件，生成注册中心的插件 jar。目录是：dolphinscheduler-dist/target/dolphinscheduler-dist-1.3.6-SNAPSHOT/lib/plugin/task（版本号会跟随主版本号变更）
+首先你需要执行 `mvn -U install -Dmaven.test.skip=true` 安装插件，生成注册中心的插件 jar。目录是：dolphinscheduler-dist/target/dolphinscheduler-dist-${VERSION}/lib/plugin/task（版本号会跟随主版本号变更）
+
+注意：${VERSION} 需要根据当前版本手动修改
执行此命令会生成所有模块默认提供的所有插件。
其次在（dolphinscheduler-server/src/main/resources/worker.properties）进行配置插件目录
```
task.plugin.dir config the #task.plugin.dir config the Task Plugin dir . WorkerServer while find and load the Task Plugin Jar from this dir when deploy and start WorkerServer on the server .
-task.plugin.dir=dolphinscheduler-dist/target/dolphinscheduler-dist-1.3.6-SNAPSHOT/lib/plugin/task
+task.plugin.dir=dolphinscheduler-dist/target/dolphinscheduler-dist-${VERSION}/lib/plugin/task
```
本地开发调试也可采用以下方式进行配置，例如：
```