Red Hat Communities of Practice Ansible Automation Platform Utilities Collection

This ansible collection includes a number of roles which can be useful for installing Ansible Automation Platform. Using this collection, you'll be able to automate following tasks:

• RHEL based installs

* prepare and install Automation controller and Private automation hub on RHEL * configure the OS to support Kerberos (if you plan to manage Windows hosts using AD credentials) * backup and restore Automation controller and Private automation hub * install a minimal Git repo over SSH, for demonstration and learning purposes

• OpenShift based installs

* prepare and install Automation controller and Private automation hub on OpenShift

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 forum, or post to the chat in Matrix.

Ansible Forums

Matrix Chat Room

Requirements

The following collections are required to use this collection if you are using the Openshift specific roles.

| Name | Minimum Version | |------------------|:---------------:| | ansible.posix | 1.0.0 | | kubernetes.core | 2.2.0 | | redhat.openshift | 4.0.2 |

⚠️ IMPORTANT

>

To install this collection ensure that access to Automation Hub is configured or required collections are already installed.

The aapinstallocp role requires the kubernetes (version 12.0.0 or later) Python module to be installed.

Links to Ansible Automation Platform Collections

| Collection Name | Purpose | |:-----------------------------------------------------------------------------------:|:-----------------------------:| | ansible.platform repo | gateway/platform modules | | ansible.hub repo | Automation hub modules | | ansible.controller repo | Automation controller modules | | ansible.eda repo | Event Driven Ansible modules |

Links to other Validated Configuration Collections for Ansible Automation Platform

| Collection Name | Purpose | |:-----------------------------------------------------------------------------------------------------:|:-------------------------------------------------:| | AAP >= 2.5 Configuration | Ansible Automation Platform configuration | | AAP <= 2.4 Controller Configuration | Automation controller configuration | | AAP Configuration Extended | Where other useful roles that don't fit here live | | EE Utilities | Execution Environment creation utilities | | AAP Configuration Template | Configuration Template for this suite | | Ansible Validated Gitlab Workflows | Gitlab CI/CD Workflows for ansible content | | Ansible Validated GitHub Workflows | GitHub CI/CD Workflows for ansible content |

Included content

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

Installing this collection

You can install the redhat\cop aap\utilities collection with the Ansible Galaxy CLI:

ansible-galaxy collection install infra.aap_utilities

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.aap_utilities
    # If you need a specific version of the collection, you can specify like this:
    # version: ...

Using this collection

See Also

• Ansible Using collections for more details.

Release and Upgrade Notes

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

Many roles and variables have been renamed to reflect the product renaming from Tower to controller/AAP. Verify carefully your inventory variables and playbooks.

The previous OCP installation role has been suppressed due to the introduction of an operator. In addition to the current OCP installation role, further (community) automation for AAP on OCP is available from the GitOps catalogue.

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 devel branch.

Roadmap

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 AAP Utilities collection repository. More information about contributing can be found in our Contribution Guidelines.

Licensing

GNU General Public License v3.0 or later.

See LICENSE to see the full text.

Support

This collection is Ansible Validated Content. It is reviewed and tested by Red Hat but is not supported under a Red Hat SLA. For reporting issues and requesting improvements, file an issue at the AAP Utilities repository. Community help is also available on the Ansible Forum.