infra.aap_configuration.dispatch

Description

An Ansible Role to run all roles in the infra.aap_configuration collection.

Variables

This is a meta role, its purpose is to run the other roles in the collection, it does not run all of them, and can be used to call roles in a custom order, The control variable is the aap_configuration_dispatcher_roles which will pull roles from the different services and run them, If you wish to just run a subset of services from our default lists remove entries from this var.

Option: dispatch_include_wildcard_vars

This option provides a powerful way to organize your configuration. When you set dispatch_include_wildcard_vars: true, the role will automatically find and combine settings that you have defined across multiple different variables. This lets you keep your configuration neat and tidy (e.g., defining projects for each environment in separate, organized files) instead of managing one giant list.

Example Setup and Workflow

This example shows how to structure your files and playbook to use this feature, combining a set of “common” projects with environment-specific ones.

1. Organize Your Configuration Files

First, create folders to hold your common and environment-specific configurations. This approach allows you to separate different types of configurations into their own files and reduce duplication.

.
├── playbook.yml
└── config/
    ├── all/
    │   └── projects.yml
    ├── dev/
    │   └── projects.yml
    └── prod/
        └── projects.yml

NOTE: This is just an example and you can organize it however you want. You can also use group_vars as well the only thing that matters is the naming the vars and getting them ingested in some way.

2. Define Variables in Your Files

Next, define the variables inside the corresponding files. Notice the variable names end with a suffix (_all, _prod, etc.) that identifies their purpose.

config/all/projects.yml:

controller_projects_all:
  - name: Common Intranet Project
    organization: Default
    scm_type: git
    scm_url: git@github.com:acme-org/common-intranet.git

config/prod/projects.yml:

controller_projects_prod:
  - name: Production App Project
    organization: Production
    scm_type: git
    scm_url: git@github.com:acme-org/prod-app.git

3. Load the Variables in Your Playbook

In your main playbook, you must load all the relevant configuration files. A common pattern is to load the all directory first, then layer the environment-specific configuration on top.

playbook.yml:

- name: Configure AAP
  hosts: localhost
  gather_facts: false

  tasks:
    - name: Load all common configuration
      ansible.builtin.include_vars:
        dir: "config/all"
        extensions:
          - 'yml'

    - name: Load environment-specific configuration
      ansible.builtin.include_vars:
        dir: "config/"
        extensions:
          - 'yml'
      # Example: Run with `ansible-playbook playbook.yml -e "env=prod"`

    - name: Run the main configuration role
      ansible.builtin.include_role:
        name: infra.aap_configuration.dispatch
      vars:
        dispatch_include_wildcard_vars: true

4. See the Result

When you run the playbook (e.g., with -e "env=prod"), it loads variables from both config/all and config/prod. The dispatch role will then detect both the controller_projects_all and controller_projects_prod variables. Because dispatch_include_wildcard_vars is true, it automatically merges their contents into the base controller_projects variable.

Resulting Master List

controller_projects:
  - name: Common Intranet Project
    organization: Default
    scm_type: git
    scm_url: git@github.com:acme-org/common-intranet.git
  - name: Production App Project
    organization: Production
    scm_type: git
    scm_url: git@github.com:acme-org/prod-app.git

By default, this option is false.

aap_configuration_dispatcher_roles: >
  

In addition each service has its own subset of roles, and each role has its own tag that can be used as well.

Gateway Roles

gateway_configuration_dispatcher_roles:
  - role: gateway_authenticators
    var: gateway_authenticators
    tags: authenticators
  - role: gateway_authenticator_maps
    var: gateway_authenticator_maps
    tags: authenticator_maps
  - role: gateway_settings
    var: gateway_settings
    tags: settings
  - role: gateway_organizations
    var: aap_organizations
    tags: organizations
    assign_galaxy_credentials_to_org: false
    assign_default_ee_to_org: false
    assign_notification_templates_to_org: false
  - role: gateway_applications
    var: aap_applications
    tags: applications
  - role: gateway_http_ports
    var: gateway_http_ports
    tags: http_ports
  - role: gateway_service_clusters
    var: gateway_service_clusters
    tags: service_clusters
  - role: gateway_service_keys
    var: gateway_service_keys
    tags: service_keys
  - role: gateway_service_nodes
    var: gateway_service_nodes
    tags: service_nodes
  - role: gateway_services
    var: gateway_services
    tags: services
  - role: gateway_teams
    var: aap_teams
    tags: teams
  - role: gateway_users
    var: aap_user_accounts
    tags: users
  - role: gateway_role_definitions
    var: gateway_role_definitions
    tags: role_definitions
  - role: gateway_role_team_assignments
    var: gateway_role_team_assignments
    tags: role_team_assignments
  - role: gateway_role_user_assignments
    var: gateway_role_user_assignments
    tags: role_user_assignments
  - role: gateway_routes
    var: gateway_routes
    tags: routes

