galaxy.galaxy.collection
Description
An Ansible Role to update, or destroy Automation Hub Collections.
Variables
| Variable Name | Default Value | Required | Description | Example |
aap_hostname | ”” | yes | URL to the Ansible Automation Platform Server. | 127.0.0.1 |
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_validate_certs | True | no | Whether or not to validate the Ansible Automation Platform Server’s SSL certificate. | |
aap_request_timeout | 10 | no | Specify the timeout Ansible should use in requests to the Galaxy or Automation Hub host. | |
ah_path_prefix | ”” | no | API path used to access the api. Either galaxy, automation-hub, or custom | |
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/. | |
ah_collections | see below | yes | Data structure describing your collections, described below. |
These are the sub options for the vars ah_collections which are dictionaries with the options you want. See examples for details.
| Variable Name | Default Value | Required | Description | Example |
namespace | ”” | yes | Namespace name. Must be lower case containing only alphanumeric characters and underscores. | “awx” |
name | ”” | yes | Collection name. Must be lower case containing only alphanumeric characters and underscores. | |
version | ”” | no | Collection Version. Must be lower case containing only alphanumeric characters and underscores. If not provided and ‘auto_approve’ true, will be derived from the path. | |
path | ”” | no | Collection artifact file path. | |
wait | “true” | no | Waits for the collection to be uploaded | |
auto_approve | “true” | no | Approves a collection and requires version to be set. | |
timeout | “true” | Maximum time to wait for the collection approval | ||
interval | “true” | 10 | Interval at which approval is checked | |
overwrite_existing | “false” | no | Overwrites an existing collection and requires version to be set. | |
state | “present” | no | Desired state of the resource |
The aap_configuration_async_dir variable 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/.
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_timeout | 1000 | no | This variable sets the async timeout for the role globally. |
ah_configuration_collection_async_timeout | aap_configuration_async_timeout | no | This variable sets the async timeout for the role. |
aap_configuration_async_retries | 50 | no | This variable sets the number of retries to attempt for the role globally. |
ah_configuration_collection_async_retries | aap_configuration_async_retries | no | This variable sets the number of retries to attempt for the role. |
aap_configuration_loop_delay | 1000 | no | This variable sets the loop_delay for the role globally. |
ah_configuration_collection_loop_delay | aap_configuration_loop_delay | no | This variable sets the loop_delay for the role. |
aap_configuration_async_delay | 1 | no | This sets the delay between retries for the role globally. |
ah_configuration_collection_async_delay | aap_configuration_async_delay | no | This sets the delay between retries for the role. |
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 repository task does not include sensitive information. ah_configuration_repository_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 automation hub configuration roles with a single variable, or for the user to selectively use it.
| Variable Name | Default Value | Required | Description |
ah_configuration_collection_secure_logging | False | no | Whether or not to include the sensitive collection 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. |
Data Structure
Standard Project Data Structure
Yaml Example
ah_collections:
- namespace: 'awx'
name: 'awx'
path: /var/tmp/collections/awx_awx-15.0.0.tar.gz
state: present
- namespace: test_collection
name: test
version: 4.1.2
state: absent
Playbook Examples
Standard Role Usage
- name: Add collection
hosts: localhost
connection: local
gather_facts: false
vars:
aap_validate_certs: false
# Define following vars here, or in ah_configs/ah_auth.yml
# ah_host: ansible-ah-web-svc-test-project.example.com
# ah_token: changeme
pre_tasks:
- name: Include vars from ah_configs directory
ansible.builtin.include_vars:
dir: ./vars
extensions: ["yml"]
tags:
- always
roles:
- ../../collection