awx.awx.workflow_job_template_node 模块 – 创建、更新或销毁 Automation Platform Controller 工作流作业模板节点。

注意

此模块是 awx.awx 集合(版本 24.6.1)的一部分。

如果您正在使用 ansible 包,您可能已经安装了此集合。它不包含在 ansible-core 中。要检查它是否已安装,请运行 ansible-galaxy collection list

要安装它,请使用:ansible-galaxy collection install awx.awx

要在 playbook 中使用它,请指定:awx.awx.workflow_job_template_node

概要

  • 创建、更新或销毁 Automation Platform Controller 工作流作业模板节点。

  • 使用它为工作流构建一个图,该图指示工作流的运行内容。

  • 您可以先创建节点,然后链接它们,而无需担心排序。为了安全地引用节点,请指定标识符、WFJT 和组织。指定这些后,您可以选择修改或不修改任何其他参数。

别名:tower_workflow_job_template_node

参数

参数

注释

all_parents_must_converge

布尔值

如果启用,则仅当所有父节点都满足到达此节点的条件时,该节点才会运行

选项

  • false

  • true

always_nodes

列表 / 元素=字符串

此节点完成后将运行的节点。

节点标识符列表。

approval_node

字典

审批节点的名称、描述和超时值的字典。

此参数与 unified_job_template 互斥。

description

字符串

此工作流审批模板的可选描述。

name

字符串 / 必需

此工作流审批模板的名称。

timeout

整数

审批节点过期并失败之前的时间量(以秒为单位)。

controller_config_file

别名:tower_config_file

路径

Controller 配置文件路径。

如果提供,则不会考虑其他配置文件位置。

controller_host

别名:tower_host

字符串

您的 Automation Platform Controller 实例的 URL。

如果未设置值,将尝试环境变量 CONTROLLER_HOST,然后尝试配置文件

如果未通过任何方式指定值,将使用值 127.0.0.1

controller_oauthtoken

别名:tower_oauthtoken

任何

在 awx.awx 3.7.0 中添加

要使用的 OAuth 令牌。

此值可以采用以下两种格式之一。

一个字符串,即令牌本身。(例如,bqV5txm97wqJqtkxlMkhQz0pKhRMMX)

令牌模块返回的字典结构。

如果未设置值,将尝试环境变量 CONTROLLER_OAUTH_TOKEN,然后尝试配置文件

controller_password

别名:tower_password

字符串

您的 Controller 实例的密码。

如果未设置值,将尝试环境变量 CONTROLLER_PASSWORD,然后尝试配置文件

controller_username

别名:tower_username

字符串

您的 Controller 实例的用户名。

如果未设置值,将尝试环境变量 CONTROLLER_USERNAME,然后尝试配置文件

credentials

列表 / 元素=字符串

要应用于作业作为启动时提示的凭据名称、ID 或命名 URL。

凭据名称、ID 或命名 URL 的列表。

不严格处理唯一性。

diff_mode

布尔值

如果作业模板提示需要差异模式,则运行差异模式,作为提示应用

选项

  • false

  • true

execution_environment

字符串

如果作业模板提示需要执行环境,则应用执行环境名称、ID 或命名 URL 作为提示

extra_data

字典

要在启动时应用的变量。

仅当作业模板提示需要变量或具有询问这些变量的调查时,才会接受此变量。

failure_nodes

列表 / 元素=字符串

此节点失败后将运行的节点。

节点标识符列表。

forks

整数

如果作业模板提示需要 forks,则应用 forks 作为提示

identifier

字符串 / 必需

此节点在其工作流中唯一的标识符。

它会复制到与此节点对应的工作流作业节点。

instance_groups

列表 / 元素=字符串

如果作业模板提示需要实例组,则应用实例组名称、ID 或命名 URL 的列表作为提示

inventory

字符串

如果作业模板提示需要清单,则应用清单的名称、ID 或命名 URL 作为提示

job_slice_count

整数

如果作业模板提示需要作业切片计数,则应用作业切片计数作为提示

job_tags

字符串

如果作业模板提示需要作业标签,则应用作业标签作为提示

job_type

字符串

如果作业模板提示需要作业类型,则应用作业类型作为提示

选项

  • "run"

  • "check"