Hub Roles

hub_configuration_dispatcher_roles:
  - role: hub_namespace
    var: hub_namespaces
    tags: namespaces
  - role: hub_collection
    var: hub_collections
    tags: collections
  - role: hub_ee_registry
    var: hub_ee_registries
    tags: registries
  - role: hub_ee_repository
    var: hub_ee_repositories
    tags: repos
  - role: hub_ee_repository_sync
    var: hub_ee_repository_sync
    tags: reposync
  - role: hub_ee_image
    var: hub_ee_images
    tags: images
  - role: hub_ee_registry
    var: hub_ee_registries
    tags: registry
  - role: hub_ee_registry_index
    var: hub_ee_registries
    tags: ee_indices
  - role: hub_ee_registry_sync
    var: hub_ee_registries
    tags: regsync
  - role: hub_collection_remote
    var: hub_collection_remotes
    tags: collectionremote
  - role: hub_collection_repository
    var: hub_collection_repositories
    tags: collectionsrep
  - role: hub_collection_repository_sync
    var: hub_collection_repositories
    tags: collectionsrepsync

Controller Roles

controller_configuration_dispatcher_roles:
  - role: controller_settings
    var: controller_settings
    tags: settings
  - role: controller_instances
    var: controller_instances
    tags: instances
  - role: controller_instance_groups
    var: controller_instance_groups
    tags: instance_groups
  - role: controller_labels
    var: controller_labels
    tags: labels
  - role: controller_credential_types
    var: controller_credential_types
    tags: credential_types
  - role: controller_credentials
    var: controller_credentials
    tags: credentials
  - role: controller_credential_input_sources
    var: controller_credential_input_sources
    tags: credential_input_sources
  - role: controller_execution_environments
    var: controller_execution_environments
    tags: execution_environments
  - role: controller_applications
    var: aap_applications
    tags: applications
  - role: controller_notification_templates
    var: controller_notifications
    tags: notification_templates
  - role: gateway_organizations
    var: aap_organizations
    tags: organizations
    assign_galaxy_credentials_to_org: true
    assign_default_ee_to_org: true
    assign_notification_templates_to_org: true
  - role: controller_projects
    var: controller_projects
    tags:
      - inventories
      - projects
  - role: controller_inventories
    var: controller_inventories
    tags: inventories
  - role: controller_inventory_sources
    var: controller_inventory_sources
    tags:
      - inventories
      - inventory_sources
  - role: controller_inventory_source_update
    var: controller_inventory_sources
    tags:
      - inventories
      - inventory_sources
  - role: controller_hosts
    var: controller_hosts
    tags:
      - inventories
      - hosts
  - role: controller_bulk_host_create
    var: controller_bulk_hosts
    tags:
      - inventories
      - bulk_hosts
  - role: controller_host_groups
    var: controller_groups
    tags:
      - inventories
      - host_groups
  - role: controller_job_templates
    var: controller_templates
    tags: job_templates
  - role: controller_workflow_job_templates
    var: controller_workflows
    tags: workflow_job_templates
  - role: controller_schedules
    var: controller_schedules
    tags: schedules
  - role: controller_roles
    var: controller_roles
    tags: roles
  - role: controller_job_launch
    var: controller_launch_jobs
    tags: job_launch
  - role: controller_workflow_launch
    var: controller_workflow_launch_jobs
    tags: workflow_launch

Eda Roles

eda_configuration_dispatcher_roles:
  - role: eda_credential_types
    var: eda_credential_types
    tags: credential_type
  - role: eda_credentials
    var: eda_credentials
    tags: credential
  - role: eda_controller_tokens
    var: eda_controller_tokens
    tags: controller_token
  - role: eda_projects
    var: eda_projects
    tags: project
  - role: eda_event_streams
    var: eda_event_streams
    tags: event_stream
  - role: eda_decision_environments
    var: eda_decision_environments
    tags: decision_environment
  - role: eda_rulebook_activations
    var: eda_rulebook_activations
    tags: rulebook_activation

Dispatch role var list keys

Each role in each service has its own variables, for information on those please see each role which this role will call. Each role is called and each item has three elements:

• role which is the name of the role within infra.aap_configuration
• var which is the variable which is used in that role. We use this to prevent the role being called if the variable is not set
• tags the tags which are applied to the role so it is possible to apply tags to a playbook using the dispatcher with these tags.

It is possible to redefine this variable with a subset of roles or with different tags. In general we suggest keeping the same structure and perhaps just using a subset.

For more information about variables, see top-level README. For more information about roles, see each roles’ README (also linked in the top-level README)

License

GPL-3.0