[doc] Upgrade screenshot to latest version in dev document (#10242)
* fix issue-9898
* delete no use pictures
(cherry picked from commit 58b1e1da1e)
QuakeWang
devosend
@ -9,12 +9,7 @@ scheduling system
|
||||
form of a directed acyclic graph, and topological traversal is performed from nodes with zero degrees of entry until
|
||||
there are no subsequent nodes. Examples are as follows:
|
||||
|
||||
<p align="center">
|
||||
<img src="/img/dag_examples_cn.jpg" alt="dag example" width="60%" />
|
||||
<p align="center">
|
||||
<em>dag example</em>
|
||||
</p>
|
||||
</p>
|
||||
|
||||
|
||||
**Process definition**: Visualization formed by dragging task nodes and establishing task node associations**DAG**
|
||||
|
||||
|
||||
@ -12,7 +12,7 @@ First, go to the Security Center page. Select Alarm Group Management, click Alar
|
||||
|
||||
Then select Alarm Group Management, create an alarm group, and choose the corresponding alarm instance.
|
||||
|
||||
<img src="/img/alert/alert_step_1.png">
|
||||
<img src="/img/alert/alert_step_2.png">
|
||||
<img src="/img/alert/alert_step_3.png">
|
||||
<img src="/img/alert/alert_step_4.png">
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
@ -3,7 +3,7 @@
|
||||
If you need to use `DingTalk` for alerting, create an alert instance in the alert instance management and select the DingTalk plugin.
|
||||
The following shows the `DingTalk` configuration example:
|
||||
|
||||
|
||||
|
||||
|
||||
## Parameter Configuration
|
||||
|
||||
|
||||
@ -3,7 +3,7 @@
|
||||
If you need `Telegram` to alert, create an alert instance in the alert instance management, and choose the `Telegram` plugin.
|
||||
The following shows the `Telegram` configuration example:
|
||||
|
||||
|
||||
|
||||
|
||||
## Parameter Configuration
|
||||
|
||||
|
||||
@ -19,22 +19,22 @@ Followings are examples shows task parameters priority problems:#############
|
||||
|
||||
1: Use shell nodes to explain the first case.
|
||||
|
||||
|
||||
|
||||
|
||||
The [useParam] node can use the parameters which are set in the [createParam] node. The [useParam] node cannot obtain the parameters from the [noUseParam] node due to there is no dependency between them. Other task node types have the same usage rules with the Shell example here.
|
||||
|
||||
|
||||
|
||||
|
||||
The [createParam] node can use parameters directly. In addition, the node creates two parameters named "key" and "key1", and "key1" has the same name as the one passed by the upstream node and assign value "12". However, due to the priority rules, the value assignment will assign "12" and the value from the upstream node is discarded.
|
||||
|
||||
2: Use SQL nodes to explain another case.
|
||||
|
||||
|
||||
|
||||
|
||||
The following shows the definition of the [use_create] node:
|
||||
|
||||
|
||||
|
||||
|
||||
"status" is the own parameters of the node set by the current node. However, the user also sets the "status" parameter (global parameter) when saving the process definition and assign its value to -1. Then the value of status will be 2 with higher priority when the SQL executes. The global parameter value is discarded.
|
||||
|
||||
The "ID" here is the parameter set by the upstream node. The user sets the parameters of the same parameter name "ID" for the [createparam1] node and [createparam2] node. And the [use_create] node uses the value of [createParam1] which is finished first.
|
||||
The "ID" here is the parameter set by the upstream node. The user sets the parameters of the same parameter name "ID" for the [createparam1] node and [createparam2] node. And the [use_create] node uses the value of [createParam1] which is finished first.
|
||||
|
||||
@ -1,17 +1,12 @@
|
||||
## 名词解释
|
||||
|
||||
在对Apache DolphinScheduler了解之前，我们先来认识一下调度系统常用的名词
|
||||
在对 Apache DolphinScheduler 了解之前，我们先来认识一下调度系统常用的名词
|
||||
|
||||
### 1.名词解释
|
||||
|
||||
**DAG：** 全称Directed Acyclic Graph，简称DAG。工作流中的Task任务以有向无环图的形式组装起来，从入度为零的节点进行拓扑遍历，直到无后继节点为止。举例如下图：
|
||||
**DAG：** 全称 Directed Acyclic Graph，简称 DAG。工作流中的 Task 任务以有向无环图的形式组装起来，从入度为零的节点进行拓扑遍历，直到无后继节点为止。举例如下图：
|
||||
|
||||
<p align="center">
|
||||
<img src="/img/dag_examples_cn.jpg" alt="dag示例" width="60%" />
|
||||
<p align="center">
|
||||
<em>dag示例</em>
|
||||
</p>
|
||||
</p>
|
||||
|
||||
|
||||
**流程定义**：通过拖拽任务节点并建立任务节点的关联所形成的可视化**DAG**
|
||||
|
||||
@ -19,10 +14,10 @@
|
||||
|
||||
**任务实例**：任务实例是流程定义中任务节点的实例化，标识着具体的任务执行状态
|
||||
|
||||
**任务类型**：目前支持有SHELL、SQL、SUB_PROCESS(子流程)、PROCEDURE、MR、SPARK、PYTHON、DEPENDENT(依赖)、，同时计划支持动态插件扩展，注意：其中子 **SUB_PROCESS**
|
||||
**任务类型**：目前支持有 SHELL、SQL、SUB_PROCESS(子流程)、PROCEDURE、MR、SPARK、PYTHON、DEPENDENT(依赖)，同时计划支持动态插件扩展，注意：其中子 **SUB_PROCESS**
|
||||
也是一个单独的流程定义，是可以单独启动执行的
|
||||
|
||||
**调度方式**：系统支持基于cron表达式的定时调度和手动调度。命令类型支持：启动工作流、从当前节点开始执行、恢复被容错的工作流、恢复暂停流程、从失败节点开始执行、补数、定时、重跑、暂停、停止、恢复等待线程。
|
||||
**调度方式**：系统支持基于 cron 表达式的定时调度和手动调度。命令类型支持：启动工作流、从当前节点开始执行、恢复被容错的工作流、恢复暂停流程、从失败节点开始执行、补数、定时、重跑、暂停、停止、恢复等待线程。
|
||||
其中 **恢复被容错的工作流** 和 **恢复等待线程** 两种命令类型是由调度内部控制使用，外部无法调用
|
||||
|
||||
**定时调度**：系统采用 **quartz** 分布式调度器，并同时支持cron表达式可视化的生成
|
||||
|
||||
@ -1,6 +1,6 @@
|
||||
## 如何创建告警插件以及告警组
|
||||
|
||||
在2.0.0版本中，用户需要创建告警实例，在创建告警实例时，需要选择告警策略，有三个选项，成功发、失败发，以及成功和失败都发。在执行完工作流或任务时，如果触发告警，调用告警实例发送方法会进行逻辑判断，将告警实例与任务状态进行匹配，匹配则执行该告警实例发送逻辑，不匹配则过滤。创建完告警实例后，需要同告警组进行关联，一个告警组可以使用多个告警实例。
|
||||
在 2.0.0 版本中，用户需要创建告警实例，在创建告警实例时，需要选择告警策略，有三个选项，成功发、失败发，以及成功和失败都发。在执行完工作流或任务时，如果触发告警，调用告警实例发送方法会进行逻辑判断，将告警实例与任务状态进行匹配，匹配则执行该告警实例发送逻辑，不匹配则过滤。创建完告警实例后，需要同告警组进行关联，一个告警组可以使用多个告警实例。
|
||||
告警模块支持场景如下：
|
||||
<img src="/img/alert/alert_scenarios_zh.png">
|
||||
|
||||
@ -10,7 +10,7 @@
|
||||
|
||||
然后选择告警组管理，创建告警组，选择相应的告警实例即可。
|
||||
|
||||
<img src="/img/alert/alert_step_1.png">
|
||||
<img src="/img/alert/alert_step_2.png">
|
||||
<img src="/img/alert/alert_step_3.png">
|
||||
<img src="/img/alert/alert_step_4.png">
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
@ -2,7 +2,7 @@
|
||||
|
||||
如果您需要使用到钉钉进行告警，请在告警实例管理里创建告警实例，选择 DingTalk 插件。钉钉的配置样例如下:
|
||||
|
||||
|
||||
|
||||
|
||||
参数配置
|
||||
|
||||
|
||||
@ -1,14 +1,14 @@
|
||||
# Telegram
|
||||
|
||||
如果您需要使用`Telegram`进行告警，请在告警实例管理模块创建告警实例，选择`Telegram`插件。
|
||||
如果您需要使用 `Telegram` 进行告警，请在告警实例管理模块创建告警实例，选择 `Telegram` 插件。
|
||||
|
||||
`Telegram`的配置样例如下:
|
||||
`Telegram` 的配置样例如下:
|
||||
|
||||
|
||||
|
||||
|
||||
参数配置:
|
||||
* WebHook:
|
||||
> 使用 Telegram 的机器人，发送消息的WebHook。
|
||||
> 使用 Telegram 的机器人，发送消息的 WebHook。
|
||||
* botToken
|
||||
> 创建 Telegram 的机器人，获取的访问令牌。
|
||||
* chatId
|
||||
@ -26,7 +26,7 @@
|
||||
* Password
|
||||
> 代理鉴权密码
|
||||
|
||||
**注意**：用户配置的WebHook需要能够接收和使用与DolphinScheduler构造的HTTP POST请求BODY相同的结构，JSON结构如下：
|
||||
**注意**：用户配置的 WebHook 需要能够接收和使用与 DolphinScheduler 构造的 HTTP POST 请求 BODY 相同的结构，JSON 结构如下：
|
||||
|
||||
```json
|
||||
{
|
||||
|
||||
@ -19,21 +19,21 @@ DolphinScheduler 中所涉及的参数值的定义可能来自三种类型：
|
||||
|
||||
1：先以 shell 节点解释第一种情况
|
||||
|
||||
<img src="/img/globalParam/image-20210723102938239.png" alt="image-20210723102938239" style="zoom:50%;" />
|
||||
|
||||
|
||||
节点 【useParam】可以使用到节点【createParam】中设置的变量。而节点 【useParam】与节点【noUseParam】中并没有依赖关系，所以并不会获取到节点【noUseParam】的变量。上图中只是以 shell 节点作为例子，其他类型节点具有相同的使用规则。
|
||||
|
||||
<img src="/img/globalParam/image-20210723103316896.png" alt="image-20210723103316896" style="zoom:50%;" />
|
||||
|
||||
|
||||
其中节点【createParam】在使用变量时直接使用即可。另外该节点设置了 "key" 和 "key1" 两个变量，这里用户用定义了一个与上游节点传递的变量名相同的变量 key1，并且赋值为 "12"，但是由于我们设置的优先级的关系，这里的值 "12" 会被使用，最终上游节点设置的变量值会被抛弃。
|
||||
|
||||
2：我们再以 sql 节点来解释另外一种情况
|
||||
|
||||
<img src="/img/globalParam/image-20210723103937052.png" alt="image-20210723103937052" style="zoom:50%;" />
|
||||
|
||||
|
||||
节点【use_create】的定义如下：
|
||||
|
||||
|
||||
|
||||
|
||||
"status" 是当前节点设置的节点的自有变量。但是用户在保存工作流时也同样设置了 "status" 变量（全局参数），并且赋值为 -1。那在该 SQL 执行时，status 的值为优先级更高的 2。抛弃了全局变量中的值。
|
||||
|
||||
|
||||
|
Before Width: | Height: | Size: 68 KiB |
|
Before Width: | Height: | Size: 155 KiB |
|
Before Width: | Height: | Size: 234 KiB |
|
Before Width: | Height: | Size: 141 KiB |
|
Before Width: | Height: | Size: 60 KiB |
|
Before Width: | Height: | Size: 73 KiB |
|
Before Width: | Height: | Size: 50 KiB |
|
Before Width: | Height: | Size: 36 KiB |
|
Before Width: | Height: | Size: 37 KiB |
|
Before Width: | Height: | Size: 52 KiB |
|
Before Width: | Height: | Size: 21 KiB |
BIN
docs/img/new_ui/dev/about/glossary.png
Normal file
|
After Width: | Height: | Size: 83 KiB |
BIN
docs/img/new_ui/dev/alert/alert_dingtalk.png
Normal file
|
After Width: | Height: | Size: 115 KiB |
BIN
docs/img/new_ui/dev/alert/alert_instance01.png
Normal file
|
After Width: | Height: | Size: 69 KiB |
BIN
docs/img/new_ui/dev/alert/alert_instance02.png
Normal file
|
After Width: | Height: | Size: 100 KiB |
BIN
docs/img/new_ui/dev/alert/alert_instance03.png
Normal file
|
After Width: | Height: | Size: 102 KiB |
BIN
docs/img/new_ui/dev/alert/alert_instance04.png
Normal file
|
After Width: | Height: | Size: 100 KiB |
BIN
docs/img/new_ui/dev/alert/alert_telegram.png
Normal file
|
After Width: | Height: | Size: 114 KiB |
BIN
docs/img/new_ui/dev/parameter/priority_parameter01.png
Normal file
|
After Width: | Height: | Size: 16 KiB |
BIN
docs/img/new_ui/dev/parameter/priority_parameter02.png
Normal file
|
After Width: | Height: | Size: 49 KiB |
BIN
docs/img/new_ui/dev/parameter/priority_parameter03.png
Normal file
|
After Width: | Height: | Size: 29 KiB |
BIN
docs/img/new_ui/dev/parameter/priority_parameter04.png
Normal file
|
After Width: | Height: | Size: 170 KiB |