Uploaded image for project: 'Migration Toolkit for Virtualization'
  1. Migration Toolkit for Virtualization
  2. MTV-3843

[DOC] MTV hook for AAP integration

XMLWordPrintable

    • Icon: Task Task
    • Resolution: Unresolved
    • Icon: Major Major
    • 2.11.0
    • None
    • Documentation
    • None
    • Quality / Stability / Reliability
    • False
    • Hide

      None

      Show
      None
    • False
    • Not Selected

      The underlying feature allows the Migration Toolkit for Virtualization (MTV) migration hooks to trigger specific jobs or workflows directly within an external AAP instance. This capability allows administrators to execute large, complex, and enterprise-standard automation tasks that reside outside the cluster at specific points during the migration process (e.g., pre-migration validation, or post-cutover service setup).

      Technical Writer Scope

      The deliverable must provide clear, secure, and production-ready guidance on this integration. Key documentation areas include:

      1. Configuration Flow: Document the required setup steps in both MTV (the MigrationPlan hook definition) and AAP (e.g., required API tokens, user permissions, and job template definitions).
      1. Authentication: Detail the necessary secure credential management (likely a Secret containing an AAP API token) and how this is linked to the migration plan.
      1. Data Exchange: Explain what parameters or variables MTV passes to the AAP job template, and how to define a playbook within AAP that can consume this dynamic migration data.
      1. Integration Point: This complex topic requires a new, dedicated section under the Advanced Automation / Migration Hooks chapter.

      JTBD Statement:

      "When the migration process reaches a required synchronization point, I want to trigger a trusted Ansible Automation Platform (AAP) workflow job externally so that I can integrate MTV into our existing, enterprise-grade automation platform and securely execute complex, cross-system tasks (like inventory updates or service reconfiguration) at the precise moment required by the migration hook."

      Documentation Task

      The documentation task (MTV-3843) supports this job by addressing the primary sub-job:

      "When setting up the AAP integration hook, I need clear guidance on authentication and data mapping so that I can ensure secure communication between MTV and AAP and verify the workflow receives the dynamic migration data it needs to execute successfully."

              rhn-support-anarnold A Arnold
              rhn-support-anarnold A Arnold
              Votes:
              0 Vote for this issue
              Watchers:
              1 Start watching this issue

                Created:
                Updated: