Chapter 12. Planning a migration of virtual machines from OVA


You prepare and create your OVA migration plan by performing the following high-level steps in the MTV UI:

  • Create ownerless network maps.
  • Add a OVA source provider.
  • Select a migration network for an OVA source provider.
  • Add an OpenShift Virtualization destination provider.
  • Select a migration network for an OpenShift Virtualization provider.
  • Create a OVA migration plan.

You can create ownerless network maps by using the Migration Toolkit for Virtualization (MTV) UI to map source networks to OpenShift Virtualization networks.

Procedure

  1. In the Red Hat OpenShift web console, click Migration for Virtualization > Network maps.
  2. Click Create NetworkMap.

    The Create NetworkMap page opens.

  3. Enter the YAML or JSON definitions into the editor, or drag and drop a file into the editor.
  4. If you enter YAML definitions, use the following:
$  cat << EOF | oc apply -f -
apiVersion: forklift.konveyor.io/v1beta1
kind: NetworkMap
metadata:
  name: <network_map>
  namespace: <namespace>
spec:
  map:
    - destination:
        name: <network_name>
        type: pod 
1

      source:
        id: <source_network_id> 
2

    - destination:
        name: <network_attachment_definition> 
3

        namespace: <network_attachment_definition_namespace> 
4

        type: multus
      source:
        id: <source_network_id>
  provider:
    source:
      name: <source_provider>
      namespace: <namespace>
    destination:
      name: <destination_provider>
      namespace: <namespace>
EOF
Copy to Clipboard Toggle word wrap
1
Allowed values are pod and multus.
2
Specify the OVA network Universal Unique ID (UUID).
3
Specify a network attachment definition for each additional OpenShift Virtualization network.
4
Required only when type is multus. Specify the namespace of the OpenShift Virtualization network attachment definition.
  1. Optional: To download your input, click Download.
  2. Click Create.

    Your map appears in the list of network maps.

You can create ownerless storage maps by using the form page of the MTV UI.

Prerequisites

Procedure

  1. In the Red Hat OpenShift web console, click Migration for Virtualization > Storage maps.
  2. Click Create storage map > Create with form.
  3. Specify the following:

    • Map name: Name of the storage map.
    • Project: Select from the list.
    • Source provider: Select from the list.
    • Target provider: Select from the list.
    • Source storage: Select from the list.
    • Target storage: Select from the list
  4. Optional: Click Add mapping to create additional storage maps, including mapping multiple storage sources to a single target storage class.
  5. Click Create.

    Your map appears in the list of storage maps.

You can create ownerless storage maps by using YAML or JSON definitions in the Migration Toolkit for Virtualization (MTV) UI.

Procedure

  1. In the Red Hat OpenShift web console, click Migration for Virtualization > Storage maps.
  2. Click Create storage map > Create with YAML.

    The Create StorageMap page opens.

  3. Enter the YAML or JSON definitions into the editor, or drag and drop a file into the editor.
  4. If you enter YAML definitions, use the following:
$ cat << EOF | oc apply -f -
apiVersion: forklift.konveyor.io/v1beta1
kind: StorageMap
metadata:
  name: <storage_map>
  namespace: <namespace>
spec:
  map:
    - destination:
        storageClass: <storage_class>
        accessMode: <access_mode> 
1

      source:
        name:  Dummy storage for source provider <provider_name> 
2

  provider:
    source:
      name: <source_provider>
      namespace: <namespace>
    destination:
      name: <destination_provider>
      namespace: <namespace>
EOF
Copy to Clipboard Toggle word wrap
1
Allowed values are ReadWriteOnce and ReadWriteMany.
2
For OVA, the StorageMap can map only a single storage, which all the disks from the OVA are associated with, to a storage class at the destination. For this reason, the storage is referred to in the UI as "Dummy storage for source provider <provider_name>". In the YAML, write the phrase as it appears above, without the quotation marks and replacing <provider_name> with the actual name of the provider.
  1. Optional: To download your input, click Download.
  2. Click Create.

    Your map appears in the list of storage maps.

