创建工作流
本文主要以离线工作流为主体介绍完整创建及使用流程,同时标注在线工作流专属差异及独有功能。
操作步骤
- 登录百度胜算控制台,在选中的工作空间操作列单击打开按钮,进入空间内。
- 侧边导航依次单击数据连接与集成>工作流,在工作流列表右上方单击创建工作流。
- 填写新建工作流相关配置项后确定。
表1 创建工作流配置项说明
| 配置项名称 | 配置项说明 |
|---|---|
| 工作流名称 | 填写工作流名称,名称不可重复。支持中文、英文、数字、中划线(-)、下划线(_),不超过256字符。 |
| 所属位置 | 指定当前任务所处项目文件夹,侧边通过浏览按钮选择路径,实现任务文件的统一管理。 |
| 工作流类型 | 支持在线和离线两种类型: |
| 描述 | 填写工作流描述,不超过500字符。 |
- 完成工作流创建后,支持三种方式对工作流进行编排:
-
创建空白工作流:从空白画布开始搭建流程,单击当前卡片后直接进入编辑态并关闭初始化卡片。在编辑工作流页面,支持可视化界面编辑和JSON编辑两种方式。
• 使用可视化界面编辑
在线工作流限制:仅开放算子任务编辑能力,仅可使用算子任务组件;
离线工作流支持全组件自由编排。
提供可视化拖拽交互界面,以直观方式完成工作流的设计、编排与编辑。
- 在左侧选择对应组件,组件将自动添加至画布居中位置;您可自由调整流程图节点排布,按需自定义业务流程拓扑结构。
- 选中画布中的组件,配置对应业务任务编排。
-
选中目标节点,支持修改节点名称、依赖服务、参数等配置。
• 使用JSON编辑
支持通过编写简洁、易读的 YAML 配置文件,完成工作流的定义、配置与管理。
- 单击JSON按钮,切换成JSON编辑界面。
- 在左侧代码框中输入定义工作流的YAML代码。
- 模版插入:选择预置模版快速生成工作流框架,单击当前卡片,在模版插入弹窗中选中模版,单击使用模版即可。
系统按类型隔离模版:在线/离线工作流仅可使用对应类型模版。
- 本地导入:导入本地JSON工作流文件,快速恢复或复用已有流程,单击当前卡片,在本体导入弹窗中单击上传文件,然后单击确认。
- 完成工作流编辑后,系统还支持修改基本信息、全局参数、开启调度等操作,满足工作流的全生命周期管理需求。更多操作详情可参见工作流全生命周期管理。
工作流全生命周期管理
完成工作流编辑后,还支持基础管理操作,适配不同类型工作流的场景需求,具体操作差异如下:
- 通用操作:修改工作流信息、修改全局参数、导出、导入、模板、删除、运行记录、保存。
- 离线工作流:运行配置、通知告警、调度策略、开启调度、立即运行。
- 在线工作流:API 调用(发布为常驻在线服务,支持同步请求)。
通用操作
修改工作流信息
单击右侧基本信息按钮,支持对工作流名称、负责人、描述、请求类型进行编辑。具体配置详情可参见下表:
| 配置项名称 | 配置项说明 |
|---|---|
| 工作流名称 | 用于标识工作流的名称,是工作流的核心标识。此处支持对工作流名称进行修改,不超过256字符。 |
| 所属位置 | 当前任务所处项目文件夹。 |
| 工作流 ID | 系统自动生成的工作流唯一标识符。 |
| 创建时间 | 记录工作流创建的具体时间。 |
| 修改时间 | 记录工作流最后一次修改的时间。 |
| 创建人 | 记录创建该工作流的用户。 |
| 负责人 | 可通过下拉选择负责该工作流的用户。负责人是为工作流运行提供权限的角色,工作流会使用负责人权限运行。注意:修改负责人需具备工作管理员权限。 |
| 最后修改人 | 记录最后一次修改该工作流的用户。 |
| 描述 | 可输入对该工作流的描述信息。 |
| 请求类型 | 当前工作流的请求类型。支持同步请求和异步请求。 |
修改全局参数
单击右侧全局参数按钮,支持对global_dst_path、global_dst_file_ttl两个系统预置全局参数进行编辑修改,同时支持自定义新增全局参数。具体配置详情可参见下表:
| 配置项名称 | 配置项说明 |
|---|---|
| global_dst_path | global_dst_path 为全局变量,影响 dst_path 参数的输出的路径,默认以用户拥有权限的第一个 Volume 目录路径。 |
| global_dst_file_ttl | 只影响 global_dst_path 路径下面的文件保留时间,到期自动清理。 |
导出
单击页面右上角"..."按钮,然后单击导出按钮,在弹出的导出工作流对话框中单击确认,即可完成工作流导出。
需要先保存工作流,才能进行导出操作。
导入
单击页面右上角"..."按钮,然后单击导入按钮,在弹出的导入工作流对话框中单击上传文件,选定文件后然后单击确认,即可完成工作流导入。
导入新工作流后,原有的工作流将会被清空,请谨慎操作。 仅支持JSON格式文件。
模板
单击页面右上角"..."按钮,然后单击模板按钮,在弹出的模板选择对话框中,可输入模板名称进行关键字搜索,快速定位目标模板。
系统会根据当前工作流类型做隔离,仅支持选择同类型的工作流模板;选中对应模板后,单击使用模板,即可完成模板的使用。
模板插入后,原有的工作流将会被清空,请谨慎操作。
删除
单击页面右上角"..."按钮,然后单击删除按钮,在弹出的模板选择对话框中单击OK,即可完成删除操作。
删除后,工作流和运行中的数据将会进入回收站,可从回收站中彻底删除。
运行记录
- 单击页面右上角运行记录按钮,跳转至当前工作流的运行记录页面。
- 运行工作流作业生成的记录以列表形式展示,在列表中可查看当前工作流运行的详细信息。更多详情,可参见运行记录详情。
表2 运行记录列表项说明
| 列表项名称 | 列表项说明 |
|---|---|
| 工作流运行记录ID | 工作流每次运行的唯一标识,用于区分和追踪特定运行实例。单击目标ID,进入记录详情界面,可查看当前运行记录的详细信息,包括基本信息、全局参数等信息。 |
| 状态 | 状态分别为运行中、成功、失败等。 |
| 运行类型 | 支持单次执行、例行执行、补数据执行、常驻执行四种运动类型;并支持按类型进行筛选。说明:工作流为“运行中”且执行类型为“常驻执行”的工作流点击进入后,不允许编辑操作。提示“工作流服务正在运行,无法编辑,如需编辑调整工作流请先停止服务。 |
| 调度时间 | 工作流按计划应启动运行的时间。 |
| 开始时间 | 工作流实际启动执行的时间点。 |
| 结束时间 | 工作流运行终止的时间点。 |
| 运行时长 | 工作流运行从开始到结束所经历的时长。 |
| 负责人 | 当前工作流的负责人。 |
| 运行用户 | 执行该工作流运行操作的用户。 |
| 操作 | 单击操作列不同按钮,执行不同操作。 |
| 工作流详情 | 单击工作流详情按钮,进入当前工作流可视化详情页面,可查看工作流基本信息、全局参数等相关内容;同时支持单击编辑或立即运行按钮,对工作流进行对应操作。 |
保存
单击页面右上角保存按钮,对当前工作流进行保存。
离线工作流
修改运行配置
单击右侧基本信息按钮,支持对运行配置的执行策略、最大并行数和失败策略进行修改。具体配置详情可参见下表:
| 配置项名称 | 配置项说明 |
|---|---|
| 执行策略 | 并行/串行等待。 提示: 1. 并行执行:如果对于同一个工作流定义,同时有多个工作流实例,则全部并行执行工作流实例。 2.串行执行:如果对于同一个工作流定义,同时有多个工作流实例,可同时执行的工作流实例由最大数并行数决定,超过最大并行数则串行执行工作流实例。 |
| 最大并行数 | 当执行策略选择串行等待时,需填写此配置项。注意:超过最大并行数据的工作流实例,则排队等待执行,如果最大并行数为1,则所有工作流实例依次串行执行。 |
| 失败策略 | 继续/结束。 提示:当某一个任务节点执行失败时,其他并行的任务节点需要执行的策略。 “继续”表示:某一任务失败后,其他任务节点正常执行。 “结束”表示:终止所有正在执行的任务,并终止整个流程。 |
修改通知告警
单击右侧基本信息按钮,默认没有告警策略,可单击编辑按钮进行新增告警策略。具体配置详情可参见下表:
| 配置项名称 | 配置项说明 |
|---|---|
| 模板 | 在输入框中选择模板,支持新建模板。 |
| 用户 | 创建当前模板的用户。 |
| 方式 | 当前模板的告警方式。 |
| 告警策略 | 支持开始、成功、失败、超时四种告警策略。 |
| 操作 | 单击移除按钮,将当前模板进行移除。单击新增告警策略按钮,可新增一条新的告警策略。 |
调度策略
单击右侧调度策略按钮,支持策略的优先级、起始时间、终止时间、类型、CRON表达式进行编辑。具体配置详情可参见下表:
| 配置项名称 | 配置项说明 |
|---|---|
| 优先级 | 工作流在调度过程中的执行优先级,级别高的流程在执行队列中会优先执行,相同优先级的流程按照先进先出的顺序执行。支持最低、低、中、高、最高5种优先级。 |
| 调度状态 | 默认是关闭。 |
| 起始时间 | 调度策略的开始时间。 |
| 终止时间 | 调度策略的终止时间。 |
| 类型 | 支持每小时、每天、每周、每月、每年、CRON表达式6种类型,根据不同类型需要配置不同的参数,例如定时时间、星期、日期选择、月份选择、CRON表达式。 |
开启调度
单击页面右上角"..."按钮,然后单击开启调度按钮,在弹出的开启调度对话框中单击确认,即可开启调度。
开启调度后,无法编辑,如需编辑调整工作流请先关闭调度。
立即运行
单击右上角立即运行按钮,在弹出的立即运行对话框中单击确认,即可开始运行。
在线工作流
API调用
通过单击API调用可以进入API调用示例面板,可查看API调用信息,包括选择API Key或创建API Key。
表3 API调用信息说明
| 配置项名称 | 配置项说明 |
|---|---|
| API调用 | 调用的接口说明。 |
| 请求参数 | 算子任务服务化后,请求接口的参数说明。 |
| API Key | 选择 API Key,支持单击添加 API Key;输入名称后,单击生成 API Key,系统将自动生成一组密钥。选中目标 API Key,单击复制并填入即可自动填入对应配置项。注意:APlKey长期有效,请您不要将密钥信息共享至公开环境,妥善保管并定期轮换密钥,避免因未经授权的使用造成安全风险或资金损失。 |
| 代码示例 | 异步接口的调用示例。 |
评价此篇文章
