controller_workflows.yml

In these files we configure the workflows for automation controller.
we will probably do this on each environment separately, as the hostnames differ.

The infra.aap_configuration collection expects the vaules in the variable: controller_workflows. As we intend to configure everything just once, we spit the set of vars into the environments and join the lists in the main.yml, before calling the collection. If there are no workflows defined, do not add this file. If you do, ensure the file is present in all branches, with the correct content, described below.

variables

The workflow definition in rhaap is very complex through the api, the collection is well documented, so I will give you the direct link to the documentation:

Link opens on a new page:
controller_workflow

group_vars/all/controller_workflows.yml

Here we see an empty set for all.

---
controller_workflows_all: []
...

But you can already see that the variable name used here has the "_all" extension, so the variable will not be overridden as this is not quite a inventory.
Why we do this, will become clear in a moment.

group_vars/dev/controller_workflows.yml

As we do not configure extra workflows in development, this file is an empty set.

---
controller_workflows_dev: []
  # No extra config exists
...

Here the variable has the "_dev" extension, so the variable will not be overridden.

group_vars/prod/controller_workflows.yml

As we do not configure extra workflows in prod, this file is an empty set.

---
controller_workflows_prod: []
  # No extra config exists
...

Here the variable has the "_prod" extension, so the variable will not be overridden.

When we run a pipeline for a certain environment, the inventory structure will provide us with 2 variables: - controller_workflows_all
- controller_workflows_

We will merge these 2 variables into 1: controller_workflows and feed this to the infra.aap_configuration.controller_workflows role.
In main.yml the merge of the variables is done by this piece of code:

    - name: Set the controller vars
      ansible.builtin.set_fact:
        controller_workflows: >
          {{ controller_workflows_all |
          community.general.lists_mergeby(vars['controller_workflows_' + branch_name],
          'name', recursive=true, list_merge='append') }}

This results in the controller_workflows variable the collection needs.

Back