Red Hat Communities of Practice infra.platform_configuration

This Ansible collection allows for easy interaction with Ansible Automation Platform via Ansible roles using the Ansible Automation Platform modules.

Getting Help

We are on the Ansible Forums and Matrix, if you want to discuss something, ask for help, or participate in the community, please use the #infra-config-as-code tag on the form, or post to the chat in Matrix.

Ansible Forums

Matrix Chat Room

Requirements

The ansible.platform collections MUST be installed in order for this collection to work. It is recommended they be invoked in the playbook in the following way.

---
- name: Playbook to configure ansible platform post installation
  hosts: localhost
  connection: local
  vars:
    gateway_validate_certs: true
  collections:
    - ansible.platform

Links to Ansible Automation Platform Collections

Collection Name	Purpose
awx.awx/Ansible.controller repo	Automation controller modules
Ansible Hub Configuration	Automation hub configuration

Links to other Validated Configuration Collections for Ansible Automation Platform

Collection Name	Purpose
Controller Configuration	Automation controller configuration
AAP Platform Configuration	Configuration for platform wide configurations
EE Utilities	Execution Environment creation utilities
AAP installation Utilities	Ansible Automation Platform Utilities
AAP Configuration Template	Configuration Template for this suite

Included content

Click the Content button to see the list of content included in this collection.

Installing this collection

You can install the infra.platform_configuration.collection with the Ansible Galaxy CLI:

ansible-galaxy collection install infra.platform_configuration

You can also include it in a requirements.yml file and install it with ansible-galaxy collection install -r requirements.yml, using the format:

---
collections:
  - name: infra.platform_configuration
    # If you need a specific version of the collection, you can specify like this:
    # version: ...

Conversion from tower_configuration

If you were using a version of redhat_cop.tower_configuration, please refer to our Conversion Guide here: Conversion Guide

Using this collection

The ansible.platform collection must be invoked in the playbook in order for Ansible to pick up the correct modules to use.

The following command will invoke the collection playbook. This is considered a starting point for the collection.

ansible-playbook infra.platform_configuration.configure_platform.yml

Otherwise it will look for the modules only in your base installation. If there are errors complaining about "couldn't resolve module/action" this is the most likely cause.

- name: Playbook to configure ansible platform post installation
  hosts: localhost
  connection: local
  vars:
    gateway_validate_certs: true
  collections:
    - ansible.platform

Define following vars here, or in platform_configs/platform_auth.yml gateway_hostname: ansible-platform-web-svc-test-project.example.com

You can also specify authentication by a combination of either:

• gateway_hostname, gateway_username, gateway_password
• gateway_hostname, gateway_oauthtoken

The OAuth2 token is the preferred method. You can obtain the token through the preferred ansible.platform.token module, or by creating one via the AAP browser interface.

Gateway token module would be invoked with this code:

    - name: Create a new token using platform username/password
      ansible.platform.token:
        description: 'Creating token to test platform jobs'
        scope: "write"
        state: present
        gateway_host: "{{ gateway_hostname }}"
        gateway_username: "{{ gateway_username }}"
        gateway_password: "{{ gateway_password }}"

See Also

• Ansible Using collections for more details.

Release and Upgrade Notes

For details on changes between versions, please see the changelog for this collection.

Releasing, Versioning and Deprecation

This collection follows Semantic Versioning. More details on versioning can be found in the Ansible docs.

We plan to regularly release new minor or bugfix versions once new features or bugfixes have been implemented.

Releasing the current major version happens from the main branch.

Contributing to this collection

We welcome community contributions to this collection. If you find problems, please open an issue or create a PR against the infra.platform_configuration collection repository. More information about contributing can be found in our Contribution Guidelines.

Code of Conduct

This collection follows the Ansible project's Code of Conduct. Please read and familiarize yourself with this document.

Licensing

GNU General Public License v3.0 or later.

See LICENSE to see the full text.