infra.aap_configuration.groups
Description
An Ansible Role to create/update/remove Groups on Ansible Controller.
Requirements
ansible-galaxy collection install -r tests/collections/requirements.yml to be installed Currently: awx.awx or ansible.controller
Variables
| Variable Name | Default Value | Required | Description | Example |
platform_state | “present” | no | The state all objects will take unless overridden by object default | ‘absent’ |
aap_hostname | ”” | yes | URL to the Ansible Automation Platform Server. | 127.0.0.1 |
aap_validate_certs | true | no | Whether or not to validate the Ansible Automation Platform Server’s SSL certificate. | |
aap_username | ”” | no | Admin User on the Ansible Automation Platform Server. Either username / password or oauthtoken need to be specified. | |
aap_password | ”” | no | Platform Admin User’s password on the Server. This should be stored in an Ansible Vault at vars/platform-secrets.yml or elsewhere and called from a parent playbook. | |
aap_token | ”” | no | Controller Admin User’s token on the Ansible Automation Platform Server. This should be stored in an Ansible Vault at or elsewhere and called from a parent playbook. Either username / password or oauthtoken need to be specified. | |
aap_request_timeout | 10 | no | Specify the timeout in seconds Ansible should use in requests to the Ansible Automation Platform host. | |
controller_groups | see below | yes | Data structure describing your group or groups Described below. |
Enforcing defaults
The following Variables compliment each other. If Both variables are not set, enforcing default values is not done. Enabling these variables enforce default values on options that are optional in the controller API. This should be enabled to enforce configuration and prevent configuration drift. It is recomended to be enabled, however it is not enforced by default.
Enabling this will enforce configurtion without specifying every option in the configuration files.
‘controller_configuration_groups_enforce_defaults’ defaults to the value of ‘aap_configuration_enforce_defaults’ if it is not explicitly called. This allows for enforced defaults to be toggled for the entire suite of controller configuration roles with a single variable, or for the user to selectively use it.
| Variable Name | Default Value | Required | Description |
controller_configuration_groups_enforce_defaults | false | no | Whether or not to enforce default option values on only the applications role |
aap_configuration_enforce_defaults | false | no | This variable enables enforced default values as well, but is shared across multiple roles, see above. |
Secure Logging Variables
The following Variables compliment each other. If Both variables are not set, secure logging defaults to false. The role defaults to false as normally the add groups task does not include sensitive information. controller_configuration_groups_secure_logging defaults to the value of aap_configuration_secure_logging if it is not explicitly called. This allows for secure logging to be toggled for the entire suite of configuration roles with a single variable, or for the user to selectively use it.
| Variable Name | Default Value | Required | Description |
controller_configuration_groups_secure_logging | false | no | Whether or not to include the sensitive Group role tasks in the log. Set this value to true if you will be providing your sensitive values from elsewhere. |
aap_configuration_secure_logging | false | no | This variable enables secure logging as well, but is shared across multiple roles, see above. |
Asynchronous Retry Variables
The following Variables set asynchronous retries for the role. If neither of the retries or delay or retries are set, they will default to their respective defaults. This allows for all items to be created, then checked that the task finishes successfully. This also speeds up the overall role.
| Variable Name | Default Value | Required | Description |
aap_configuration_async_retries | 30 | no | This variable sets the number of retries to attempt for the role globally. |
controller_configuration_groups_async_retries | `` | no | This variable sets the number of retries to attempt for the role. |
aap_configuration_async_delay | 1 | no | This sets the delay between retries for the role globally. |
controller_configuration_groups_async_delay | aap_configuration_async_delay | no | This sets the delay between retries for the role. |
aap_configuration_loop_delay | 0 | no | This sets the pause between each item in the loop for the roles globally. To help when API is getting overloaded. |
controller_configuration_group_loop_delay | aap_configuration_loop_delay | no | This sets the pause between each item in the loop for the role. To help when API is getting overloaded. |
aap_configuration_async_dir | null | no | Sets the directory to write the results file for async tasks. The default value is set to null which uses the Ansible Default of /root/.ansible_async/. |
Formating Variables
Variables can use a standard Jinja templating format to describe the resource.
Example:
Because of this it is difficult to provide controller with the required format for these fields.
The workaround is to use the following format:
{ { variable }}
The role will strip the double space between the curly bracket in order to provide controller with the correct format for the Variables.
Data Structure
Group Variables
| Variable Name | Default Value | Required | Type | Description |
name | ”” | yes | str | Name of Group |
new_name | ”” | yes | str | Name of Group, used in updating a Group. |
description | false | no | str | Description of the Group. |
inventory | ”” | yes | str | Name of inventory the group should be made a member of. |
variables | {} | no | dict | variables applicable to group. |
hosts | ”” | no | list | hosts (list) in group |
children | ”” | no | list | List of groups that should be nested inside in this group |
preserve_existing_hosts | false | no | bool | Whether to preserve existing hosts in an existing group |
preserve_existing_children | false | no | bool | Whether to preserve existing children in an existing group |
state | present | no | str | Desired state of the resource. |
Standard Group Data Structure
Json Example
{
"controller_groups": [
{
"name": "PSQL_Servers",
"description": "Default",
"inventory": "Source Control",
"variables": {
"my_var": true
}
}
]
}
Yaml Example
controller_groups:
- name: PSQL_Servers
description: Group for Postgres SQL Servers
inventory: Default
variables:
myvars: example1
hosts:
- PSQL1
- PSQL2
- PSQL3
children:
- group1
- group2
- group3
Playbook Examples
Standard Role Usage
- name: Playbook to configure ansible controller post installation
hosts: localhost
connection: local
# Define following vars here, or in platform_configs/controller_auth.yml
# aap_hostname: ansible-controller-web-svc-test-project.example.com
# aap_username: admin
# aap_password: changeme
pre_tasks:
- name: Include vars from platform_configs directory
ansible.builtin.include_vars:
dir: ./yaml
ignore_files: [controller_config.yml.template]
extensions: ["yml"]
roles:
- {role: infra.aap_configuration.groups, when: controller_groups is defined}