controller_labels.yml

In these files we configure the labels 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_labels. 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 labels 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 api understands the following structure for defining labels in controller:

{
    "name": "",
    "organization": null
}

group_vars/all/controller_labels.yml

Here we see an empty set for all.

---
controller_labels_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_labels.yml

As we do not configure extra labels in development, this file is an empty set.
(We use the containerized setup version, so no need for labels).

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

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

group_vars/prod/controller_labels.yml

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

---
controller_labels_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_labels_all
- controller_labels_

We will merge these 2 variables into 1: controller_labels and feed this to the infra.aap_configuration.controller_labels 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_labels: >
          {{ controller_labels_all |
          community.general.lists_mergeby(vars['controller_labels_' + branch_name],
          'name', recursive=true, list_merge='append') }}

This results in the controller_labels variable the collection needs.

Back