You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@dolphinscheduler.apache.org by ca...@apache.org on 2022/09/24 01:59:12 UTC
[dolphinscheduler] branch dev updated: [Doc][Improvement] Add instructions for process execution type and data complement (#12121)
This is an automated email from the ASF dual-hosted git repository.
caishunfeng pushed a commit to branch dev
in repository https://gitbox.apache.org/repos/asf/dolphinscheduler.git
The following commit(s) were added to refs/heads/dev by this push:
new 064224696f [Doc][Improvement] Add instructions for process execution type and data complement (#12121)
064224696f is described below
commit 064224696fd85a31fc8db1818bb3ae1f29e9dd4b
Author: Eric Gao <er...@gmail.com>
AuthorDate: Sat Sep 24 09:59:02 2022 +0800
[Doc][Improvement] Add instructions for process execution type and data complement (#12121)
* Add instructions for process execution type and data complement
* Fix and polish the docs
---
docs/docs/en/guide/project/workflow-definition.md | 56 +++++++++++++++++++--
docs/docs/zh/guide/project/workflow-definition.md | 14 ++++--
.../new_ui/dev/project/workflow-execution-type.png | Bin 0 -> 751996 bytes
3 files changed, 61 insertions(+), 9 deletions(-)
diff --git a/docs/docs/en/guide/project/workflow-definition.md b/docs/docs/en/guide/project/workflow-definition.md
index a19dc8d756..a08cf7a81f 100644
--- a/docs/docs/en/guide/project/workflow-definition.md
+++ b/docs/docs/en/guide/project/workflow-definition.md
@@ -50,6 +50,17 @@ Click the `Save` button, and the "Set DAG chart name" window pops up, as shown i
+### Configure workflow (process) execution type
+
+Click the `Save` button and configure `process execution type` in the pop-up window. There are four process execution types:
+
+- `Parallel`: If there are multiple instances of the same workflow definition, execute the instances in parallel.
+- `Serial Wait`: If there are multiple instances of the same workflow definition, execute the instances in serial.
+- `Serial Discard`: If there are multiple instances of the same workflow definition, discard the later ones and kill the current running ones.
+- `Serial Priority`: If there are multiple instances of the same workflow definition, execute the instances according to the priority in serial.
+
+
+
## Workflow Definition Operation Function
Click `Project Management -> Workflow -> Workflow Definition` to enter the workflow definition page, as shown below:
@@ -60,14 +71,49 @@ Workflow running parameter description:
* **Failure strategy**: When a task node fails to execute, other parallel task nodes need to execute the strategy. "Continue" means: After a task fails, other task nodes execute normally; "End" means: Terminate all tasks being executed, and terminate the entire process.
* **Notification strategy**: When the process ends, send process execution information notification emails according to the process status, including no status, success, failure, success or failure.
-* **Process priority**: the priority of process operation, divided into five levels: the highest (HIGHEST), high (HIGH), medium (MEDIUM), low (LOW), the lowest (LOWEST). When the number of master threads is insufficient, processes with higher levels will be executed first in the execution queue, and processes with the same priority will be executed in the order of first-in, first-out.
+* **Process priority**: The priority of process execution, there are five different priorities: the highest (HIGHEST), high (HIGH), medium (MEDIUM), low (LOW), the lowest (LOWEST). When the number of master threads is insufficient, processes with higher priorities in the execution queue will run first. Processes with the same priority will run in first-come-first-served fashion.
* **Worker grouping**: This process can only be executed in the specified worker machine group. The default is Default, which can be executed on any worker.
* **Notification Group**: Select Notification Policy||Timeout Alarm||When fault tolerance occurs, process information or emails will be sent to all members in the notification group.
-* **Recipient**: Select Notification Policy||Timeout Alarm||When fault tolerance occurs, process information or alarm email will be sent to the recipient list.
-* **Cc**: Select Notification Policy||Timeout Alarm||When fault tolerance occurs, the process information or alarm email will be copied to the Cc list.
* **Startup parameters**: Set or override the value of global parameters when starting a new process instance.
-* **Complement**: There are 2 modes of serial complement and parallel complement. Serial complement: within the specified time range, perform complements in sequence from the start date to the end date, and generate N process instances in turn; parallel complement: within the specified time range, perform multiple complements at the same time, and generate N process instances at the same time .
- * **Complement**: Execute the workflow definition of the specified date, you can select the time range of the supplement (currently only supports the supplement for consecutive days), for example, the data from May 1st to May 10th needs to be supplemented, as shown in the following figure:
+* **Complement(Backfill)**: Run workflow for a specified historical period. There are two strategies: serial complement and parallel complement. You could select the time period or fill in it manually in UI.
+ * Serial complement: Run the workflow from start date to end date according to the time period you set in serial.
+
+ 
+
+ * Parallel complement: Run the workflow from start date to end date according to the time period you set in parallel.
+
+ 
+
+ * Parallelism: The max number of workflow instances of the workflow definition you choose for complement.
+ 
+
+ 
+
+ * Mode of dependent: Whether to trigger downstream workflow definition for complement.
+
+ 
+
+ * Schedule date：
+
+ 1. Select from pop-up window:
+
+ 
+
+ 2. Fill in the time period manually:
+
+ 
+
+ * Complement with or without scheduling：
+
+ 1. Without scheduling: Run workflow every day from start date to end date according to the time period you set. e.g. Do complement from July 7th to 10th without scheduling:
+
+ 
+
+ 2. With scheduling: Run workflow from start date to end date on schedule according to the time period and schedule you set. e.g. Do complement from July 7th to 10th with the schedule of 5 AM every day:
+
+ 
+
+ 
The following are the operation functions of the workflow definition list:
diff --git a/docs/docs/zh/guide/project/workflow-definition.md b/docs/docs/zh/guide/project/workflow-definition.md
index 521ec8757f..630e4c5c7b 100644
--- a/docs/docs/zh/guide/project/workflow-definition.md
+++ b/docs/docs/zh/guide/project/workflow-definition.md
@@ -37,6 +37,14 @@
> 其他类型任务，请参考 [任务节点类型和参数设置](#TaskParamers)。 <!-- markdown-link-check-disable-line -->
+- **执行策略**
+- `并行`：如果对于同一个工作流定义，同时有多个工作流实例，则并行执行工作流实例。
+- `串行等待`：如果对于同一个工作流定义，同时有多个工作流实例，则并行执行工作流实例。
+- `串行抛弃`：如果对于同一个工作流定义，同时有多个工作流实例，则抛弃后生成的工作流实例并杀掉正在跑的实例。
+- `串行优先`：如果对于同一个工作流定义，同时有多个工作流实例，则按照优先级串行执行工作流实例。
+
+
+
## 工作流定义操作功能
点击项目管理->工作流->工作流定义，进入工作流定义页面，如下图所示:
@@ -74,8 +82,6 @@
* 流程优先级：流程运行的优先级，分五个等级：最高（HIGHEST），高(HIGH),中（MEDIUM）,低（LOW），最低（LOWEST）。当 master 线程数不足时，级别高的流程在执行队列中会优先执行，相同优先级的流程按照先进先出的顺序执行。
* Worker 分组：该流程只能在指定的 worker 机器组里执行。默认是 Default，可以在任一 worker 上执行。
* 通知组：选择通知策略||超时报警||发生容错时，会发送流程信息或邮件到通知组里的所有成员。
-* 收件人：选择通知策略||超时报警||发生容错时，会发送流程信息或告警邮件到收件人列表。
-* 抄送人：选择通知策略||超时报警||发生容错时，会抄送流程信息或告警邮件到抄送人列表。
* 启动参数: 在启动新的流程实例时，设置或覆盖全局参数的值。
* 补数：指运行指定日期范围内的工作流定义，根据补数策略生成对应的工作流实例，补数策略包括串行补数、并行补数 2 种模式，日期可以通过页面选择或者手动输入。
* 串行补数：指定时间范围内，从开始日期至结束日期依次执行补数，依次生成多条流程实例；点击运行工作流，选择串行补数模式：例如从7月 9号到7月10号依次执行，依次在流程实例页面生成两条流程实例。
@@ -107,11 +113,11 @@
* 补数与定时配置的关系：
- 1. 未配置定时：当没有定时配置时默认会根据所选时间范围进行每天一次的补数，比如该工作流调度日期为7月 7号到7月10号，未配置定时，流程实例为：
+ 1. 未配置定时：当没有定时配置时默认会根据所选时间范围进行每天一次的补数，比如该工作流调度日期为7月7号到7月10号，未配置定时，流程实例为：
- 2. 已配置定时：如果有定时配置则会根据所选的时间范围结合定时配置进行补数，比如该工作流调度日期为7月 7号到7月10号，配置了定时（每日凌晨5点运行），流程实例为：
+ 2. 已配置定时：如果有定时配置则会根据所选的时间范围结合定时配置进行补数，比如该工作流调度日期为7月7号到7月10号，配置了定时（每日凌晨5点运行），流程实例为：
diff --git a/docs/img/new_ui/dev/project/workflow-execution-type.png b/docs/img/new_ui/dev/project/workflow-execution-type.png
new file mode 100644
index 0000000000..2e7e731aea
Binary files /dev/null and b/docs/img/new_ui/dev/project/workflow-execution-type.png differ