Browse Source

[doc] Update the document picture to new UI (#9953)

3.1.0-release
QuakeWang 2 years ago committed by GitHub
parent
commit
f790bc25fd
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
  1. 10
      docs/docs/en/guide/project/task-instance.md
  2. 71
      docs/docs/en/guide/project/workflow-definition.md
  3. 42
      docs/docs/en/guide/project/workflow-instance.md
  4. 10
      docs/docs/zh/guide/project/task-instance.md
  5. 99
      docs/docs/zh/guide/project/workflow-definition.md
  6. 52
      docs/docs/zh/guide/project/workflow-instance.md
  7. BIN
      docs/img/complement.png
  8. BIN
      docs/img/complement_en1.png
  9. BIN
      docs/img/dag0.png
  10. BIN
      docs/img/dag2.png
  11. BIN
      docs/img/dag3.png
  12. BIN
      docs/img/dag4.png
  13. BIN
      docs/img/dag5.png
  14. BIN
      docs/img/dag6.png
  15. BIN
      docs/img/dag7.png
  16. BIN
      docs/img/dag8.png
  17. BIN
      docs/img/gant-pic.png
  18. BIN
      docs/img/gantt-en.png
  19. BIN
      docs/img/instance-detail.png
  20. BIN
      docs/img/instance-list-en.png
  21. BIN
      docs/img/instance-list.png
  22. BIN
      docs/img/instance-runs-en.png
  23. BIN
      docs/img/instanceViewLog-en.png
  24. BIN
      docs/img/instanceViewLog.png
  25. BIN
      docs/img/line.png
  26. BIN
      docs/img/new_ui/dev/project/instance-gantt.png
  27. BIN
      docs/img/new_ui/dev/project/instance-history.png
  28. BIN
      docs/img/new_ui/dev/project/instance-log01.png
  29. BIN
      docs/img/new_ui/dev/project/instance-log02.png
  30. BIN
      docs/img/new_ui/dev/project/instance-parameter.png
  31. BIN
      docs/img/new_ui/dev/project/instance-state.png
  32. BIN
      docs/img/new_ui/dev/project/task-instance.png
  33. BIN
      docs/img/new_ui/dev/project/task-log.png
  34. BIN
      docs/img/new_ui/dev/project/workflow-dag.png
  35. BIN
      docs/img/new_ui/dev/project/workflow-date.png
  36. BIN
      docs/img/new_ui/dev/project/workflow-delete.png
  37. BIN
      docs/img/new_ui/dev/project/workflow-dependent.png
  38. BIN
      docs/img/new_ui/dev/project/workflow-instance.png
  39. BIN
      docs/img/new_ui/dev/project/workflow-list.png
  40. BIN
      docs/img/new_ui/dev/project/workflow-online.png
  41. BIN
      docs/img/new_ui/dev/project/workflow-run.png
  42. BIN
      docs/img/new_ui/dev/project/workflow-save.png
  43. BIN
      docs/img/new_ui/dev/project/workflow-time01.png
  44. BIN
      docs/img/new_ui/dev/project/workflow-time02.png
  45. BIN
      docs/img/new_ui/dev/project/workflow-time03.png
  46. BIN
      docs/img/new_ui/dev/project/workflow-tree.png
  47. BIN
      docs/img/run-work.png
  48. BIN
      docs/img/run_params.png
  49. BIN
      docs/img/run_params_en.png
  50. BIN
      docs/img/run_work_en.png
  51. BIN
      docs/img/task-list-en.png
  52. BIN
      docs/img/task-list.png
  53. BIN
      docs/img/task-log-en.png
  54. BIN
      docs/img/task-log2-en.png
  55. BIN
      docs/img/task-log2.png
  56. BIN
      docs/img/task_history.png
  57. BIN
      docs/img/task_history_en.png
  58. BIN
      docs/img/time-manage-list-en.png
  59. BIN
      docs/img/time-schedule.png
  60. BIN
      docs/img/time-schedule2.png
  61. BIN
      docs/img/time-schedule3.png
  62. BIN
      docs/img/time_schedule_en.png
  63. BIN
      docs/img/timer-en.png
  64. BIN
      docs/img/tree.png
  65. BIN
      docs/img/tree_en.png
  66. BIN
      docs/img/work_list.png
  67. BIN
      docs/img/work_list_en.png

10
docs/docs/en/guide/project/task-instance.md

@ -1,11 +1,9 @@
## Task Instance
- Click Project Management -> Workflow -> Task Instance. Enter the task instance page, as shown in the figure below, click workflow instance name, you can jump to the workflow instance DAG chart to view the task status.
<p align="center">
<img src="/img/task-list-en.png" width="80%" />
</p>
![task-instance](/img/new_ui/dev/project/task-instance.png)
- View log:Click the "view log" button in the operation column to view task execution log.
<p align="center">
<img src="/img/task-log2-en.png" width="80%" />
</p>
![task-log](/img/new_ui/dev/project/task-log.png)

71
docs/docs/en/guide/project/workflow-definition.md

@ -3,9 +3,9 @@
## Create workflow definition
- Click Project Management -> Workflow -> Workflow Definition, enter the workflow definition page, and click the "Create Workflow" button to enter the **workflow DAG edit** page, as shown in the following figure:
<p align="center">
<img src="/img/dag5.png" width="80%" />
</p>
![workflow-dag](/img/new_ui/dev/project/workflow-dag.png)
- Drag from the toolbar <img src="/img/tasks/icons/shell.png" width="15"/> to the canvas, to add a shell task to the canvas, as shown in the figure below:
![demo-shell-simple](/img/tasks/demo/shell.jpg)
@ -20,30 +20,26 @@
6. Customize parameters (optional);
7. Click the "Confirm Add" button to save the task settings.
- **Set dependencies between tasks:** Click the icon in the upper right corner <img src="/img/line.png" width="35"/> to connect the task; as shown in the figure below, task 2 and task 3 execute in parallel, When task 1 finished execution, tasks 2 and 3 will execute simultaneously.
- **Set dependencies between tasks:** Click the plus sign on the right of the task node to connect the task; as shown in the figure below, task Node_B and task Node_C execute in parallel, When task Node_A finished execution, tasks Node_B and Node_C will execute simultaneously.
<p align="center">
<img src="/img/dag6.png" width="80%" />
</p>
![workflow-dependent](/img/new_ui/dev/project/workflow-dependent.png)
- **Delete dependencies:** Click the "arrow" icon in the upper right corner <img src="/img/arrow.png" width="35"/>, select the connection line, and click the "Delete" icon in the upper right corner <img src= "/img/delete.png" width="35"/>, delete dependencies between tasks.
<p align="center">
<img src="/img/dag7.png" width="80%" />
</p>
![workflow-delete](/img/new_ui/dev/project/workflow-delete.png)
- **Save workflow definition:** Click the "Save" button, and the "Set DAG chart name" window pops up, as shown in the figure below. Enter the workflow definition name, workflow definition description, and set global parameters (optional, refer to [global parameters](../parameter/global.md)), click the "Add" button to finish workflow definition creation.
<p align="center">
<img src="/img/dag8.png" width="80%" />
</p>
![workflow-save](/img/new_ui/dev/project/workflow-save.png)
> For other types of tasks, please refer to [Task Node Type and Parameter Settings](#TaskParamers). <!-- markdown-link-check-disable-line -->
## Workflow Definition Operation Function
Click Project Management -> Workflow -> Workflow Definition to enter the workflow definition page, as shown below:
<p align="center">
<img src="/img/work_list_en.png" width="80%" />
</p>
![workflow-list](/img/new_ui/dev/project/workflow-list.png)
The following are the operation functions of the workflow definition list:
- **Edit:** Only "Offline" workflow definitions can be edited. Workflow DAG editing is the same as [Create Workflow Definition](#creatDag) <!-- markdown-link-check-disable-line -->
@ -55,21 +51,19 @@ The following are the operation functions of the workflow definition list:
- **Delete:** Delete the workflow definition
- **Download:** Download workflow definition to local
- **Tree Diagram:** Display the task node type and task status in a tree structure, as shown in the figure below:
<p align="center">
<img src="/img/tree_en.png" width="80%" />
</p>
![workflow-tree](/img/new_ui/dev/project/workflow-tree.png)
## Run the Workflow
- Click Project Management -> Workflow -> Workflow Definition to enter the workflow definition page, as shown in the figure below, click the "Go Online" button <img src="/img/online.png" width="35"/>to make workflow online.
<p align="center">
<img src="/img/work_list_en.png" width="80%" />
</p>
![workflow-online](/img/new_ui/dev/project/workflow-online.png)
- Click the "Run" button to pop up the startup parameter setting window, as shown in the figure below, set the startup parameters, click the "Run" button in the pop-up box, the workflow starts running, and the workflow instance page generates a workflow instance.
<p align="center">
<img src="/img/run_work_en.png" width="80%" />
</p>
![workflow-run](/img/new_ui/dev/project/workflow-run.png)
Description of workflow operating parameters:
* Failure strategy: When a task node fails to execute, other parallel task nodes need to execute this strategy. "Continue" means: after a certain task fails, other task nodes execute normally; "End" means: terminate all tasks execution, and terminate the entire process
@ -83,31 +77,28 @@ The following are the operation functions of the workflow definition list:
* Complement: two modes including serial complement and parallel complement. Serial complement: within the specified time range, the complements are executed from the start date to the end date and N process instances are generated in turn; parallel complement: within the specified time range, multiple days are complemented at the same time to generate N process instances.
* You can select complement time range (only support continuous date) 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:
<p align="center">
<img src="/img/complement_en1.png" width="80%" />
</p>
![workflow-date](/img/new_ui/dev/project/workflow-date.png)
> Serial mode: the complement execute sequentially from 1st May to 10th May, and the process instance page generates 10 process instances;
> Serial mode: the complement execute sequentially from 9th May to 10th May, and the process instance page generates 10 process instances;
> Parallel mode: The tasks from 1st May to 10th May execute simultaneously, and the process instance page generates 10 process instances;
> Parallel mode: The tasks from 9th May to 10th May execute simultaneously, and the process instance page generates 10 process instances;
## Workflow Timing
- Create timing: Click Project Management->Workflow->Workflow Definition, enter the workflow definition page, make the workflow online, click the "timing" button <img src="/img/timing.png" width="35"/> , the timing parameter setting dialog box pops up, as shown in the figure below:
<p align="center">
<img src="/img/time_schedule_en.png" width="80%" />
</p>
![workflow-time01](/img/new_ui/dev/project/workflow-time01.png)
- Choose the start and end time. In the time range, the workflow runs at regular intervals; If not in the time range, no regular workflow instances generate.
- Add a timing that execute once a day at 5 AM, as shown in the following figure:
<p align="center">
<img src="/img/timer-en.png" width="80%" />
</p>
- Add a timing that execute 5 minutes once, as shown in the following figure:
![workflow-time02](/img/new_ui/dev/project/workflow-time02.png)
- Failure strategy, notification strategy, process priority, worker group, notification group, recipient, and CC are the same as workflow running parameters.
- Click the "Create" button to create the timing. Now the timing status is "**Offline**" and the timing needs to be **Online** to make effect.
- Timing online: Click the "Timing Management" button <img src="/img/timeManagement.png" width="35"/>, enter the timing management page, click the "online" button, the timing status will change to "online", as shown in the below figure, the workflow makes effect regularly.
<p align="center">
<img src="/img/time-manage-list-en.png" width="80%" />
</p>
![workflow-time03](/img/new_ui/dev/project/workflow-time03.png)
## Import Workflow

42
docs/docs/en/guide/project/workflow-instance.md

@ -3,48 +3,42 @@
## View Workflow Instance
- Click Project Management -> Workflow -> Workflow Instance, enter the Workflow Instance page, as shown in the figure below:
<p align="center">
<img src="/img/instance-list-en.png" width="80%" />
</p>
![workflow-instance](/img/new_ui/dev/project/workflow-instance.png)
- Click the workflow name to enter the DAG view page, and check the task execution status, as shown in the figure below:
<p align="center">
<img src="/img/instance-runs-en.png" width="80%" />
</p>
![instance-state](/img/new_ui/dev/project/instance-state.png)
## View Task Log
- Enter the workflow instance page, click the workflow name, enter the DAG view page, double-click the task node, as shown in the figure below:
<p align="center">
<img src="/img/instanceViewLog-en.png" width="80%" />
</p>
![instance-log01](/img/new_ui/dev/project/instance-log01.png)
- Click "View Log", a log window pops up, as shown in the figure below, you can also view the task log on the task instance page, refer to [Task View Log](./task-instance.md)
<p align="center">
<img src="/img/task-log-en.png" width="80%" />
</p>
![instance-log02](/img/new_ui/dev/project/instance-log02.png)
## View Task History
- Click Project Management -> Workflow -> Workflow Instance, enter the workflow instance page, and click the workflow name to enter the workflow DAG page;
- Double-click the task node, as shown in the figure below, click "View History" to jump to the task instance page, and display a list of task instances running by the workflow instance
<p align="center">
<img src="/img/task_history_en.png" width="80%" />
</p>
![instance-history](/img/new_ui/dev/project/instance-history.png)
## View Operation Parameters
- Click Project Management -> Workflow -> Workflow Instance, enter the workflow instance page, and click the workflow name to enter the workflow DAG page;
- Click the icon in the upper left corner <img src="/img/run_params_button.png" width="35"/>,View the startup parameters of the workflow instance; click the icon <img src="/img/global_param.png" width="35"/>,View the global and local parameters of the workflow instance, as shown in the following figure:
<p align="center">
<img src="/img/run_params_en.png" width="80%" />
</p>
![instance-parameter](/img/new_ui/dev/project/instance-parameter.png)
## Workflow Instance Operation Function
Click Project Management -> Workflow -> Workflow Instance, enter the workflow instance page, as shown in the figure below:
<p align="center">
<img src="/img/instance-list-en.png" width="80%" />
</p>
![workflow-instance](/img/new_ui/dev/project/workflow-instance.png)
- **Edit:** only can edit terminated processes. Click the "Edit" button or the workflow instance name to enter the DAG edit page. After the edit, click the "Save" button to confirm, as shown in the figure below. In the pop-up box, check "Whether to update to workflow definition" to update the workflow definition; if not checked, no effect on the workflow definition
<p align="center">
@ -57,6 +51,6 @@ Click Project Management -> Workflow -> Workflow Instance, enter the workflow in
- **Resume pause:** to resume the paused process, start running directly from the **paused node**
- **Delete:** delete the workflow instance and the task instance under the workflow instance
- **Gantt chart:** the vertical axis of the Gantt chart is the topological sorting of task instances of the workflow instance, and the horizontal axis is the running time of the task instances, as shown in the figure below:
<p align="center">
<img src="/img/gantt-en.png" width="80%" />
</p>
![instance-gantt](/img/new_ui/dev/project/instance-gantt.png)

10
docs/docs/zh/guide/project/task-instance.md

@ -1,11 +1,9 @@
# 任务实例
- 点击项目管理->工作流->任务实例,进入任务实例页面,如下图所示,点击工作流实例名称,可跳转到工作流实例DAG图查看任务状态。
<p align="center">
<img src="/img/task-list.png" width="80%" />
</p>
![task-instance](/img/new_ui/dev/project/task-instance.png)
- 查看日志:点击操作列中的“查看日志”按钮,可以查看任务执行的日志情况。
<p align="center">
<img src="/img/task-log2.png" width="80%" />
</p>
![task-log](/img/new_ui/dev/project/task-log.png)

99
docs/docs/zh/guide/project/workflow-definition.md

@ -1,45 +1,45 @@
# 工作流定义
## <span id=creatDag>创建工作流定义</span>
## 创建工作流定义
- 点击项目管理->工作流->工作流定义,进入工作流定义页面,点击“创建工作流”按钮,进入**工作流DAG编辑**页面,如下图所示:
<p align="center">
<img src="/img/dag0.png" width="80%" />
</p>
![workflow-dag](/img/new_ui/dev/project/workflow-dag.png)
- 工具栏中拖拽 <img src="/img/tasks/icons/shell.png" width="15"/> 到画板中,新增一个Shell任务,如下图所示:
![demo-shell-simple](/img/tasks/demo/shell.jpg)
- **添加shell任务的参数设置:**
- **添加 Shell 任务的参数设置:**
1. 填写“节点名称”,“描述”,“脚本”字段;
1. “运行标志”勾选“正常”,若勾选“禁止执行”,运行工作流不会执行该任务;
1. 选择“任务优先级”:当worker线程数不足时,级别高的任务在执行队列中会优先执行,相同优先级的任务按照先进先出的顺序执行;
1. 选择“任务优先级”:当 worker 线程数不足时,级别高的任务在执行队列中会优先执行,相同优先级的任务按照先进先出的顺序执行;
1. 超时告警(非必选):勾选超时告警、超时失败,填写“超时时长”,当任务执行时间超过**超时时长**,会发送告警邮件并且任务超时失败;
1. 资源(非必选)。资源文件是资源中心->文件管理页面创建或上传的文件,如文件名为`test.sh`,脚本中调用资源命令为`sh test.sh`;
1. 资源(非必选)。资源文件是资源中心->文件管理页面创建或上传的文件,如文件名为 `test.sh`,脚本中调用资源命令为 `sh test.sh`
1. 自定义参数(非必填);
1. 点击"确认添加"按钮,保存任务设置。
- **配置任务之间的依赖关系:** 点击右上角图标<img src="/img/line.png" width="35"/>连接任务;如下图所示,任务2和任务3并行执行,当任务1执行完,任务2、3会同时执行。
- **配置任务之间的依赖关系:** 点击任务节点的右侧加号连接任务;如下图所示,任务 Node_B 和任务 Node_C 并行执行,当任务 Node_A 执行完,任务 Node_B、Node_C 会同时执行。
<p align="center">
<img src="/img/dag2.png" width="80%" />
</p>
![workflow-dependent](/img/new_ui/dev/project/workflow-dependent.png)
- **删除依赖关系:** 点击右上角"箭头"图标<img src="/img/arrow.png" width="35"/>,选中连接线,点击右上角"删除"图标<img src="/img/delete.png" width="35"/>,删除任务间的依赖关系。
<p align="center">
<img src="/img/dag3.png" width="80%" />
</p>
![workflow-delete](/img/new_ui/dev/project/workflow-delete.png)
- **保存工作流定义:** 点击”保存“按钮,弹出"设置DAG图名称"弹框,如下图所示,输入工作流定义名称,工作流定义描述,设置全局参数(选填,参考[全局参数](../parameter/global.md)),点击"添加"按钮,工作流定义创建成功。
<p align="center">
<img src="/img/dag4.png" width="80%" />
</p>
![workflow-save](/img/new_ui/dev/project/workflow-save.png)
> 其他类型任务,请参考 [任务节点类型和参数设置](#TaskParamers)。 <!-- markdown-link-check-disable-line -->
## 工作流定义操作功能
点击项目管理->工作流->工作流定义,进入工作流定义页面,如下图所示:
<p align="center">
<img src="/img/work_list.png" width="80%" />
</p>
![workflow-list](/img/new_ui/dev/project/workflow-list.png)
工作流定义列表的操作功能如下:
- **编辑:** 只能编辑"下线"的工作流定义。工作流DAG编辑同创建工作流定义。
@ -51,59 +51,56 @@
- **删除:** 删除工作流定义。
- **下载:** 下载工作流定义到本地。
- **树形图:** 以树形结构展示任务节点的类型及任务状态,如下图所示:
<p align="center">
<img src="/img/tree.png" width="80%" />
</p>
![workflow-tree](/img/new_ui/dev/project/workflow-tree.png)
## 运行工作流
- 点击项目管理->工作流->工作流定义,进入工作流定义页面,如下图所示,点击"上线"按钮<img src="/img/online.png" width="35"/>,上线工作流。
<p align="center">
<img src="/img/work_list.png" width="80%" />
</p>
![workflow-online](/img/new_ui/dev/project/workflow-online.png)
- 点击”运行“按钮,弹出启动参数设置弹框,如下图所示,设置启动参数,点击弹框中的"运行"按钮,工作流开始运行,工作流实例页面生成一条工作流实例。
<p align="center">
<img src="/img/run-work.png" width="80%" />
</p>
![workflow-run](/img/new_ui/dev/project/workflow-run.png)
工作流运行参数说明:
* 失败策略:当某一个任务节点执行失败时,其他并行的任务节点需要执行的策略。”继续“表示:某一任务失败后,其他任务节点正常执行;”结束“表示:终止所有正在执行的任务,并终止整个流程。
* 通知策略:当流程结束,根据流程状态发送流程执行信息通知邮件,包含任何状态都不发,成功发,失败发,成功或失败都发。
* 流程优先级:流程运行的优先级,分五个等级:最高(HIGHEST),高(HIGH),中(MEDIUM),低(LOW),最低(LOWEST)。当master线程数不足时,级别高的流程在执行队列中会优先执行,相同优先级的流程按照先进先出的顺序执行。
* worker分组:该流程只能在指定的worker机器组里执行。默认是Default,可以在任一worker上执行。
* 流程优先级:流程运行的优先级,分五个等级:最高(HIGHEST),高(HIGH),中(MEDIUM),低(LOW),最低(LOWEST)。当 master 线程数不足时,级别高的流程在执行队列中会优先执行,相同优先级的流程按照先进先出的顺序执行。
* Worker 分组:该流程只能在指定的 worker 机器组里执行。默认是 Default,可以在任一 worker 上执行。
* 通知组:选择通知策略||超时报警||发生容错时,会发送流程信息或邮件到通知组里的所有成员。
* 收件人:选择通知策略||超时报警||发生容错时,会发送流程信息或告警邮件到收件人列表。
* 抄送人:选择通知策略||超时报警||发生容错时,会抄送流程信息或告警邮件到抄送人列表。
* 启动参数: 在启动新的流程实例时,设置或覆盖全局参数的值。
* 补数:包括串行补数、并行补数2种模式。串行补数:指定时间范围内,从开始日期至结束日期依次执行补数,依次生成N条流程实例;并行补数:指定时间范围内,多天同时进行补数,同时生成N条流程实例。
* 补数: 执行指定日期的工作流定义,可以选择补数时间范围(目前只支持针对连续的天进行补数),比如需要补5月1号到5月10号的数据,如下图所示:
<p align="center">
<img src="/img/complement.png" width="80%" />
</p>
* 补数:包括串行补数、并行补数 2 种模式。串行补数:指定时间范围内,从开始日期至结束日期依次执行补数,依次生成N条流程实例;并行补数:指定时间范围内,多天同时进行补数,同时生成 N 条流程实例。
* 补数: 执行指定日期的工作流定义,可以选择补数时间范围(目前只支持针对连续的天进行补数),比如需要补 5 月 9 号到 5 月 10 号的数据,如下图所示:
> 串行模式:补数从5月1号到5月10号依次执行,依次在流程实例页面生成十条流程实例;
![workflow-date](/img/new_ui/dev/project/workflow-date.png)
> 并行模式:同时执行5月1号到5月10号的任务,同时在流程实例页面生成十条流程实例。
> 串行模式:补数从 5 月 9 号到 5 月 10 号依次执行,依次在流程实例页面生成十条流程实例;
## <span id=creatTiming>工作流定时</span>
> 并行模式:同时执行 5 月 9 号到 5 月 10 号的任务,同时在流程实例页面生成十条流程实例。
## 工作流定时
- 创建定时:点击项目管理->工作流->工作流定义,进入工作流定义页面,上线工作流,点击"定时"按钮<img src="/img/timing.png" width="35"/>,弹出定时参数设置弹框,如下图所示:
<p align="center">
<img src="/img/time-schedule.png" width="80%" />
</p>
![workflow-time01](/img/new_ui/dev/project/workflow-time01.png)
- 选择起止时间。在起止时间范围内,定时运行工作流;不在起止时间范围内,不再产生定时工作流实例。
- 添加一个每天凌晨5点执行一次的定时,如下图所示:
<p align="center">
<img src="/img/time-schedule2.png" width="80%" />
</p>
- 失败策略、通知策略、流程优先级、Worker分组、通知组、收件人、抄送人同工作流运行参数。
- 添加一个每隔 5 分钟执行一次的定时,如下图所示:
![workflow-time02](/img/new_ui/dev/project/workflow-time02.png)
- 失败策略、通知策略、流程优先级、Worker 分组、通知组、收件人、抄送人同工作流运行参数。
- 点击"创建"按钮,创建定时成功,此时定时状态为"**下线**",定时需**上线**才生效。
- 定时上线:点击"定时管理"按钮<img src="/img/timeManagement.png" width="35"/>,进入定时管理页面,点击"上线"按钮,定时状态变为"上线",如下图所示,工作流定时生效。
<p align="center">
<img src="/img/time-schedule3.png" width="80%" />
</p>
![workflow-time03](/img/new_ui/dev/project/workflow-time03.png)
## 导入工作流
点击项目管理->工作流->工作流定义,进入工作流定义页面,点击"导入工作流"按钮,导入本地工作流文件,工作流定义列表显示导入的工作流,状态为下线。
点击项目管理->工作流->工作流定义,进入工作流定义页面,点击"导入工作流"按钮,导入本地工作流文件,工作流定义列表显示导入的工作流,状态为下线。

52
docs/docs/zh/guide/project/workflow-instance.md

@ -3,59 +3,53 @@
## 查看工作流实例
- 点击项目管理->工作流->工作流实例,进入工作流实例页面,如下图所示:
<p align="center">
<img src="/img/instance-list.png" width="80%" />
</p>
![workflow-instance](/img/new_ui/dev/project/workflow-instance.png)
- 点击工作流名称,进入DAG查看页面,查看任务执行状态,如下图所示。
<p align="center">
<img src="/img/instance-detail.png" width="80%" />
</p>
![instance-state](/img/new_ui/dev/project/instance-state.png)
## 查看任务日志
- 进入工作流实例页面,点击工作流名称,进入DAG查看页面,双击任务节点,如下图所示:
<p align="center">
<img src="/img/instanceViewLog.png" width="80%" />
</p>
![instance-log01](/img/new_ui/dev/project/instance-log01.png)
- 点击"查看日志",弹出日志弹框,如下图所示,任务实例页面也可查看任务日志,参考[任务查看日志](./task-instance.md)。
<p align="center">
<img src="/img/task-log.png" width="80%" />
</p>
![instance-log02](/img/new_ui/dev/project/instance-log02.png)
## 查看任务历史记录
- 点击项目管理->工作流->工作流实例,进入工作流实例页面,点击工作流名称,进入工作流DAG页面;
- 点击项目管理->工作流->工作流实例,进入工作流实例页面,点击工作流名称,进入工作流 DAG 页面;
- 双击任务节点,如下图所示,点击"查看历史",跳转到任务实例页面,并展示该工作流实例运行的任务实例列表
<p align="center">
<img src="/img/task_history.png" width="80%" />
</p>
![instance-history](/img/new_ui/dev/project/instance-history.png)
## 查看运行参数
- 点击项目管理->工作流->工作流实例,进入工作流实例页面,点击工作流名称,进入工作流DAG页面;
- 点击项目管理->工作流->工作流实例,进入工作流实例页面,点击工作流名称,进入工作流 DAG 页面;
- 点击左上角图标<img src="/img/run_params_button.png" width="35"/>,查看工作流实例的启动参数;点击图标<img src="/img/global_param.png" width="35"/>,查看工作流实例的全局参数和局部参数,如下图所示:
<p align="center">
<img src="/img/run_params.png" width="80%" />
</p>
![instance-parameter](/img/new_ui/dev/project/instance-parameter.png)
## 工作流实例操作功能
点击项目管理->工作流->工作流实例,进入工作流实例页面,如下图所示:
<p align="center">
<img src="/img/instance-list.png" width="80%" />
</p>
- **编辑:** 只能编辑已终止的流程。点击"编辑"按钮或工作流实例名称进入DAG编辑页面,编辑后点击"保存"按钮,弹出保存DAG弹框,如下图所示,在弹框中勾选"是否更新到工作流定义",保存后则更新工作流定义;若不勾选,则不更新工作流定义。
![workflow-instance](/img/new_ui/dev/project/workflow-instance.png)
- **编辑:** 只能编辑已终止的流程。点击"编辑"按钮或工作流实例名称进入 DAG 编辑页面,编辑后点击"保存"按钮,弹出保存 DAG 弹框,如下图所示,在弹框中勾选"是否更新到工作流定义",保存后则更新工作流定义;若不勾选,则不更新工作流定义。
<p align="center">
<img src="/img/editDag.png" width="80%" />
</p>
- **重跑:** 重新执行已经终止的流程。
- **恢复失败:** 针对失败的流程,可以执行恢复失败操作,从失败的节点开始执行。
- **停止:** 对正在运行的流程进行**停止**操作,后台会先`kill`worker进程,再执行`kill -9`操作
- **停止:** 对正在运行的流程进行**停止**操作,后台会先 `kill` worker 进程,再执行 `kill -9` 操作
- **暂停:** 对正在运行的流程进行**暂停**操作,系统状态变为**等待执行**,会等待正在执行的任务结束,暂停下一个要执行的任务。
- **恢复暂停:** 对暂停的流程恢复,直接从**暂停的节点**开始运行
- **删除:** 删除工作流实例及工作流实例下的任务实例
- **甘特图:** Gantt图纵轴是某个工作流实例下的任务实例的拓扑排序,横轴是任务实例的运行时间,如图示:
<p align="center">
<img src="/img/gant-pic.png" width="80%" />
</p>
- **甘特图:** Gantt 图纵轴是某个工作流实例下的任务实例的拓扑排序,横轴是任务实例的运行时间,如图示:
![instance-gantt](/img/new_ui/dev/project/instance-gantt.png)

BIN
docs/img/complement.png

Binary file not shown.

Before

Width:  |  Height:  |  Size: 17 KiB

BIN
docs/img/complement_en1.png

Binary file not shown.

Before

Width:  |  Height:  |  Size: 193 KiB

BIN
docs/img/dag0.png

Binary file not shown.

Before

Width:  |  Height:  |  Size: 46 KiB

BIN
docs/img/dag2.png

Binary file not shown.

Before

Width:  |  Height:  |  Size: 96 KiB

BIN
docs/img/dag3.png

Binary file not shown.

Before

Width:  |  Height:  |  Size: 94 KiB

BIN
docs/img/dag4.png

Binary file not shown.

Before

Width:  |  Height:  |  Size: 28 KiB

BIN
docs/img/dag5.png

Binary file not shown.

Before

Width:  |  Height:  |  Size: 496 KiB

BIN
docs/img/dag6.png

Binary file not shown.

Before

Width:  |  Height:  |  Size: 551 KiB

BIN
docs/img/dag7.png

Binary file not shown.

Before

Width:  |  Height:  |  Size: 553 KiB

BIN
docs/img/dag8.png

Binary file not shown.

Before

Width:  |  Height:  |  Size: 78 KiB

BIN
docs/img/gant-pic.png

Binary file not shown.

Before

Width:  |  Height:  |  Size: 96 KiB

BIN
docs/img/gantt-en.png

Binary file not shown.

Before

Width:  |  Height:  |  Size: 106 KiB

BIN
docs/img/instance-detail.png

Binary file not shown.

Before

Width:  |  Height:  |  Size: 96 KiB

BIN
docs/img/instance-list-en.png

Binary file not shown.

Before

Width:  |  Height:  |  Size: 194 KiB

BIN
docs/img/instance-list.png

Binary file not shown.

Before

Width:  |  Height:  |  Size: 159 KiB

BIN
docs/img/instance-runs-en.png

Binary file not shown.

Before

Width:  |  Height:  |  Size: 115 KiB

BIN
docs/img/instanceViewLog-en.png

Binary file not shown.

Before

Width:  |  Height:  |  Size: 569 KiB

BIN
docs/img/instanceViewLog.png

Binary file not shown.

Before

Width:  |  Height:  |  Size: 39 KiB

BIN
docs/img/line.png

Binary file not shown.

Before

Width:  |  Height:  |  Size: 883 B

BIN
docs/img/new_ui/dev/project/instance-gantt.png

Binary file not shown.

After

Width:  |  Height:  |  Size: 68 KiB

BIN
docs/img/new_ui/dev/project/instance-history.png

Binary file not shown.

After

Width:  |  Height:  |  Size: 165 KiB

BIN
docs/img/new_ui/dev/project/instance-log01.png

Binary file not shown.

After

Width:  |  Height:  |  Size: 165 KiB

BIN
docs/img/new_ui/dev/project/instance-log02.png

Binary file not shown.

After

Width:  |  Height:  |  Size: 271 KiB

BIN
docs/img/new_ui/dev/project/instance-parameter.png

Binary file not shown.

After

Width:  |  Height:  |  Size: 157 KiB

BIN
docs/img/new_ui/dev/project/instance-state.png

Binary file not shown.

After

Width:  |  Height:  |  Size: 124 KiB

BIN
docs/img/new_ui/dev/project/task-instance.png

Binary file not shown.

After

Width:  |  Height:  |  Size: 82 KiB

BIN
docs/img/new_ui/dev/project/task-log.png

Binary file not shown.

After

Width:  |  Height:  |  Size: 307 KiB

BIN
docs/img/new_ui/dev/project/workflow-dag.png

Binary file not shown.

After

Width:  |  Height:  |  Size: 101 KiB

BIN
docs/img/new_ui/dev/project/workflow-date.png

Binary file not shown.

After

Width:  |  Height:  |  Size: 1.1 MiB

BIN
docs/img/new_ui/dev/project/workflow-delete.png

Binary file not shown.

After

Width:  |  Height:  |  Size: 121 KiB

BIN
docs/img/new_ui/dev/project/workflow-dependent.png

Binary file not shown.

After

Width:  |  Height:  |  Size: 116 KiB

BIN
docs/img/new_ui/dev/project/workflow-instance.png

Binary file not shown.

After

Width:  |  Height:  |  Size: 72 KiB

BIN
docs/img/new_ui/dev/project/workflow-list.png

Binary file not shown.

After

Width:  |  Height:  |  Size: 140 KiB

BIN
docs/img/new_ui/dev/project/workflow-online.png

Binary file not shown.

After

Width:  |  Height:  |  Size: 141 KiB

BIN
docs/img/new_ui/dev/project/workflow-run.png

Binary file not shown.

After

Width:  |  Height:  |  Size: 169 KiB

BIN
docs/img/new_ui/dev/project/workflow-save.png

Binary file not shown.

After

Width:  |  Height:  |  Size: 134 KiB

BIN
docs/img/new_ui/dev/project/workflow-time01.png

Binary file not shown.

After

Width:  |  Height:  |  Size: 1.1 MiB

BIN
docs/img/new_ui/dev/project/workflow-time02.png

Binary file not shown.

After

Width:  |  Height:  |  Size: 169 KiB

BIN
docs/img/new_ui/dev/project/workflow-time03.png

Binary file not shown.

After

Width:  |  Height:  |  Size: 61 KiB

BIN
docs/img/new_ui/dev/project/workflow-tree.png

Binary file not shown.

After

Width:  |  Height:  |  Size: 75 KiB

BIN
docs/img/run-work.png

Binary file not shown.

Before

Width:  |  Height:  |  Size: 12 KiB

BIN
docs/img/run_params.png

Binary file not shown.

Before

Width:  |  Height:  |  Size: 37 KiB

BIN
docs/img/run_params_en.png

Binary file not shown.

Before

Width:  |  Height:  |  Size: 458 KiB

BIN
docs/img/run_work_en.png

Binary file not shown.

Before

Width:  |  Height:  |  Size: 128 KiB

BIN
docs/img/task-list-en.png

Binary file not shown.

Before

Width:  |  Height:  |  Size: 273 KiB

BIN
docs/img/task-list.png

Binary file not shown.

Before

Width:  |  Height:  |  Size: 144 KiB

BIN
docs/img/task-log-en.png

Binary file not shown.

Before

Width:  |  Height:  |  Size: 376 KiB

BIN
docs/img/task-log2-en.png

Binary file not shown.

Before

Width:  |  Height:  |  Size: 234 KiB

BIN
docs/img/task-log2.png

Binary file not shown.

Before

Width:  |  Height:  |  Size: 114 KiB

BIN
docs/img/task_history.png

Binary file not shown.

Before

Width:  |  Height:  |  Size: 55 KiB

BIN
docs/img/task_history_en.png

Binary file not shown.

Before

Width:  |  Height:  |  Size: 580 KiB

BIN
docs/img/time-manage-list-en.png

Binary file not shown.

Before

Width:  |  Height:  |  Size: 162 KiB

BIN
docs/img/time-schedule.png

Binary file not shown.

Before

Width:  |  Height:  |  Size: 17 KiB

BIN
docs/img/time-schedule2.png

Binary file not shown.

Before

Width:  |  Height:  |  Size: 13 KiB

BIN
docs/img/time-schedule3.png

Binary file not shown.

Before

Width:  |  Height:  |  Size: 13 KiB

BIN
docs/img/time_schedule_en.png

Binary file not shown.

Before

Width:  |  Height:  |  Size: 168 KiB

BIN
docs/img/timer-en.png

Binary file not shown.

Before

Width:  |  Height:  |  Size: 39 KiB

BIN
docs/img/tree.png

Binary file not shown.

Before

Width:  |  Height:  |  Size: 34 KiB

BIN
docs/img/tree_en.png

Binary file not shown.

Before

Width:  |  Height:  |  Size: 443 KiB

BIN
docs/img/work_list.png

Binary file not shown.

Before

Width:  |  Height:  |  Size: 27 KiB

BIN
docs/img/work_list_en.png

Binary file not shown.

Before

Width:  |  Height:  |  Size: 419 KiB

Loading…
Cancel
Save