You can add Open Virtual Appliance (OVA) files that were created by VMware vSphere as a source provider by using the Red Hat OpenShift web console.

Procedure

  1. Access the Create provider page for Open Virtual Appliance by doing one of the following:

    1. In the Red Hat OpenShift web console, click Migration for Virtualization > Providers.

      1. Click Create Provider.
      2. Select a Project from the list. The default project shown depends on the active project of MTV.

        If the active project is All projects, then the default project is openshift-mtv. Otherwise, the default project is the same as the active project.

        If you have Administrator privileges, you can see all projects, otherwise, you can see only the projects you are authorized to work with.

      3. Click Open Virtual Appliance.
    2. If you have Administrator privileges, in the Red Hat OpenShift web console, click Migration for Virtualization > Overview.

      1. In the Welcome pane, click Open Virtual Appliance.

        If the Welcome pane is not visible, click Show the welcome card in the upper-right corner of the page, and click Open Virtual Appliance when the Welcome pane opens.

      2. Select a Project from the list. The default project shown depends on the active project of MTV.

        If the active project is All projects, then the default project is openshift-mtv. Otherwise, the default project is the same as the active project.

        If you have Administrator privileges, you can see all projects, otherwise, you can see only the projects you are authorized to work with.

  2. Specify the following fields:

    • Provider resource name: Name of the source provider
    • URL: URL of the NFS file share that serves the OVA
  3. Click Create provider to add and save the provider.

    The provider appears in the list of providers.

    Note

    An error message might appear that states that an error has occurred. You can ignore this message.

You can use a Red Hat OpenShift Virtualization provider as both a source provider and a destination provider.

Specifically, the host cluster that is automatically added as a OpenShift Virtualization provider can be used as both a source provider and a destination provider.

You can also add another OpenShift Virtualization destination provider to the Red Hat OpenShift web console in addition to the default OpenShift Virtualization destination provider, which is the cluster where you installed MTV.

You can migrate VMs from the cluster that MTV is deployed on to another cluster or from a remote cluster to the cluster that MTV is deployed on.

Prerequisites

Procedure

  1. Access the Create OpenShift Virtualization provider interface by doing one of the following:

    1. In the Red Hat OpenShift web console, click Migration for Virtualization > Providers.

      1. Click Create Provider.
      2. Select a Project from the list. The default project shown depends on the active project of MTV.

        If the active project is All projects, then the default project is openshift-mtv. Otherwise, the default project is the same as the active project.

        If you have Administrator privileges, you can see all projects, otherwise, you can see only the projects you are authorized to work with.

      3. Click OpenShift Virtualization.
    2. If you have Administrator privileges, in the Red Hat OpenShift web console, click Migration for Virtualization > Overview.

      1. In the Welcome pane, click OpenShift Virtualization.

        If the Welcome pane is not visible, click Show the welcome card in the upper-right corner of the page, and click OpenShift Virtualization when the Welcome pane opens.

      2. Select a Project from the list. The default project shown depends on the active project of MTV.

        If the active project is All projects, then the default project is openshift-mtv. Otherwise, the default project is the same as the active project.

        If you have Administrator privileges, you can see all projects, otherwise, you can see only the projects you are authorized to work with.

  2. Specify the following fields:

    • Provider resource name: Name of the source provider
    • URL: URL of the endpoint of the API server
    • Service account bearer token: Token for a service account with cluster-admin privileges

      If both URL and Service account bearer token are left blank, the local OpenShift cluster is used.

  3. Choose one of the following options for validating CA certificates:

    • Use a custom CA certificate: Migrate after validating a custom CA certificate.
    • Use the system CA certificate: Migrate after validating the system CA certificate.
    • Skip certificate validation : Migrate without validating a CA certificate.

      1. To use a custom CA certificate, leave the Skip certificate validation switch toggled to left, and either drag the CA certificate to the text box or browse for it and click Select.
      2. To use the system CA certificate, leave the Skip certificate validation switch toggled to the left, and leave the CA certificate text box empty.
      3. To skip certificate validation, toggle the Skip certificate validation switch to the right.
  4. Optional: Ask MTV to fetch a custom CA certificate from the provider’s API endpoint URL.

    1. Click Fetch certificate from URL. The Verify certificate window opens.
    2. If the details are correct, select the I trust the authenticity of this certificate checkbox, and then, click Confirm. If not, click Cancel, and then, enter the correct certificate information manually.

      Once confirmed, the CA certificate will be used to validate subsequent communication with the API endpoint.

  5. Click Create provider to add and save the provider.

    The provider appears in the list of providers.

