Ansible for OpenShift Virtualization Migration

• Ansible for OpenShift Virtualization Migration
  • Description
  • Documentation
  • Release Notes
  • Roles
  • Requirements
  • Installation
  • Use Cases
  • Testing
  • Support
  • License

Description

This collection enables the migration journey of Virtual Machine (VM) workloads from existing hypervisors to Red Hat OpenShift Virtualization using Ansible Automation Platform. Additionally it provides content for the management and maintenance of VM workloads within Red Hat OpenShift Virtualization.

Documentation

• Contributing Guide
• Disconnected Environment Setup
• Secure Credential Management
• Secure Credential Practices

Release Notes

See CHANGELOG.md for release history and changes.

Roles

This collection includes the following roles for managing OpenShift Virtualization migrations:

• aap_deploy - Deploys an instance of Ansible Automation Platform.
• aap_machine_credentials - Management of Machine Credentials.
• aap_seed - Populates an Ansible Automation Platform instance.
• bootstrap - Initialization of the Ansible for OpenShift Virtualization Migration environment.
• create_mf_aap_token - create_mf_aap_token
• mtv_management - Management of the Migration Toolkit for Virtualization (MTV).
• mtv_migrate - Migration of Virtual Machines from Source to Destination.
• network_mgmt - Management of network related components.
• operator_management - Management of OpenShift Operators.
• validate_migration - Verification of an Ansible for OpenShift Virtualization Migration environment.
• vm_backup_restore - Virtual Machine backup and restore capabilities.
• vm_collect - Collection of Migration Toolkit for Virtualization inventory information.
• vm_hot_plug - Hot Plug Virtual Machine resources.
• vm_lifecycle - Management of the lifecycle activities of Virtual Machines.
• vm_mac_address - Management of Virtual Machine MAC Addresses.
• vm_networking - Management of Virtual Machine networking.
• vm_patching - Patching related activities for Virtual Machines.
• vm_ssh - Management of SSH keys for Virtual Machines in OpenShift.

Requirements

The following Ansible Collections are required:

---
collections:
  - name: redhat.openshift_virtualization
  - name: redhat.openshift
  - name: vmware.vmware_rest
  - name: ansible.posix
  - name: infra.aap_utilities
  - name: kubernetes.core
  - name: community.crypto
  - name: community.general
  - name: community.vmware

  # AAP <=2.4
  - name: infra.controller_configuration
  - name: ansible.controller
    version: "<=4.5.12"

  # AAP 2.5+
  - name: ansible.platform
  - name: ansible.controller
  - name: infra.aap_configuration
...

Installation

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

ansible-galaxy collection install infra.openshift_virtualization_migration

Note that if you install any collections from Ansible Galaxy, they will not be upgraded automatically when you upgrade the Ansible package.

To upgrade the collection to the latest available version, run the following command:

ansible-galaxy collection install infra.openshift_virtualization_migration --upgrade

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

See using Ansible collections for more details.

Use Cases

This collection is ideal for accomplishing the following using Ansible automation:

• Analyzing existing Virtual Machine hypervisor environments.
• Installing and configuring Ansible Automation Platform.
• Preparing OpenShift environments to support Virtual Machines and migrating Virtual Machines from existing hypervisors using the Migration Toolkit for Virtualization (MTV).
• Migrating Virtual Machines using the Migration Toolkit for Virtualization (MTV).

Testing

tox is used to perform tests and verification of this collection.

The following commands can be used to execute the various types of tests implemented:

tox -av # lists all tests

tox # run them all

tox -e <test name> # run specific one

tox -f sanity --ansible -c tox-ansible.ini     # run tox-ansible that does our ansible-test sanity suite

Support

The Ansible Forum can be used for additional questions and issues related to this collection.

License

GNU General Public License v3.0 or later.

See the LICENSE to see the full text.