You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@dolphinscheduler.apache.org by zh...@apache.org on 2022/09/17 14:13:24 UTC
[dolphinscheduler] 01/20: [doc] Improve the document introduction of complement (#11275)
This is an automated email from the ASF dual-hosted git repository.
zhongjiajie pushed a commit to branch 3.0.1-prepare
in repository https://gitbox.apache.org/repos/asf/dolphinscheduler.git
commit 82a8956e7b4e00de38c5b22e723ad13687f2bff5
Author: insist777 <84...@users.noreply.github.com>
AuthorDate: Tue Aug 9 19:35:25 2022 +0800
[doc] Improve the document introduction of complement (#11275)
(cherry picked from commit 8ad6e10da536bb7dcbbd43774fd0f29dd05f0ece)
---
docs/docs/en/guide/project/workflow-definition.md | 59 ++++++++++++++-------
docs/docs/zh/guide/project/workflow-definition.md | 52 +++++++++++++-----
.../dev/project/workflow-concurrency-from.png | Bin 0 -> 52048 bytes
.../new_ui/dev/project/workflow-concurrency.png | Bin 0 -> 69050 bytes
.../dev/project/workflow-configuredTiming.png | Bin 0 -> 51860 bytes
.../project/workflow-configuredTimingResult.png | Bin 0 -> 52048 bytes
docs/img/new_ui/dev/project/workflow-date.png | Bin 1182739 -> 0 bytes
.../img/new_ui/dev/project/workflow-dependency.png | Bin 0 -> 47150 bytes
docs/img/new_ui/dev/project/workflow-input.png | Bin 0 -> 54766 bytes
.../new_ui/dev/project/workflow-pageSelection.png | Bin 0 -> 67199 bytes
docs/img/new_ui/dev/project/workflow-parallel.png | Bin 0 -> 53845 bytes
docs/img/new_ui/dev/project/workflow-serial.png | Bin 0 -> 54577 bytes
.../project/workflow-unconfiguredTimingResult.png | Bin 0 -> 64994 bytes
.../new_ui/dev/project/workflow_date_manual.png | Bin 25415 -> 0 bytes
14 files changed, 79 insertions(+), 32 deletions(-)
diff --git a/docs/docs/en/guide/project/workflow-definition.md b/docs/docs/en/guide/project/workflow-definition.md
index 2348488ebc..2137d3df38 100644
--- a/docs/docs/en/guide/project/workflow-definition.md
+++ b/docs/docs/en/guide/project/workflow-definition.md
@@ -97,24 +97,47 @@ The following are the operation functions of the workflow definition list:
* Recipient: select notification policy||timeout alarm||when fault tolerance occurs, process result information or alarm email will be sent to the recipient list.
* Cc: select notification policy||timeout alarm||when fault tolerance occurs, the process result information or warning email will be copied to the CC list.
* Startup parameter: Set or overwrite global parameter values when starting a new process instance.
- * Complement: includes serial complement and parallel complement and supports manual date input and date selection. Serial complement defines, within the specified time range, executes the complements from the start date to the end date by sequential and N process instances are generated in sequence. Parallel complement defines executing the complement concurrently in the multiple days to generate N process instances within the specified time range. Manual date input defines: manually [...]
- * Dependent Mode: Trigger the complement of workflow instances that the downstream dependent node depends on the current workflow(It is required that the scheduled status of the workflow instance of the current replenishment is online, and only the downstream supplement directly dependent on the current workflow will be triggered).
- * You can select complement time range (When the scheduled configuration is not online, the daily complement will be performed by default according to the selected time range.If the timing configuration is online, it will be complemented according to the selected time range in combination with the timing configuration) when executing a timing workflow definition. For example, need to fill in the data from 1st May to 10th May, as shown in the figure below:
-
- 
-
- > Serial mode: the complement execute sequentially from 9th May to 10th May, and the process instance page generates 2 process instances;
-
- > Parallel mode: The tasks from 9th May to 10th May execute simultaneously, and the process instance page generates 2 process instances;
-
- * You can manually enter the complement dates (independent from the timing configuration) to execute the complement data to workflow definitions. The figure below is an example to make complement data from 9th May to 10th May:
-
- 
-
- > Serial mode: the complement execute sequentially from 9th May to 10th May, and the process instance page generates 2 process instances;
-
- > Parallel mode: The tasks from 9th May to 10th May execute simultaneously, and the process instance page generates 2 process instances;
-
+ * Complement: refers to running the workflow definition within the specified date range and generating the corresponding workflow instance according to the complement policy. The complement policy includes two modes: **serial complement** and **parallel complement**. The date can be selected on the page or entered manually.
+
+ * Serial complement: within the specified time range, complement is executed from the start date to the end date, and multiple process instances are generated in turn; Click Run workflow and select the serial complement mode: for example, from July 9 to July 10, execute in sequence, and generate two process instances in sequence on the process instance page.
+
+ 
+
+ * Parallel Replenishment: within the specified time range, replenishment is performed simultaneously for multiple days, and multiple process instances are generated at the same time. Enter date manually: manually enter a date in the comma separated date format of 'yyyy MM DD hh:mm:ss'.Click Run workflow and select the parallel complement mode: for example, execute the workflow definition from July 9 to July 10 at the same time, and generate two process instances on the process instan [...]
+
+ 
+
+ * Concurrency: refers to the maximum number of instances executed in parallel in the parallel complement mode.For example, if tasks from July 6 to July 10 are executed at the same time, and the concurrency is 2, then the process instance is:
+
+ 
+
+ 
+
+ * Dependency mode: whether to trigger the replenishment of workflow instances that downstream dependent nodes depend on the current workflow (the timing status of workflow instances that require the current replenishment is online, which will only trigger the replenishment of downstream directly dependent on the current workflow).
+
+ 
+
+ * Date selection:
+
+ 1. Select the date through the page:
+
+ 
+
+ 2. Manual input:
+
+ 
+
+ * Relationship between complement and timing configuration:
+
+ 1. Unconfigured timing: When there is no timing configuration, the daily replenishment will be performed by default according to the selected time range. For example, the workflow scheduling date is July 7 to July 10. If timing is not configured, the process instance is:
+
+ 
+
+ 2. Configured timing: If there is a timing configuration, it will be supplemented according to the selected time range in combination with the timing configuration. For example, the workflow scheduling date is July 7 to July 10, and the timing is configured (running every 5 a.m.). The process example is:
+
+ 
+
+ 
## Run the task alone
- Right-click the task and click the `Start` button (only online tasks can be clicked to run).
diff --git a/docs/docs/zh/guide/project/workflow-definition.md b/docs/docs/zh/guide/project/workflow-definition.md
index 5d110b6554..65fbbdebf9 100644
--- a/docs/docs/zh/guide/project/workflow-definition.md
+++ b/docs/docs/zh/guide/project/workflow-definition.md
@@ -75,23 +75,47 @@
* 收件人：选择通知策略||超时报警||发生容错时，会发送流程信息或告警邮件到收件人列表。
* 抄送人：选择通知策略||超时报警||发生容错时，会抄送流程信息或告警邮件到抄送人列表。
* 启动参数: 在启动新的流程实例时，设置或覆盖全局参数的值。
- * 补数：包括串行补数、并行补数 2 种模式，日期可以通过选择或者手动进行输入。串行补数：指定时间范围内，从开始日期至结束日期依次执行补数，依次生成N条流程实例；并行补数：指定时间范围内，多天同时进行补数，同时生成 N 条流程实例。手动输入日期：手动输入以逗号分割日期格式为 `yyyy-MM-dd HH:mm:ss` 的日期。日期选择：通过前端选择日期。
+ * 补数：指运行指定日期范围内的工作流定义，根据补数策略生成对应的工作流实例，补数策略包括串行补数、并行补数 2 种模式，日期可以通过页面选择或者手动输入。
+
+ * 串行补数：指定时间范围内，从开始日期至结束日期依次执行补数，依次生成多条流程实例；点击运行工作流，选择串行补数模式：例如从7月 9号到7月10号依次执行，依次在流程实例页面生成两条流程实例。
+
+ 
+
+ * 并行补数： 指定时间范围内，同时进行多天的补数，同时生成多条流程实例。手动输入日期：手动输入以逗号分割日期格式为 `yyyy-MM-dd HH:mm:ss` 的日期。点击运行工作流，选择并行补数模式：例如同时执行7月9号到7月10号的工作流定义，同时在流程实例页面生成两条流程实例(执行策略为串行时流程实例按照策略执行)。
+
+ 
+
+ * 并行度：是指在并行补数的模式下，最多并行执行的实例数。例如同时执行7月6号到7月10号的工作流定义，并行度为2，那么流程实例为：
+ 
+
+ 
+
* 依赖模式：是否触发下游依赖节点依赖到当前工作流的工作流实例的补数（要求当前补数的工作流实例的定时状态为已上线，只会触发下游直接依赖到当前工作流的补数）。
- * 补数： 执行指定日期的工作流定义，可以选择补数时间范围（当定时配置未上线时默认会根据所选时间范围进行每天一次的补数，如果定时配置已上线则会根据所选的时间范围结合定时配置进行补数)，比如需要补 5 月 9 号到 5 月 10 号的数据，如下图所示：
-
- 
-
- > 串行模式：补数从 5 月 9 号到 5 月 10 号依次执行，依次在流程实例页面生成两条流程实例；
-
- > 并行模式：同时执行 5 月 9 号到 5 月 10 号的任务，同时在流程实例页面生成两条流程实例。
-
- * 补数： 通过手动输入补数时间（不依赖定时配置)完成工作流定义的补数。比如需要补 5 月 9 号到 5 月 10 号的数据，如下图所示：
-
- 
+
+ 
+
+ * 日期选择：
+ 1. 通过页面选择日期：
+
+ 
+
+ 2. 手动输入：
+
+ 
+
+ * 补数与定时配置的关系：
+
+ 1. 未配置定时：当没有定时配置时默认会根据所选时间范围进行每天一次的补数，比如该工作流调度日期为7月 7号到7月10号，未配置定时，流程实例为：
+
+ 
- > 串行模式：补数从 5 月 9 号到 5 月 10 号依次执行，依次在流程实例页面生成两条流程实例；
+ 2. 已配置定时：如果有定时配置则会根据所选的时间范围结合定时配置进行补数，比如该工作流调度日期为7月 7号到7月10号，配置了定时（每日凌晨5点运行），流程实例为：
+
+ 
+
+ 
+
- > 并行模式：同时执行 5 月 9 号到 5 月 10 号的任务，同时在流程实例页面生成两条流程实例。
## 单独运行任务
diff --git a/docs/img/new_ui/dev/project/workflow-concurrency-from.png b/docs/img/new_ui/dev/project/workflow-concurrency-from.png
new file mode 100644
index 0000000000..e16f9710cc
Binary files /dev/null and b/docs/img/new_ui/dev/project/workflow-concurrency-from.png differ
diff --git a/docs/img/new_ui/dev/project/workflow-concurrency.png b/docs/img/new_ui/dev/project/workflow-concurrency.png
new file mode 100644
index 0000000000..af90317c9d
Binary files /dev/null and b/docs/img/new_ui/dev/project/workflow-concurrency.png differ
diff --git a/docs/img/new_ui/dev/project/workflow-configuredTiming.png b/docs/img/new_ui/dev/project/workflow-configuredTiming.png
new file mode 100644
index 0000000000..c7c4be64f3
Binary files /dev/null and b/docs/img/new_ui/dev/project/workflow-configuredTiming.png differ
diff --git a/docs/img/new_ui/dev/project/workflow-configuredTimingResult.png b/docs/img/new_ui/dev/project/workflow-configuredTimingResult.png
new file mode 100644
index 0000000000..658d32af19
Binary files /dev/null and b/docs/img/new_ui/dev/project/workflow-configuredTimingResult.png differ
diff --git a/docs/img/new_ui/dev/project/workflow-date.png b/docs/img/new_ui/dev/project/workflow-date.png
deleted file mode 100644
index 629274ef8a..0000000000
Binary files a/docs/img/new_ui/dev/project/workflow-date.png and /dev/null differ
diff --git a/docs/img/new_ui/dev/project/workflow-dependency.png b/docs/img/new_ui/dev/project/workflow-dependency.png
new file mode 100644
index 0000000000..d2cd8a0a77
Binary files /dev/null and b/docs/img/new_ui/dev/project/workflow-dependency.png differ
diff --git a/docs/img/new_ui/dev/project/workflow-input.png b/docs/img/new_ui/dev/project/workflow-input.png
new file mode 100644
index 0000000000..f1d04882ef
Binary files /dev/null and b/docs/img/new_ui/dev/project/workflow-input.png differ
diff --git a/docs/img/new_ui/dev/project/workflow-pageSelection.png b/docs/img/new_ui/dev/project/workflow-pageSelection.png
new file mode 100644
index 0000000000..30975df65d
Binary files /dev/null and b/docs/img/new_ui/dev/project/workflow-pageSelection.png differ
diff --git a/docs/img/new_ui/dev/project/workflow-parallel.png b/docs/img/new_ui/dev/project/workflow-parallel.png
new file mode 100644
index 0000000000..e11634b0ea
Binary files /dev/null and b/docs/img/new_ui/dev/project/workflow-parallel.png differ
diff --git a/docs/img/new_ui/dev/project/workflow-serial.png b/docs/img/new_ui/dev/project/workflow-serial.png
new file mode 100644
index 0000000000..f9731965d6
Binary files /dev/null and b/docs/img/new_ui/dev/project/workflow-serial.png differ
diff --git a/docs/img/new_ui/dev/project/workflow-unconfiguredTimingResult.png b/docs/img/new_ui/dev/project/workflow-unconfiguredTimingResult.png
new file mode 100644
index 0000000000..f7c16af46e
Binary files /dev/null and b/docs/img/new_ui/dev/project/workflow-unconfiguredTimingResult.png differ
diff --git a/docs/img/new_ui/dev/project/workflow_date_manual.png b/docs/img/new_ui/dev/project/workflow_date_manual.png
deleted file mode 100644
index 70d03372f9..0000000000
Binary files a/docs/img/new_ui/dev/project/workflow_date_manual.png and /dev/null differ