Update PiFlow_V0.7_User_Guide.md
This commit is contained in:
huzekang
GitHub
parent
9ba24e1f80
commit
d36c22c16d
|
|
@ -60,24 +60,20 @@ l DataSource：数据源
|
||||||
|
|
||||||
### 3.1.1 注册
|
### 3.1.1 注册
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
### 3.1.2 登录
|
### 3.1.2 登录
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
### 3.1.3 流水线Flow
|
### 3.1.3 流水线Flow
|
||||||
|
|
||||||
#### 3.1.3.1 流水线列表
|
#### 3.1.3.1 流水线列表
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
Ø 可点击进入流水线配置页面按钮，对流水线进行配置。
|
Ø 可点击进入流水线配置页面按钮，对流水线进行配置。
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
Ø 可编辑流水线信息
|
Ø 可编辑流水线信息
|
||||||
|
|
@ -88,216 +84,178 @@ l DataSource：数据源
|
||||||
|
|
||||||
Ø 可运行流水线
|
Ø 可运行流水线
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
Ø 可以debug模式运行流水线
|
Ø 可以debug模式运行流水线
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
Ø 可删除流水线
|
Ø 可删除流水线
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
Ø 可对流水线保存模板
|
Ø 可对流水线保存模板
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
#### 3.1.3.2 创建流水线
|
#### 3.1.3.2 创建流水线
|
||||||
|
|
||||||
用户点击创建按钮，创建流水线。需要输入流水线名称及描述信息，同时可设置流水线需要的资源。
|
用户点击创建按钮，创建流水线。需要输入流水线名称及描述信息，同时可设置流水线需要的资源。
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
#### 3.1.3.3 配置流水线
|
#### 3.1.3.3 配置流水线
|
||||||
|
|
||||||
Ø 用户可通过拖拽方式进行流水线的配置，方式类似visio，如下图所示。
|
Ø 用户可通过拖拽方式进行流水线的配置，方式类似visio，如下图所示。
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
Ø 画布左边栏显示组件组和组件，可按关键字搜索。用户选择好组件后可拖至画布中央。
|
Ø 画布左边栏显示组件组和组件，可按关键字搜索。用户选择好组件后可拖至画布中央。
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
Ø 画布右侧显示流水线基本信息，包括流水线名称及描述。
|
Ø 画布右侧显示流水线基本信息，包括流水线名称及描述。
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
Ø 画布中央选择任一数据处理组件，右侧显示该数据处理组件的基本信息，包括名称，描述，作者等信息。选择AttributeInfo tab，显示该数据处理组件的属性信息，用户可根据实际需求进行配置。鼠标浮动到问号上会出现对应属性的说明，同时可以选择已设置好的数据源进行属性填充。
|
Ø 画布中央选择任一数据处理组件，右侧显示该数据处理组件的基本信息，包括名称，描述，作者等信息。选择AttributeInfo tab，显示该数据处理组件的属性信息，用户可根据实际需求进行配置。鼠标浮动到问号上会出现对应属性的说明，同时可以选择已设置好的数据源进行属性填充。
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
#### 3.1.3.4 运行流水线
|
#### 3.1.3.4 运行流水线
|
||||||
|
|
||||||
Ø 用户配置好流水线后，可点击运行按钮运行流水线。
|
Ø 用户配置好流水线后，可点击运行按钮运行流水线。
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
#### 3.1.3.5 流水线监控
|
#### 3.1.3.5 流水线监控
|
||||||
|
|
||||||
加载完成之后，进入流水线监控页面。监控页面会显示整条流水线的执行状况，包括运行状态、执行进度、执行时间等。点击具体数据处理组件，显示该数据处理组件的运行状况，包括运行状态、执行时间。
|
加载完成之后，进入流水线监控页面。监控页面会显示整条流水线的执行状况，包括运行状态、执行进度、执行时间等。点击具体数据处理组件，显示该数据处理组件的运行状况，包括运行状态、执行时间。
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
#### 3.1.3.6 流水线日志
|
#### 3.1.3.6 流水线日志
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
#### 3.1.3.7 调试流水线
|
#### 3.1.3.7 调试流水线
|
||||||
|
|
||||||
Ø 可以以Debug模式运行流水线，运行后可查看流经每条线上的数据信息，实现数据可溯源
|
Ø 可以以Debug模式运行流水线，运行后可查看流经每条线上的数据信息，实现数据可溯源
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
#### 3.1.3.8 检查点
|
#### 3.1.3.8 检查点
|
||||||
|
|
||||||
Ø 流水线可设置检查点，再次运行时可选择从检查点运行
|
Ø 流水线可设置检查点，再次运行时可选择从检查点运行
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
### 3.1.4 流水线组Group
|
### 3.1.4 流水线组Group
|
||||||
|
|
||||||
#### 3.1.4.1 流水线组列表
|
#### 3.1.4.1 流水线组列表
|
||||||
|
|
||||||
Ø 流水线组支持流水线的调度功能，组嵌套功能。列表功能与流水线列表功能一致。
|
Ø 流水线组支持流水线的调度功能，组嵌套功能。列表功能与流水线列表功能一致。
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
#### 3.1.4.2 新建流水线组
|
#### 3.1.4.2 新建流水线组
|
||||||
|
|
||||||
Ø 点击创建按钮，输入流水线组名称和基本信息可创建流水线组Group。
|
Ø 点击创建按钮，输入流水线组名称和基本信息可创建流水线组Group。
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
#### 3.1.4.3 配置流水线组
|
#### 3.1.4.3 配置流水线组
|
||||||
|
|
||||||
##### 3.2.4.3.1 创建group
|
##### 3.2.4.3.1 创建group
|
||||||
|
|
||||||
Ø 拖动左侧group图标
|
Ø 拖动左侧group图标
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
##### 3.2.4.3.2 创建flow
|
##### 3.2.4.3.2 创建flow
|
||||||
|
|
||||||
Ø 拖动flow图标创建流水线flow
|
Ø 拖动flow图标创建流水线flow
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
##### 3.2.4.3.3 创建label
|
##### 3.2.4.3.3 创建label
|
||||||
|
|
||||||
Ø 拖动Label可添加标签，用于备注说明
|
Ø 拖动Label可添加标签，用于备注说明
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
##### 3.2.4.3.4 创建调度关系
|
##### 3.2.4.3.4 创建调度关系
|
||||||
|
|
||||||
Ø 连线实现调度顺序
|
Ø 连线实现调度顺序
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
##### 3.2.4.3.5 创建子group
|
##### 3.2.4.3.5 创建子group
|
||||||
|
|
||||||
Ø Group可双击进入，配置组内流水线组group、流水线flow、以及之间的调度顺序
|
Ø Group可双击进入，配置组内流水线组group、流水线flow、以及之间的调度顺序
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
##### 3.2.4.3.6 配置流水线flow
|
##### 3.2.4.3.6 配置流水线flow
|
||||||
|
|
||||||
Ø 双击flow图标，可进入具体流水线的配置界面
|
Ø 双击flow图标，可进入具体流水线的配置界面
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
##### 3.2.4.3.7 导入流水线flow
|
##### 3.2.4.3.7 导入流水线flow
|
||||||
|
|
||||||
Ø 可导入flow列表中已配置的流水线
|
Ø 可导入flow列表中已配置的流水线
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
##### 3.2.4.3.8 更换图标
|
##### 3.2.4.3.8 更换图标
|
||||||
|
|
||||||
Ø 右键group或flow，可支持更换图标
|
Ø 右键group或flow，可支持更换图标
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
Ø Group图标列表，支持用户上传
|
Ø Group图标列表，支持用户上传
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
Ø Flow图标列表，支持用户上传
|
Ø Flow图标列表，支持用户上传
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
#### 3.1.4.4 运行流水线组
|
#### 3.1.4.4 运行流水线组
|
||||||
|
|
||||||
Ø 运行
|
Ø 运行
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
Ø 可右键运行单个group或flow
|
Ø 可右键运行单个group或flow
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
#### 3.1.4.5 监控流水线组
|
#### 3.1.4.5 监控流水线组
|
||||||
|
|
||||||
Ø 默认显示流水线组监控信息
|
Ø 默认显示流水线组监控信息
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
Ø 单击group或flow，显示点击组件的监控信息
|
Ø 单击group或flow，显示点击组件的监控信息
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
可双击进入group或flow，查看进一步监控信息
|
可双击进入group或flow，查看进一步监控信息
|
||||||
|
|
||||||
#### 3.1.4.6 流水线组日志
|
#### 3.1.4.6 流水线组日志
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
### 3.1.5 运行态流水线Process
|
### 3.1.5 运行态流水线Process
|
||||||
|
|
||||||
已运行流水线组和流水线会显示在Process List中，包括开始时间、结束时间、进度、状态等。同时可对已运行流水线进行查看，在运行，停止，和删除操作。
|
已运行流水线组和流水线会显示在Process List中，包括开始时间、结束时间、进度、状态等。同时可对已运行流水线进行查看，在运行，停止，和删除操作。
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
### 3.1.6 模板Template
|
### 3.1.6 模板Template
|
||||||
|
|
||||||
流水线组和流水线可保存成模板
|
流水线组和流水线可保存成模板
|
||||||
|
|
@ -306,56 +264,47 @@ l DataSource：数据源
|
||||||
|
|
||||||
Ø 流水线保存模板
|
Ø 流水线保存模板
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
Ø 流水线组保存模板
|
Ø 流水线组保存模板
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
#### 3.1.6.2 模板列表
|
#### 3.1.6.2 模板列表
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
#### 3.1.6.3 模板下载
|
#### 3.1.6.3 模板下载
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
#### 3.1.6.4 模板上传
|
#### 3.1.6.4 模板上传
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
#### 3.1.6.5 模板加载
|
#### 3.1.6.5 模板加载
|
||||||
|
|
||||||
Ø 流水线模板加载
|
Ø 流水线模板加载
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
Ø 流水线组模板加载
|
Ø 流水线组模板加载
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
#### 3.1.6.6 模板删除
|
#### 3.1.6.6 模板删除
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
### 3.1.7 数据源
|
### 3.1.7 数据源
|
||||||
|
|
@ -364,7 +313,7 @@ l DataSource：数据源
|
||||||
|
|
||||||
Ø 支持JDBC、ElasticSearch、等数据源的创建。同时支持自定义数据源（other）
|
Ø 支持JDBC、ElasticSearch、等数据源的创建。同时支持自定义数据源（other）
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
#### 3.1.7.1 使用数据源
|
#### 3.1.7.1 使用数据源
|
||||||
|
|
||||||
|
|
|
||||||
Loading…
Reference in New Issue