Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

MTV-1433 UI plans by provider #585

Open
wants to merge 9 commits into
base: main
Choose a base branch
from
Open
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
146 changes: 67 additions & 79 deletions documentation/doc-Migration_Toolkit_for_Virtualization/master.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -103,126 +103,114 @@ include::modules/installing-mtv-operator.adoc[leveloffset=+2]

include::modules/configuring-mtv-operator.adoc[leveloffset=+2]


[id="migrating-vms-web-console_{context}"]
[id="migrating-vms-ocp-web-console_{context}"]
== Migrating virtual machines by using the {ocp} web console

You can migrate virtual machines (VMs) by using the {ocp} web console to:

. xref:adding-source-providers[Create source providers]
. xref:adding-destination-providers[Create destination providers]
. xref:creating-migration-plans-ui[Create migration plans]

[IMPORTANT]
====
You must ensure that all xref:prerequisites_{context}[prerequisites] are met.

VMware only: You must have the minimal set of xref:vmware-privileges_{context}[VMware privileges].

VMware only: Creating a xref:creating-vddk-image_{context}[VMware Virtual Disk Development Kit (VDDK)] image will increase migration speed.
====
Use the {project-short} user interface to migrate virtual machines (VMs). It is located in the *Virtualization* section of the {ocp} web console.

include::modules/mtv-ui.adoc[leveloffset=+2]
include::modules/mtv-overview-page.adoc[leveloffset=+2]
include::modules/mtv-settings.adoc[leveloffset=+2]

[id="adding-providers"]
=== Adding providers
include::modules/mtv-overview-page.adoc[leveloffset=+3]
include::modules/mtv-settings.adoc[leveloffset=+3]

You can add source providers and destination providers for a virtual machine migration by using the {ocp} web console.
[id="migrating-vms-mtv-ui_{context}"]
=== Migrating virtual machines using the MTV user interface

[id="adding-source-providers"]
==== Adding source providers

You can use {project-short} to migrate VMs from the following source providers:
Use the {project-short} user interface to migrate VMs from the following providers:

* VMware vSphere
* {rhv-full}
* {rhv-full} ({rhv-short})
* {osp}
* Open Virtual Appliances (OVAs) that were created by VMware vSphere
* {virt}

You can add a source provider by using the {ocp} web console.
* Remote {virt} clusters

// ANDY: Now we continue with the provider A-Z sections
:!mtv:
:context: vmware
:vmware:
include::modules/adding-source-provider.adoc[leveloffset=+4]
include::modules/selecting-migration-network-for-vmware-source-provider.adoc[leveloffset=+5]

[id="migrating-vmware-ui"]
==== Migrating virtual machines from VMware vSphere
// ANDY: VM prerequisites and provider instructions will go here

include::modules/creating-migration-plan-2-8.adoc[leveloffset=+4]

include::modules/running-migration-plan.adoc[leveloffset=+4]

include::modules/migration-plan-options-ui.adoc[leveloffset=+4]

include::modules/canceling-migration-ui.adoc[leveloffset=+4]

:!vmware:

// ANDY: Now RHV
==== Migrating virtual machines from {rhv-full}

:context: rhv
:rhv:
include::modules/adding-source-provider.adoc[leveloffset=+4]
include::modules/creating-migration-plan-2-8.adoc[leveloffset=+4]

include::modules/running-migration-plan.adoc[leveloffset=+4]

include::modules/migration-plan-options-ui.adoc[leveloffset=+4]

include::modules/canceling-migration-ui.adoc[leveloffset=+4]

:!rhv:

// ANDY: Now OpenStack
==== Migrating virtual machines from {osp}

:context: ostack
:ostack:
include::modules/adding-source-provider.adoc[leveloffset=+4]
include::modules/creating-migration-plan-2-8.adoc[leveloffset=+4]

include::modules/running-migration-plan.adoc[leveloffset=+4]

include::modules/migration-plan-options-ui.adoc[leveloffset=+4]

include::modules/canceling-migration-ui.adoc[leveloffset=+4]

