Ansible Collection - ansible.aap_snapshot

Description

This collection provides a complete migration framework for Ansible Automation Platform (AAP) clusters. It exports platform data into a portable artifact and imports it into a new deployment, supporting migration across all AAP installation types.

Supported migration paths:

The collection handles four AAP components: Controller, Hub (with Pulp content), Gateway, and EDA. Components are processed conditionally based on what is present in the inventory and artifact.

Requirements

• Ansible core >= 2.16.0
• PyYAML
• kubernetes

Collection Dependencies

Community dependency disclaimer: This collection depends on community.postgresql and community.general, which are community-maintained Ansible collections. Red Hat provides full support for these dependencies when used as part of ansible.aap_snapshot through Ansible Automation Platform subscriptions. Red Hat will work toward replacing these community dependencies with certified equivalents as they become available.

Platform Requirements

• RPM export: SSH access to component hosts, become privileges
• Containerized: SSH access to component hosts, podman access
• OCP Operator: kubeconfig with cluster-admin or namespace-admin access

Installation

Red Hat customers install certified collections from Red Hat Ansible Automation Hub.

Installing the collection

Install this collection with the Ansible Galaxy CLI:

ansible-galaxy collection install ansible.aap_snapshot

Installing from a requirements file

Include this collection in a requirements.yml file and install it with ansible-galaxy collection install -r requirements.yml:

collections:
  - name: ansible.aap_snapshot

Installing a specific version

Use the following syntax to install version 1.0.0:

ansible-galaxy collection install ansible.aap_snapshot:==1.0.0

See using Ansible collections for more details.

Upgrading the collection

To upgrade the collection to the latest available version:

ansible-galaxy collection install ansible.aap_snapshot --upgrade

Use Cases

Export a migration artifact

Create a migration artifact from a running AAP deployment:

# From an RPM deployment
ansible-playbook -i inventory ansible.aap_snapshot.artifact_export -e aap_platform=rpm

# From a containerized deployment
ansible-playbook -i inventory ansible.aap_snapshot.artifact_export -e aap_platform=containerized

# From an OCP operator deployment
ansible-playbook -i inventory ansible.aap_snapshot.artifact_export \
  -e aap_platform=operator \
  -e ocp_namespace=aap \
  -e aap_instance_name=aap

Import a migration artifact

Restore a migration artifact into a target AAP deployment:

# Into a containerized deployment
ansible-playbook -i inventory ansible.aap_snapshot.artifact_import \
  -e aap_platform=containerized \
  -e artifact_dir=/path/to/artifacts \
  -e artifact_file=/path/to/aap-snapshot-2.6-20260701-120000.tar

# Into an OCP operator deployment
ansible-playbook -i inventory ansible.aap_snapshot.artifact_import \
  -e aap_platform=operator \
  -e artifact_file=/path/to/aap-snapshot-2.6-20260701-120000.tar \
  -e ocp_namespace=aap \
  -e aap_instance_name=aap

Verify an artifact

Validate an artifact without importing it:

ansible-playbook ansible.aap_snapshot.artifact_verify \
  -e artifact_file=/path/to/aap-snapshot-2.6-20260701-120000.tar

Key Variables

See the variables reference for the complete list.

Testing

The collection supports RPM, containerized, and OCP operator deployments on RHEL 8 and RHEL 9.

Dev dependencies: pip install pytest pyyaml ansible-lint

make lint
make syntax-check
pytest tests/unit/ -v

Contributing

We welcome contributions. See CONTRIBUTING.md for development setup, testing, and the pull request process.

To report a bug or request a feature, please open an issue.

Support

This collection is maintained by the Red Hat AAP Installer team.

As Red Hat Ansible Certified Content, this collection is entitled to support through the Ansible Automation Platform (AAP) using the Create issue button on the top right corner of Automation Hub. If a support case cannot be opened with Red Hat and the collection has been obtained either from Galaxy or GitHub, there may be community help available on the Ansible Forum.

Release Notes

See the changelog for release notes.

Related Information

• Architecture - collection structure, role hierarchy, plugin catalog
• Artifact Format - SDP v1.0 artifact specification
• Variables - complete variable reference
• Workflows - step-by-step export, import, and reconcile workflows
• Debugging - failure recovery procedures for import and export
• Red Hat Ansible Automation Platform Life Cycle

License

GNU General Public License v3.0 or later.

See LICENSE for the full text.