Goal:

• We need to create a user guide for a feature tentatively called Red Hat OpenStack VMware Migration Toolkit. The goal of this feature is to extend the os_migrate tool to facilitate the migration of virtual machines (VMs) from VMware to Red Hat OpenStack Platform 17.1 and Red Hat OpenShift Service on OpenStack (RHOSO) 18 with minimal downtime.
• Target deadline is November (FR4).
• The guide is to be published on the 17.1 RHOSP and 18.0 RHOSO customer portal.
• Links:
  • OpenStack MTV doc needs
  • Gemini notes from meeting with virtualization and Ansible teams

Acceptance Criteria:

• User guide contains all required information for users to complete and end-to-end migration.
• All stakeholders, including SMEs and peers, have reviewed the documentation.
• The guide is published on the customer portal.

Open questions:

• Investigate a more detailed scope of this documentation.

Mini content journey

**

Reviewers:

• Technical: [name]
• Peer: [Writer name]
• QE: [name]
• Partner/Field (optional): [name]

Is this feature fully supported or technical preview?

• Full support: 
• “The @os-migrate team provides full support for the components included directly within this collection (all playbooks, roles, and plugins) as well as for the os_migrate.os_migrate collection, which is also developed by our team… We want to assure you that the collection itself has been thoroughly tested to ensure its stability and functionality.”
• TP exception (Knowledge Base Article / Doc): This might end up being a KCS either

Does the procedural content need to be tested by QE?

• Yes: QE needs to create a doc testing ticket per How-to Jira with the docs team
• "We want to assure you that the collection itself has been thoroughly tested to ensure its stability and functionality."

**

Does the documentation epic need a release note in addition to the feature?

• Yes: There will likely be a release note  to announce this

**

What stage of the user journey are you targeting?

• Discover: Overview, reference, blogs (Find solutions)
• Learn: Validated architectures, reference, FAQ(Gain Knowledge)

• Try: Technical Preview, quickstart (Start, try, test)
• Adopt: Adoption or Greenfield feature (Early stage customer use)
• Expand: Customizations, day 2 operations, troubleshooting, add features to control plane or data plane

The most similar option is "Try"

**

Who is your target persona?

• Red Hat Services consultants and architects. It is also relevant for IT professionals responsible for managing virtualized environments and migrating workloads to cloud infrastructure.
• DevOps Engineers, Automation Experts, System Administrators.

**

What type of information does the user need to know in order to use the feature?

• Procedures to implement or enable the feature - Yes
• Procedures to customize or configure the feature after installation - No
• Procedures or considerations for upgrades, adoption, or minor updates - No
• Procedures to verify that the feature is enabled and is working as expected - Yes
• Procedures to operate or maintain the feature - Yes
• Concepts that need to be explained or planning decisions that must be made before the user can perform any of these procedures - Yes
• Permissions level required (RHOSO/OCP) or security considerations - Yes
• Known issues, limitations, or troubleshooting guidance - Yes

**

Are there any existing upstream or internal resources that the writer can use for planning and drafting the content? Consider the situational context of the existing content. Do a Google search for any possible resources that might help.

• • https://github.com/os-migrate/vmware-migration-kit
  • https://gist.github.com/matbu/003c300fd99ebfbf383729c249e9956f
  • https://spaces.redhat.com/pages/viewpage.action?pageId=679152565&spaceKey=MMSDOCS&title=OpenStack%2BMTV%2Band%2BMTV
  • https://os-migrate.github.io/documentation/ 
  • Upstream lab for infra summit: https://pnavarro.github.io/openinfra_migration_lab_openstack/modules/migration/migration.htmlAlso useful to explain some concepts: https://docs.redhat.com/en/documentation/migration_toolkit_for_virtualization/2.9/html-single/installing_and_using_the_migration_toolkit_for_virtualization/index

Does the content require input from multiple DFGs?

• No: Stories are not required unless the epic needs to be divided to user stories that can be delivered separately (for personal use, consider sub-tasks instead)

**

Does the content need to be included in any of the following guides?

• Validated architecture (VA) guide: Is the content a part of a VA workflow, such as HCI, NFV, BGP, etc?
• Planning guide: Are there prerequisites or planning decisions to add to the Planning guide? 
• Deployment/Customization guide: Does the feature need to be enabled during the deployment  process, or can it be enabled post-deployment?
• Adoption/minor updates guide: Are there any considerations or impact of this feature on adoption from pre-18 environments or from earlier 18z versions?

No; it's either a new guide or a KCS 

**

(Optional) Are there any additional content improvements you can also implement for the user when documenting this goal? Consider any additional actions that might also improve content. For example, restructuring content to better suit the user story.

• <Ideas and suggestions for improvements of existing content>

**

(Optional) Documentation outline If applicable, the writer can start brainstorming about the information design for the content. This is understood to only be a draft placeholder and subject to change as the content is authored and reviewed.

• Module Title (Concept)

• Overview of content required

• Module Title (Concept)

• Overview of content required

• Module Title (Procedure)

• Prerequisites

• Outline of steps

• Module Title (Procedure)

• Prerequisites

• Outline of steps

• Module Title (Reference)

• Outline of parameters/options/data to be included

• Module Title (Reference)

• Outline of parameters/options/data to be included

Example sections:

• Install Red Hat OpenStack Vmware Migration toolkit
• Vmware Prerequisites:
• Vmware Privileges
• Creating a VMware role to grant RHOVMT privileges
• Importing VDDK image

• Red Hat OpenStack prerequisites:

• RHVMT Conversion host deployment

• Ansible Automation Platform prerequisites:

• Ansible Execution Environment creation

• incl. vmware libs inclusion

• Migrating Virtual Machines using Ansible Automation Platform