You can select a default migration network for an OpenShift Virtualization provider in the Red Hat OpenShift web console to improve performance. The default migration network is used to transfer disks to the namespaces in which it is configured.

After you select a transfer network, associate its network attachment definition (NAD) with the gateway to be used by this network.

In MTV version 2.9 and earlier, MTV used the pod network as the default network.

In version 2.10.0 and later, MTV detects if you have selected a user-defined network (UDN) as your default network. Therefore, if you set the UDN to be the migration’s namespace, you do not need to select a new default network when you create your migration plan.

Important

MTV supports using UDNs for all providers except OpenShift Virtualization.

For more information about UDNs, see About user defined networks in Migrating your virtual machines to Red Hat OpenShift Virtualization. Migration procedures have been updated to include UDNs.

Note

You can override the default migration network of the provider by selecting a different network when you create a migration plan.

Procedure

  1. In the Red Hat OpenShift web console, click Migration > Providers for virtualization.
  2. Click the OpenShift Virtualization provider whose migration network you want to change.

    When the Providers detail page opens:

  3. Click the Networks tab.
  4. Click Set default transfer network.
  5. Select a default transfer network from the list and click Save.
  6. Configure a gateway in the network used for MTV migrations by completing the following steps:

    1. In the Red Hat OpenShift web console, click Networking > NetworkAttachmentDefinitions.
    2. Select the appropriate default transfer network NAD.
    3. Click the YAML tab.
    4. Add forklift.konveyor.io/route to the metadata:annotations section of the YAML, as in the following example:

      apiVersion: k8s.cni.cncf.io/v1
      kind: NetworkAttachmentDefinition
      metadata:
        name: localnet-network
        namespace: mtv-test
        annotations:
          forklift.konveyor.io/route: <IP address> 
      1
      Copy to Clipboard Toggle word wrap
      1
      The NetworkAttachmentDefinition parameter is needed to configure an IP address for the interface, either from the Dynamic Host Configuration Protocol (DHCP) or statically. Configuring the IP address enables the interface to reach the configured gateway.
    5. Click Save.

You can migrate Open Virtual Appliance (OVA) files that were created by VMware vSphere by using the Migration Toolkit for Virtualization plan creation wizard.

The wizard is designed to lead you step-by-step in creating a migration plan.

Warning

Do not include virtual machines with guest-initiated storage connections, such as Internet Small Computer Systems Interface (iSCSI) connections or Network File System (NFS) mounts. These require either additional planning before migration or reconfiguration after migration.

This prevents concurrent disk access to the storage the guest points to.

Important

A plan cannot contain more than 500 VMs or 500 disks.

Important

When you click Create plan on the Review and create page of the wizard, Migration Toolkit for Virtualization (MTV) validates your plan. If everything is OK, the Plan details page for your plan opens. This page contains settings that do not appear in the wizard, but are important. Be sure to read and follow the instructions for this page carefully, even though it is outside the plan creation wizard. The page can be opened later, any time before you run the plan, so you can come back to it if needed.

Prerequisites

  • Have an OVA source provider and a OpenShift Virtualization destination provider. For more information, see Adding an Open Virtual Appliance (OVA) source provider or Adding an OpenShift Virtualization destination provider.
  • If you plan to create a Network map or a Storage map that will be used by more than one migration plan, create it in the Network maps or Storage maps page of the UI before you create a migration plan that uses that map.
  • If you are using a user-defined network (UDN), note the name of its namespace as defined in OpenShift Virtualization.