:!ostack:
:context: ova
:ova:
include::modules/adding-source-provider.adoc[leveloffset=+4]
:!ova:
:context: cnv
:cnv:
include::modules/adding-source-provider.adoc[leveloffset=+4]
:cnv!:
:context: mtv

[id="adding-destination-providers"]
==== Adding destination providers
// ANDY: Now OVA
==== Migrating virtual machines from OVA

You can add a {virt} destination provider by using the {ocp} web console.
:context: ova
:ova:
include::modules/creating-migration-plan-2-8.adoc[leveloffset=+4]

:mtv!:
:context: cnv2
:cnv2:
include::modules/adding-source-provider.adoc[leveloffset=+4]
:cnv!:
:context: mtv
include::modules/running-migration-plan.adoc[leveloffset=+4]

include::modules/selecting-migration-network-for-virt-provider.adoc[leveloffset=+4]
include::modules/migration-plan-options-ui.adoc[leveloffset=+4]

// include::modules/creating-network-mapping.adoc[leveloffset=+2]
// include::modules/creating-storage-mapping.adoc[leveloffset=+2]
include::modules/canceling-migration-ui.adoc[leveloffset=+4]

[id="creating-migration-plans-ui"]
=== Creating migration plans
:!ova:
:context: dest_ova

You can create a migration plan by using the {ocp} web console to specify a source provider, the virtual machines (VMs) you want to migrate, and other plan details.
// ANDY: Now CNV
==== Migrating virtual machines from {virt}

For your convenience, there are two procedures to create migration plans, starting with either a source provider or with specific VMs:
:context: cnv
:cnv:
include::modules/creating-migration-plan-2-8.adoc[leveloffset=+4]

* To start with a source provider, see xref:creating-migration-plan-2-6-3_provider[Creating a migration plan starting with a source provider].
* To start with specific VMs, see xref:creating-migration-plan-2-6-3_vms[Creating a migration plan starting with specific VMs].
include::modules/running-migration-plan.adoc[leveloffset=+4]

[WARNING]
====
Virtual machines with guest initiated storage connections, such as Internet Small Computer Systems Interface (iSCSI) connections or Network File System (NFS) mounts, are not handled by {project-short} and could require additional planning before or reconfiguration after the migration.
include::modules/migration-plan-options-ui.adoc[leveloffset=+4]

This is to ensure that no issues arise due to the addition or newly migrated VM accessing this storage.
====
include::modules/canceling-migration-ui.adoc[leveloffset=+4]

include::modules/snip_plan-limits.adoc[]
:!cnv:

:mtv!:
:context: provider
:provider:

include::modules/creating-migration-plan-2-6-3.adoc[leveloffset=+3]
// ANDY: That's it for this PR.

:provider!:
:context: vms
:vms:
include::modules/creating-migration-plan-2-6-3.adoc[leveloffset=+3]

:vms!:
:context: mtv
:mtv:

include::modules/running-migration-plan.adoc[leveloffset=+2]
include::modules/migration-plan-options-ui.adoc[leveloffset=+2]

include::modules/canceling-migration-ui.adoc[leveloffset=+2]

[id="migrating-virtual-machines-from-the-command-line_{context}"]
== Migrating virtual machines from the command line
Expand Down
70 changes: 0 additions & 70 deletions documentation/modules/creating-migration-plan-2-6-3.adoc

This file was deleted.

79 changes: 79 additions & 0 deletions documentation/modules/creating-migration-plan-2-8.adoc
Original file line number Diff line number Diff line change
@@ -0,0 +1,79 @@
// * documentation/doc-Migration_Toolkit_for_Virtualization/master.adoc

:_mod-docs-content-type: PROCEDURE
[id="creating-migration-plan-2-8_{context}"]
= Creating a migration plan

Use the {ocp} web console to create a migration plan. Specify the source provider, the virtual machines (VMs) you want to migrate, and other plan details.

