搜索

第 23 章 工作流作业模板

download PDF

工作流作业模板将一系列不同资源链接,这些资源将属于发布过程一部分的完整作业集合作为一个单元来跟踪。这些资源包括以下内容:

  • 作业模板
  • 工作流作业模板
  • 项目同步
  • 清单源同步

Templates 列表视图显示当前可用的工作流和作业模板。默认视图为折叠状态(Compact),显示模板名称、模板类型和使用该模板运行的作业的状态。您可以单击每个条目旁边的箭头,以展开和查看更多信息。此列表按名称按字母顺序排序,但您可以根据其他条件排序,或者根据模板的不同字段和属性进行搜索。在此屏幕中,您可以启动 Launch ,编辑 Edit ,并复制 Copy 工作流作业模板。

只有工作流模板带有工作流可视化工具 Workflow visualizer 图标作为访问工作流编辑器的快捷方式。

工作流模板主页
注意

工作流模板可用作另一个工作流模板的构建块。您可以通过在工作流模板中设置多个设置来启用 Prompt on Launch,您可以在工作流作业模板一级编辑该设置。它们不会影响在各个工作流模板级别分配的值。具体步骤请查看 工作流可视化工具 部分。

23.1. 创建工作流模板

要创建新工作流作业模板,请完成以下步骤:

重要

如果将限制设置为工作流模板,则不会传递给作业模板,除非您检查了 Prompt on launch 的限制。如果运行的 playbook 是必需的,这可能会导致 playbook 失败。

流程

  1. Templates 列表视图中,从 Add 列表中选择 Add workflow template

    创建工作流模板
  2. 在以下字段中输入相关信息:

    注意

    如果某个字段选择了 Prompt on launch 复选框,则启动工作流模板,或者在另一个工作流模板中使用工作流模板,则会提示您输入该字段的值。大多数提示的值将覆盖作业模板中设置的任何值。下表中会记录例外情况。

    字段选项启动时提示

    Name

    输入作业的名称。

    N/A

    描述

    根据需要输入任意描述(可选)。

    N/A

    机构(Organization)

    从可供登录的用户可用的机构中选择用于此模板的组织。

    N/A

    清单(Inventory)

    (可选)从登录的用户可用的清单中选择要与此模板搭配使用的清单。

    限制

    用于进一步限制受 playbook 管理或影响的主机列表的主机模式。您可以通过冒号(:)分隔多个模式。与核心 Ansible 一样:

    • a:b 表示"在组 a 或 b 中"
    • a:b:&c 表示"在 a 或 b 中,但必须在 c 中"。
    • 答:!b 表示"在 a 中,一定不要在 b 中"

    如需更多信息,请参阅 Ansible 文档中的 Patterns:以主机和组为目标

    如果选择,即使提供了默认值,也会在启动时提示您选择一个限制。

    源控制分支

    为工作流选择分支。此分支应用于提示分支的所有工作流作业模板节点。

    标签

    • (可选)提供描述此工作流作业模板的标签,如 devtest。使用标签对显示中的工作流作业模板和完成的作业进行分组和过滤。
    • 标签在添加到工作流模板时创建。标签使用工作流模板中提供的项目与单个机构关联。如果机构的成员具有编辑权限(如 admin 角色),则机构成员可以在工作流模板上创建标签。
    • 保存作业模板后,标签会显示在工作流作业模板 详情视图中
    • 标签仅应用于工作流模板,而不是工作流中使用的作业模板节点。
    • 选择标签旁边的 Disassociate 将其删除。删除标签后,它不再与该特定作业或作业模板关联,但它与引用它的任何其他作业关联。

    如果选择,即使提供了默认值,也会在启动时提示您提供附加标签(如果需要)。- 您无法删除现有标签,选择 Disassociate 仅会删除新添加的标签,而不是现有的默认标签。

    变量

    • 向 playbook 传递额外的命令行变量。

    这是 ansible-playbook 的"-e"或"-extra-vars"命令行参数,记录在 Ansible 文档中,控制 Ansible 的行为:优先级规则. - 使用 YAML 或 JSON 提供键或值对。这些变量具有最大优先级值,并覆盖其他位置指定的其他变量。以下是一个值: git_branch: production release_version: 1.5

    如果要能够在调度中指定 extra_vars,您必须在工作流作业模板中为 Variables 选择 Prompt on launch,或者在作业模板上启用问卷调查。那些回答的问卷调查问题将变为 extra_vars。有关额外变量的更多信息,请参阅 额外变量

    作业标签

    键入并选择 Create 下拉菜单来指定应运行 playbook 的哪个部分。有关更多信息和示例,请参阅 Ansible 文档中的 标签

    跳过标签

    键入并选择 Create 下拉菜单来指定要跳过的 playbook 的某些任务或部分。有关更多信息和示例,请参阅 Ansible 文档中的 标签

  3. 如果需要,指定启动此模板的以下选项:

    • 选中 Enable Webhooks 以打开与用于启动工作流作业模板的预定义 SCM 系统 Web 服务进行接口的功能。GitHub 和 GitLab 是支持的 SCM 系统。

      • 如果您启用 Webhook,会显示其他字段,提示输入更多信息:

        • Webhook Service :选择要从哪个服务侦听 Webhook。
        • Webhook 凭证 :(可选)提供 GitHub 或 GitLab 个人访问令牌(PAT)作为凭证,用来向 webhook 服务发回状态更新。如需更多信息,请参阅 凭证类型 来创建。
      • 当您点 Save 时,会填充其他字段,工作流可视化工具会自动打开。

        • Webhook URL :自动填充将 POST 请求发送到的 Webhook 服务的 URL。
        • Webhook Key: 生成共享 secret,供 Webhook 服务用来签署发送到自动化控制器的有效负载。您必须在 Webhook 服务上的设置中配置此功能,以便在自动化控制器中接受此服务的 Webhook。有关设置 Webhook 的更多信息,请参阅使用 Webhook

          选中 Enable Concurrent Jobs 以允许同时运行此工作流。如需更多信息,请参阅自动控制器容量确定和作业影响

  4. 配置完工作流模板后,点 Save

保存模板会退出工作流模板页面,并打开工作流可视化工具,以便您构建工作流。如需更多信息,请参阅 工作流可视化工具 部分。否则,请选择以下方法之一:

  • 关闭工作流可视化工具,以返回到新保存的模板的 Details 选项卡。您可以完成以下任务:

    • 查看、编辑、添加权限、通知、计划和调查
    • 查看完成的作业
    • 构建工作流模板
  • Launch 启动工作流。

    注意

    在启动前保存模板,或者 Launch 仍被禁用。Notifications 选项卡只有在您保存模板后才会显示。

保存的模板
Red Hat logoGithubRedditYoutubeTwitter

学习

尝试、购买和销售

社区

关于红帽文档

通过我们的产品和服务,以及可以信赖的内容,帮助红帽用户创新并实现他们的目标。

让开源更具包容性

红帽致力于替换我们的代码、文档和 Web 属性中存在问题的语言。欲了解更多详情,请参阅红帽博客.

關於紅帽

我们提供强化的解决方案,使企业能够更轻松地跨平台和环境(从核心数据中心到网络边缘)工作。

© 2024 Red Hat, Inc.