Procedure

  1. In the Red Hat OpenShift web console, click Migration for Virtualization > Migration plans.
  2. Click Create plan.

    The Create migration plan wizard opens.

  3. On the General page, specify the following fields:

    • Plan name: Enter a name.
    • Plan project: Select from the list.
    • Source provider: Select from the list.
    • Target provider: Select from the list.
    • Target project: Select from the list. If you are using a UDN, this is the namespace defined in OpenShift Virtualization.
  4. Click Next.
  5. On the Virtual machines page, select the virtual machines you want to migrate and click Next.
  6. If you are using a UDN, verify that the IP address of the provider is outside the subnet of the UDN. If the IP address is within the subnet of the UDN, the migration fails.
  7. On the Network map page, choose one of the following options:

    • Use an existing network map: Select an existing network map from the list.

      These are network maps available for all plans, and therefore, they are ownerless in terms of the system. If you select this option and choose a map, a copy of that map is attached to your plan, and your plan is the owner of that copy. Any changes you make to your copy do not affect the original plan or any copies that other users have.

      Note

      If you choose an existing map, be sure it has the same source provider and the same target provider as the ones you want to use in your plan.

    • Use a new network map: Allows you to create a new network map by supplying the following data. This map is attached to this plan, which is then considered to be its owner. Maps that you create using this option are not available in the Use an existing network map option because each is created with an owner.

      Note

      You can create an ownerless network map, which you and others can use for additional migration plans, in the Network Maps section of the UI.

      • Source network: Select from the list.
      • Target network: Select from the list.

        If needed, click Add mapping to add another mapping.

      • Network map name: Enter a name or let MTV automatically generate a name for the network map.
  8. Click Next.
  9. On the Storage map page, choose one of the following options:

    • Use an existing storage map: Select an existing storage map from the list.

      These are storage maps available for all plans, and therefore, they are ownerless in terms of the system. If you select this option and choose a map, a copy of that map is attached to your plan, and your plan is the owner of that copy. Any changes you make to your copy do not affect the original plan or any copies that other users have.

      Note

      If you choose an existing map, be sure it has the same source provider and the same target provider as the ones you want to use in your plan.

    • Use new storage map: Allows you to create one or two new storage maps by supplying the following data. These maps are attached to this plan, which is then their owner. Maps that you create using this option are not available in the Use an existing storage map option because each is created with an owner.

      Note

      You can create an ownerless storage map, which you and others can use for additional migration plans, in the Storage Maps section of the UI.

      • Source storage: Select from the list.
      • Target storage: Select from the list.

        If needed, click Add mapping to add another mapping.

      • Storage map name: Enter a name or let MTV automatically generate a name for the storage map.
  10. Click Next.
  11. On the Other settings (optional) page, you have the option to change the Transfer network of your migration plan.

    The transfer network is the network used to transfer the VMs to OpenShift Virtualization. This is the default transfer network of the provider.

    • Verify that the transfer network is in the selected target project.
    • To choose a different transfer network, select a different transfer network from the list.
    • Optional: To configure another OpenShift network in the OpenShift web console, click Networking > NetworkAttachmentDefinitions.

      To learn more about the different types of networks OpenShift supports, see Additional Networks in OpenShift Container Platform.

    • To adjust the maximum transmission unit (MTU) of the OpenShift transfer network, you must also change the MTU of the VMware migration network. For more information, see Selecting a migration network for a VMware source provider.
  12. Click Next.
  13. On the Hooks (optional) page, you can add a pre-migration hook, a post-migration hook, or both types of migration hooks. All are optional.
  14. To add a hook, select the appropriate Enable hook checkbox.
  15. Enter the Hook runner image.
  16. Enter the Ansible playbook of the hook in the window.

    Note

    You cannot include more than one pre-migration hook or more than one post-migration hook in a migration plan.

  17. Click Next.
  18. On the Review and Create page, review the information displayed.
  19. Edit any item by doing the following:

    1. Click its Edit step link.

      The wizard opens to the page where you defined the item.

    2. Edit the item.
    3. Either click Next to advance to the next page of the wizard, or click Skip to review to return directly to the Review and create page.
  20. When you finish reviewing the details of the plan, click Create plan. MTV validates your plan.

    When your plan is validated, the Plan details page for your plan opens in the Details tab.

  21. In addition to listing details based on your entries in the wizard, the Plan details tab includes the following two sections after the details of the plan:

    • Migration history: Details about successful and unsuccessful attempts to run the plan
    • Conditions: Any changes that need to be made to the plan so that it can run successfully
  22. When you have fixed all conditions listed, you can run your plan from the Plans page.

    The Plan details page also includes five additional tabs, which are described in the table that follows:

    Expand
    Table 12.1. Tabs of the Plan details page
    YAMLVirtual MachinesResourcesMappingsHooks

    Editable YAML Plan manifest based on your plan’s details including source provider, network and storage maps, VMs, and any issues with your VMs

    The VMs the plan migrates

    Calculated resources: VMs, CPUs, and total memory for both total VMs and running VMs

    Editable specification of the network and storage maps used by your plan

    Updatable specification of the hooks used by your plan, if any