labels

列表 / 元素=字符串

如果作业模板提示需要标签,则应用标签列表作为提示

limit

字符串

如果作业模板提示限制,则作为提示应用的限制。

lookup_organization

字符串

库存、作业模板、项目、统一作业模板所在的组织名称、ID 或命名 URL。

如果未提供,将仅按名称查找,这不适用于重复项。

organization

字符串

工作流作业模板的组织名称、ID 或命名 URL,节点存在于该模板中。

用于查找工作流,而不是直接的模型字段。

request_timeout

float

指定 Ansible 在向控制器主机发出请求时应使用的超时时间。

默认为 10 秒,但这由共享的 module_utils 代码处理

scm_branch

字符串

如果作业模板提示 SCM 分支,则作为提示应用的 SCM 分支。

skip_tags

字符串

如果要跳过的标签,如果作业模板提示作业标签,则作为提示应用。

state

字符串

资源的期望状态。

选项

  • "present" ← (默认)

  • "absent"

  • "exists"

success_nodes

列表 / 元素=字符串

此节点成功后将运行的节点。

节点标识符列表。

timeout

整数

作为提示应用的超时时间,假设作业模板提示超时时间

unified_job_template

字符串

要在工作流中运行的统一作业模板的名称。

可以是作业模板、项目、库存源等。

如果创建审批节点,则省略。

此参数与 approval_node 互斥。

validate_certs

别名: tower_verify_ssl

布尔值

是否允许与 AWX 建立不安全的连接。

如果为 no,则不会验证 SSL 证书。

这仅应在个人控制的使用自签名证书的站点上使用。

如果未设置值,将尝试环境变量 CONTROLLER_VERIFY_SSL 然后尝试配置文件

选项

  • false

  • true

verbosity

字符串

如果作业模板提示详细程度,则作为提示应用的详细程度。

选项

  • "0"

  • "1"

  • "2"

  • "3"

  • "4"

  • "5"

workflow_job_template

别名: workflow

字符串 / 必需

工作流作业模板的名称、ID 或命名 URL,节点存在于该模板中。

用于查找节点,创建后无法修改。

备注

注意

  • 如果没有提供 *config_file*,我们将尝试使用 tower-cli 库的默认值来查找您的主机信息。

  • *config_file* 应采用以下格式:host=hostname username=username password=password

示例

- name: Create a node, follows workflow_job_template example
  workflow_job_template_node:
    identifier: my-first-node
    workflow: example-workflow
    unified_job_template: jt-for-node-use
    organization: Default  # organization of workflow job template
    extra_data:
      foo_key: bar_value

- name: Create parent node for prior node
  workflow_job_template_node:
    identifier: my-root-node
    workflow: example-workflow
    unified_job_template: jt-for-node-use
    organization: Default
    success_nodes:
      - my-first-node

- name: Create workflow with 2 Job Templates and an approval node in between
  block:
  - name: Create a workflow job template
    tower_workflow_job_template:
      name: my-workflow-job-template
      ask_scm_branch_on_launch: true
      organization: Default

  - name: Create 1st node
    tower_workflow_job_template_node:
      identifier: my-first-node
      workflow_job_template: my-workflow-job-template
      unified_job_template: some_job_template
      organization: Default

  - name: Create 2nd approval node
    tower_workflow_job_template_node:
      identifier: my-second-approval-node
      workflow_job_template: my-workflow-job-template
      organization: Default
      approval_node:
        description: "Do this?"
        name: my-second-approval-node
        timeout: 3600

  - name: Create 3rd node
    tower_workflow_job_template_node:
      identifier: my-third-node
      workflow_job_template: my-workflow-job-template
      unified_job_template: some_other_job_template
      organization: Default

  - name: Link 1st node to 2nd Approval node
    tower_workflow_job_template_node:
      identifier: my-first-node
      workflow_job_template: my-workflow-job-template
      organization: Default
      success_nodes:
        - my-second-approval-node

  - name: Link 2nd Approval Node 3rd node
    tower_workflow_job_template_node:
      identifier: my-second-approval-node
      workflow_job_template: my-workflow-job-template
      organization: Default
      success_nodes:
        - my-third-node

作者

  • John Westcott IV (@john-westcott-iv)