[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 a migration or reconfiguration after the migration

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

include::snip_plan-limits.adoc[]

.Procedure

. In the {ocp} web console, click *Plans for virtualization* and then click *Create Plan*.
+
The *Create migration plan* wizard opens to the *Select source provider* interface.
. Select the source provider of the VMs you want to migrate.
+
The *Select virtual machines* interface opens.
. Select the VMs you want to migrate and click *Next*.
+
The *Create migration plan* pane opens. It displays the source provider's name and suggestions for a target provider and namespace, a network map, and a storage map.
. Enter the *Plan name*.
. To change the *Target provider*, the *Target namespace*, or elements of the *Network map* or the *Storage map*, select an item from the relevant list.
> To add either a *Network map* or a *Storage map*, click the *+* sign anf add a mapping.
. Click *Create migration plan*.
+
{project-short} validates the migration plan and the *Plan details* page opens, indicating whether the plan is ready for use or contains an error.
+
The details of the plan are listed, and you can edit the items you filled in on the previous page. If you make any changes, {project-short} validates the plan again.

ifdef::vmware[]

. Check the following items related to VMware. All are optional except for *Warm migration*.

* *Warm migration* By default, all migrations are cold migrations. For a warm migration, click the *Edit* icon, and select *Warm migration*.

* *Preserving static IPs of VMs*: By default, virtual network interface controllers (vNICs) change during the migration process. As a result, vNICs that are configured with a static IP linked to the interface name in the guest VM lose their IP. To avoid this, click the *Edit* icon next to *Preserve static IPs* and toggle the *Whether to preserve the static IPs* switch in the window that opens. Then click *Save*.
+
{project-short} then issues a warning message about any VMs for which vNIC properties are missing. To retrieve any missing vNIC properties, run those VMs in vSphere in order for the vNIC properties to be reported to {project-short}.

* *Entering a list of decryption passphrases for disks encrypted using Linux Unified Key Setup (LUKS)*: To enter a list of decryption passphrases for LUKS-encrypted devices, in the *Settings* section, click the *Edit* icon next to *Disk decryption passphrases*, enter the passphrases, and then click *Save*. You do not need to enter the passphrases in a specific order. For each LUKS-encrypted device, {project-short} tries each passphrase until one unlocks the device.

* *Specifying a root device*: Applies to multi-boot VM migrations only. By default, {project-short} uses the first bootable device detected as the root device.
+
To specify a different root device, in the *Settings* section, click the *Edit* icon next to *Root device* and choose a device from the list of commonly-used options, or enter a device in the text box.
+
{project-short} uses the following format for disk location: `/dev/sd<disk_identifier><disk_partition>`. For example, if the second disk is the root device and the operating system is on the disk's second partition, the format would be: `/dev/sdb2`. After you enter the boot device, click *Save*.
+
If the conversion fails because the boot device provided is incorrect, it is possible to get the correct information by checking the conversion pod logs.

endif::[]
ifdef::rhv[]

. Check the following items related to {rhv-short}. All are optional except for *Warm migration*.

* *Warm migration* By default, all migrations are cold migrations. For a warm migration, click the *Edit* icon, and select *Warm migration*.

* *Preserving the CPU model of VMs that are migrated from {rhv-short}*: Generally, the CPU model (type) for {rhv-short} VMs is set at the cluster level, but it can be set at the VM level, which is called a custom CPU model.
By default, {project-short} sets the CPU model on the destination cluster as follows:
** {project-short} preserves custom CPU settings for VMs that have them.
** For VMs without custom CPU settings, {project-short} does not set the CPU model. Instead, the CPU model is later set by {virt}.
+
To preserve the cluster-level CPU model of your {rhv-short} VMs, in the *Settings* section, click the *Edit* icon next to *Preserve CPU model*. Toggle the *Whether to preserve the CPU model* switch, and then click *Save*.
endif::[]

. If your plan is valid, you can do one of the following:
.. Run the plan now by clicking *Start migration*.
.. Run the plan later by selecting it on the *Plans for virtualization* page and following the procedure in xref:running-migration-plan_{context}[Running a migration plan].

ifdef::vmware[]
include::snip_vmware-name-change.adoc[]
endif::[]