12.8. Configuring OVA file upload by web browser

You can configure Open Virtual Appliance (OVA) file upload by web browser to upload an OVA file directly to an NFS share. To configure OVA file upload, you first enable OVA appliance management in the ForkliftController custom resource (CR) and then enable OVA upload for each OVA provider. When you enable OVA upload for an OVA provider, the Upload local OVA files option populates on the provider’s Details page in the MTV UI.

Prerequisites

  • You have an NFS share to point the OVA provider at.
  • You have enough storage space in your NFS share.
  • The NFS share is writable by the QEMU group (GID 107).
  • You have a valid .ova file to upload.
  • Your .ova file has a unique file name.

Procedure

  1. In the Red Hat OpenShift web console, click Operators > Installed Operators.
  2. Click Migration Toolkit for Virtualization Operator.

    The Operator Details page opens in the Details tab.

  3. Click the ForkliftController tab, and open the forklift-controller resource.
  4. Click the forklift-controller YAML tab, and add the feature_ova_appliance_management field to the spec section of the forklift-controller custom resource (CR):

    Example:

    spec:
      ...
      feature_ova_appliance_management: 'true'
    Copy to Clipboard Toggle word wrap

    Wait for the operator to redeploy the controller after updating the forklift-controller CR.

  5. In the Red Hat OpenShift web console, click Migration for Virtualization > Providers.
  6. Click the provider to open the Details page. Click the provider’s YAML tab.

    For information about creating a provider, see Adding an Open Virtual Appliance (OVA) source provider.

  7. Scroll down the provider’s YAML file, and add the applianceManagement field to the spec section. Set applianceManagement to 'true':

    Example:

    spec:
      secret:
        ...
      settings:
        applianceManagement: 'true'
      type: ova
      ...
    Copy to Clipboard Toggle word wrap
    • A temporary ConnectionTestFailed error message displays while the update is processing. You can ignore the error message.
  8. Click the provider’s Details tab, and scroll down to the Conditions section. Verify that ApplianceManagementEnabled shows as True in the list of conditions.
  9. In the Upload local OVA files section, click Browse to find a valid .ova file.
  10. Click Upload.

    A success message confirms the file upload. After several seconds, the number of virtual machines increases under the Provider inventory section.

Back to top
Red Hat logoGithubredditYoutubeTwitter

Learn

Try, buy, & sell

Communities

About Red Hat Documentation

We help Red Hat users innovate and achieve their goals with our products and services with content they can trust. Explore our recent updates.

Making open source more inclusive

Red Hat is committed to replacing problematic language in our code, documentation, and web properties. For more details, see the Red Hat Blog.

About Red Hat

We deliver hardened solutions that make it easier for enterprises to work across platforms and environments, from the core datacenter to the network edge.

Theme

© 2025 Red Hat