From 81f5bf848f841649b132899cf2a07127184e6d7d Mon Sep 17 00:00:00 2001 From: RichardHoch Date: Mon, 7 Oct 2024 13:11:25 +0300 Subject: [PATCH 1/7] WIP draft Signed-off-by: RichardHoch --- .../master.adoc | 51 ++++++++++++++----- .../modules/network-prerequisites.adoc | 5 ++ documentation/modules/storage-support.adoc | 21 +++++++- 3 files changed, 61 insertions(+), 16 deletions(-) diff --git a/documentation/doc-Migration_Toolkit_for_Virtualization/master.adoc b/documentation/doc-Migration_Toolkit_for_Virtualization/master.adoc index fa3510ab10d..f3d63372adc 100644 --- a/documentation/doc-Migration_Toolkit_for_Virtualization/master.adoc +++ b/documentation/doc-Migration_Toolkit_for_Virtualization/master.adoc @@ -41,15 +41,25 @@ include::modules/about-cold-warm-migration.adoc[leveloffset=+2] Review the following prerequisites to ensure that your environment is prepared for migration. -[id="software-requirements_{context}"] +[id="mtv-software-requirements_{context}"] === Software requirements +{product-first} has software requirements for all providers as well as specific software requirements per provider. + +[id="mtv-software-requirements-all-providers_{context}"] +==== Software requirements for all providers + You must install xref:compatibility-guidelines_{context}[compatible versions] of {ocp} and {virt}. +//inc. Ostack and RHV include::modules/storage-support.adoc[leveloffset=+2] +//inc. VM and RHV include::modules/network-prerequisites.adoc[leveloffset=+2] +//all include::modules/source-vm-prerequisites.adoc[leveloffset=+2] +//RHV include::modules/rhv-prerequisites.adoc[leveloffset=+2] +//Ostack include::modules/openstack-prerequisites.adoc[leveloffset=+2] [id="additional-authentication-for-osp_{context}"] @@ -72,11 +82,13 @@ include::modules/ostack-app-cred-auth.adoc[leveloffset=+4] :!ostack: :context: mtv :mtv: - +//VM include::modules/vmware-prerequisites.adoc[leveloffset=+2] include::modules/creating-vddk-image.adoc[leveloffset=+3] include::modules/increasing-nfc-memory-vmware-host.adoc[leveloffset=+3] +//OVA include::modules/ova-prerequisites.adoc[leveloffset=+2] +//all include::modules/compatibility-guidelines.adoc[leveloffset=+2] [id="installing-the-operator_{context}"] @@ -104,10 +116,19 @@ include::modules/installing-mtv-operator.adoc[leveloffset=+2] include::modules/configuring-mtv-operator.adoc[leveloffset=+2] + [id="migrating-vms-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: +You can migrate virtual machines (VMs) by using the {ocp} web console to migrate VMs from the following providers: + +* VMware vSphere +* {rhv-full} ({rhv-short}) +* {osp} +* Open Virtual Appliances (OVAs) that were created by VMware vSphere +* Remote {virt} clusters + + . xref:adding-source-providers[Create source providers] . xref:adding-destination-providers[Create destination providers] @@ -116,7 +137,7 @@ You can migrate virtual machines (VMs) by using the {ocp} web console to: [IMPORTANT] ==== You must ensure that all xref:prerequisites_{context}[prerequisites] are met. - +//VM 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. @@ -126,42 +147,44 @@ 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"] +[id="migrating-vmware-ui"] === Adding providers You can add source providers and destination providers for a virtual machine migration by using the {ocp} web console. [id="adding-source-providers"] ==== Adding source providers +//cut to vmware -You can use {project-short} to migrate VMs from the following source providers: -* VMware vSphere -* {rhv-full} -* {osp} -* Open Virtual Appliances (OVAs) that were created by VMware vSphere -* {virt} -You can add a source provider by using the {ocp} web console. + + +You can add a source provider by using the {ocp} web console. +//VM and check procedure :!mtv: :context: vmware :vmware: include::modules/adding-source-provider.adoc[leveloffset=+4] include::modules/selecting-migration-network-for-vmware-source-provider.adoc[leveloffset=+5] :!vmware: +//RHV :context: rhv :rhv: include::modules/adding-source-provider.adoc[leveloffset=+4] :!rhv: +//Ostack :context: ostack :ostack: include::modules/adding-source-provider.adoc[leveloffset=+4] :!ostack: +//OVA :context: ova :ova: include::modules/adding-source-provider.adoc[leveloffset=+4] :!ova: +//CNV prov :context: cnv :cnv: include::modules/adding-source-provider.adoc[leveloffset=+4] @@ -170,7 +193,7 @@ include::modules/adding-source-provider.adoc[leveloffset=+4] [id="adding-destination-providers"] ==== Adding destination providers - +//Add to all You can add a {virt} destination provider by using the {ocp} web console. :mtv!: @@ -201,7 +224,7 @@ Virtual machines with guest initiated storage connections, such as Internet Smal This is to ensure that no issues arise due to the addition or newly migrated VM accessing this storage. ==== - +// all but separate VM and RHV include::modules/snip_plan-limits.adoc[] :mtv!: diff --git a/documentation/modules/network-prerequisites.adoc b/documentation/modules/network-prerequisites.adoc index b369e958213..ef4027f694d 100644 --- a/documentation/modules/network-prerequisites.adoc +++ b/documentation/modules/network-prerequisites.adoc @@ -17,6 +17,8 @@ The following prerequisites apply to all migrations: The firewalls must enable traffic over the following ports: + +// ifdef::wmware[] [cols="1,1,1,1,2a",options="header"] .Network ports required for migrating from VMware vSphere |=== @@ -42,7 +44,9 @@ Disk transfer authentication |VMware ESXi hosts |Disk transfer data copy |=== +// endif::[] +// ifdef::rhv[] [cols="1,1,1,1,2a",options="header"] .Network ports required for migrating from {rhv-full} |=== @@ -68,3 +72,4 @@ Disk transfer authentication |{rhv-short} hosts |Disk transfer data copy |=== +// endif::[] diff --git a/documentation/modules/storage-support.adoc b/documentation/modules/storage-support.adoc index f36b4a7527c..95a9167b105 100644 --- a/documentation/modules/storage-support.adoc +++ b/documentation/modules/storage-support.adoc @@ -6,7 +6,7 @@ [id="about-storage_{context}"] = Storage support and default modes -{project-short} uses the following default volume and access modes for supported storage. +{project-first} uses the following default volume and access modes for supported storage. .Default volume and access modes [cols="1,1,1", options="header"] @@ -77,9 +77,10 @@ See link:https://access.redhat.com/documentation/en-us/openshift_container_platf If your migration uses block storage and persistent volumes created with an EXT4 file system, increase the file system overhead in CDI to be more than 10%. The default overhead that is assumed by CDI does not completely include the reserved place for the root partition. If you do not increase the file system overhead in CDI by this amount, your migration might fail. ==== +// ifdef::ostack[] [NOTE] ==== -When migrating from OpenStack or running a cold-migration from RHV to the OCP cluster that MTV is deployed on, the migration allocates persistent volumes without CDI. In these cases, you might need to adjust the file system overhead. +When you migrate from OpenStack, the migration allocates persistent volumes without CDI. In these cases, you might need to adjust the file system overhead. If the configured file system overhead, which has a default value of 10%, is too low, the disk transfer will fail due to lack of space. In such a case, you would want to increase the file system overhead. @@ -87,3 +88,19 @@ In some cases, however, you might want to decrease the file system overhead to r You can change the file system overhead by changing the value of the `controller_filesystem_overhead` in the `spec` portion of the `forklift-controller` CR, as described in xref:configuring-mtv-operator_{context}[Configuring the MTV Operator]. ==== +//endif::[] + +//ifdef::rhv[] +//[NOTE] +//==== +//When you run a cold migration from {rhv-full} to the OCP cluster that {project-short} is deployed on, the migration allocates persistent volumes without CDI. In these cases, you might need to adjust the file system overhead. + +//If the configured file system overhead, which has a default value of 10%, is too low, the disk transfer will fail due to lack of space. In such a case, you would want to increase the file system overhead. + +//In some cases, however, you might want to decrease the file system overhead to reduce storage consumption. + +//You can change the file system overhead by changing the value of the `controller_filesystem_overhead` in the `spec` portion of the `forklift-controller` CR, as described in xref:configuring-mtv-operator_{context}[Configuring the MTV Operator]. +//==== +//endif::[] + + From be7326f96c5a75c3f9699f9ed5d051d209ef2704 Mon Sep 17 00:00:00 2001 From: RichardHoch Date: Mon, 7 Oct 2024 16:52:01 +0300 Subject: [PATCH 2/7] all source but CNV and all destination Signed-off-by: RichardHoch --- .../master.adoc | 100 ++++++++++-------- .../modules/adding-source-provider.adoc | 2 +- documentation/modules/storage-support.adoc | 2 +- 3 files changed, 56 insertions(+), 48 deletions(-) diff --git a/documentation/doc-Migration_Toolkit_for_Virtualization/master.adoc b/documentation/doc-Migration_Toolkit_for_Virtualization/master.adoc index f3d63372adc..ff34ae9ec55 100644 --- a/documentation/doc-Migration_Toolkit_for_Virtualization/master.adoc +++ b/documentation/doc-Migration_Toolkit_for_Virtualization/master.adoc @@ -116,11 +116,19 @@ 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 migrate VMs from the following providers: +You can migrate virtual machines (VMs) by using the {project-short} user interface, which 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=+3] +include::modules/mtv-settings.adoc[leveloffset=+3] + +[id="migrating-vms-mtv-ui_{context}"] +=== Migrating virtual machines using the MTV user interface + +You can use the {project-short} user interface to migrate VMs from the following providers: * VMware vSphere * {rhv-full} ({rhv-short}) @@ -128,11 +136,7 @@ You can migrate virtual machines (VMs) by using the {ocp} web console to migrate * Open Virtual Appliances (OVAs) that were created by VMware vSphere * Remote {virt} clusters - - -. xref:adding-source-providers[Create source providers] -. xref:adding-destination-providers[Create destination providers] -. xref:creating-migration-plans-ui[Create migration plans] +For all migrations, you specify the source provider, the destination provider, and the migration plan. The specific procedures vary per provider. [IMPORTANT] ==== @@ -143,67 +147,71 @@ VMware only: You must have the minimal set of xref:vmware-privileges_{context}[V VMware only: Creating a xref:creating-vddk-image_{context}[VMware Virtual Disk Development Kit (VDDK)] image will increase migration speed. ==== -include::modules/mtv-ui.adoc[leveloffset=+2] -include::modules/mtv-overview-page.adoc[leveloffset=+2] -include::modules/mtv-settings.adoc[leveloffset=+2] - -[id="migrating-vmware-ui"] -=== Adding providers - -You can add source providers and destination providers for a virtual machine migration by using the {ocp} web console. - -[id="adding-source-providers"] -==== Adding source providers -//cut to vmware - - - - - - -You can add a source provider by using the {ocp} web console. -//VM and check procedure :!mtv: :context: vmware :vmware: + +[id="migrating-vmware-ui"] +==== Migrating virtual machines from VMvSphere + include::modules/adding-source-provider.adoc[leveloffset=+4] include::modules/selecting-migration-network-for-vmware-source-provider.adoc[leveloffset=+5] :!vmware: -//RHV +:context: dest_vwmware +:dest_vmware: +include::modules/adding-source-provider.adoc[leveloffset=+4] +include::modules/selecting-migration-network-for-virt-provider.adoc[leveloffset=+4] +:!dest_vmware: + +==== Migrating virtual machines from RHV + :context: rhv :rhv: include::modules/adding-source-provider.adoc[leveloffset=+4] :!rhv: -//Ostack +:context: dest_rhv +:dest_rhv: +include::modules/adding-source-provider.adoc[leveloffset=+4] +include::modules/selecting-migration-network-for-virt-provider.adoc[leveloffset=+4] +:!dest_rhv: + +==== Migrating virtual machines from OStack + :context: ostack :ostack: include::modules/adding-source-provider.adoc[leveloffset=+4] :!ostack: -//OVA +:context: dest_ostack +:dest_ostack: +include::modules/adding-source-provider.adoc[leveloffset=+4] +include::modules/selecting-migration-network-for-virt-provider.adoc[leveloffset=+4] +:!dest_ostack: + +==== Migrating virtual machines from OVA + :context: ova :ova: include::modules/adding-source-provider.adoc[leveloffset=+4] :!ova: -//CNV prov -:context: cnv -:cnv: +:context: dest_ova +:dest_ova: include::modules/adding-source-provider.adoc[leveloffset=+4] -:cnv!: -:context: mtv +include::modules/selecting-migration-network-for-virt-provider.adoc[leveloffset=+4] +:!cnv_dest_ova: -[id="adding-destination-providers"] -==== Adding destination providers -//Add to all -You can add a {virt} destination provider by using the {ocp} web console. +==== Migrating virtual machines from CNV -:mtv!: -:context: cnv2 -:cnv2: +:context: cnv +:cnv: +include::modules/adding-source-provider.adoc[leveloffset=+4] +:!cnv: +:context: dest_cnv +:dest_cnv: include::modules/adding-source-provider.adoc[leveloffset=+4] -:cnv!: -:context: mtv - include::modules/selecting-migration-network-for-virt-provider.adoc[leveloffset=+4] +:!dest_cnv: + + // include::modules/creating-network-mapping.adoc[leveloffset=+2] // include::modules/creating-storage-mapping.adoc[leveloffset=+2] diff --git a/documentation/modules/adding-source-provider.adoc b/documentation/modules/adding-source-provider.adoc index 33a32266d47..b2a6a8b925d 100644 --- a/documentation/modules/adding-source-provider.adoc +++ b/documentation/modules/adding-source-provider.adoc @@ -58,7 +58,7 @@ The {ocp} cluster version of the source provider must be 4.13 or later. ==== endif::[] -ifdef::cnv2[] +ifdef::dest_vmware,dest_rhv,dest_ostack,dest_ova,dest_cnv[] = Adding {a-virt} destination provider You can use a Red Hat {virt} provider as both a source provider and destination provider. diff --git a/documentation/modules/storage-support.adoc b/documentation/modules/storage-support.adoc index 95a9167b105..55dfcd9b7ee 100644 --- a/documentation/modules/storage-support.adoc +++ b/documentation/modules/storage-support.adoc @@ -80,7 +80,7 @@ If your migration uses block storage and persistent volumes created with an EXT4 // ifdef::ostack[] [NOTE] ==== -When you migrate from OpenStack, the migration allocates persistent volumes without CDI. In these cases, you might need to adjust the file system overhead. +When you migrate from OpenStack, or when you run a cold migration from {rhv-full} to the OCP cluster that {project-short} is deployed on, the migration allocates persistent volumes without CDI. In these cases, you might need to adjust the file system overhead. If the configured file system overhead, which has a default value of 10%, is too low, the disk transfer will fail due to lack of space. In such a case, you would want to increase the file system overhead. From ab17b3e40adb803de919d66870b22c6df5db45f8 Mon Sep 17 00:00:00 2001 From: RichardHoch Date: Tue, 8 Oct 2024 20:16:58 +0300 Subject: [PATCH 3/7] Comments in files and minor changes Signed-off-by: RichardHoch --- .../master.adoc | 43 ++++++++---- .../modules/adding-source-provider.adoc | 6 +- .../modules/creating-migration-plan-2-8.adoc | 70 +++++++++++++++++++ .../modules/network-prerequisites.adoc | 2 +- documentation/modules/storage-support.adoc | 1 + 5 files changed, 103 insertions(+), 19 deletions(-) create mode 100644 documentation/modules/creating-migration-plan-2-8.adoc diff --git a/documentation/doc-Migration_Toolkit_for_Virtualization/master.adoc b/documentation/doc-Migration_Toolkit_for_Virtualization/master.adoc index ff34ae9ec55..0f36250b3f5 100644 --- a/documentation/doc-Migration_Toolkit_for_Virtualization/master.adoc +++ b/documentation/doc-Migration_Toolkit_for_Virtualization/master.adoc @@ -51,6 +51,8 @@ Review the following prerequisites to ensure that your environment is prepared f You must install xref:compatibility-guidelines_{context}[compatible versions] of {ocp} and {virt}. +// ANDY: I printed out a hard copy of the manual so I could see which sections of which files belong to which provider. There are notes buried in modules that relate to one provider. I've added comments noting the respective providers. I have left everything before and after section 4 alone for now. + //inc. Ostack and RHV include::modules/storage-support.adoc[leveloffset=+2] //inc. VM and RHV @@ -115,7 +117,7 @@ include::modules/installing-mtv-operator.adoc[leveloffset=+2] include::modules/configuring-mtv-operator.adoc[leveloffset=+2] - +// ANDY: Section 4 begins here. I changed the intro a bit. I'm not sure if differentiating between OCP and MTv interfaces is helpful yo users. I wanted to avoid using the same title twice. [id="migrating-vms-ocp-web-console_{context}"] == Migrating virtual machines by using the {ocp} web console @@ -125,6 +127,8 @@ include::modules/mtv-ui.adoc[leveloffset=+2] include::modules/mtv-overview-page.adoc[leveloffset=+3] include::modules/mtv-settings.adoc[leveloffset=+3] + + [id="migrating-vms-mtv-ui_{context}"] === Migrating virtual machines using the MTV user interface @@ -136,8 +140,10 @@ You can use the {project-short} user interface to migrate VMs from the following * Open Virtual Appliances (OVAs) that were created by VMware vSphere * Remote {virt} clusters +// ANDY: Replaces the linked bulleted list of components. For all migrations, you specify the source provider, the destination provider, and the migration plan. The specific procedures vary per provider. +// ANDY: When I create the VMware prerequisites subsection, I'll move the VM prerequisites out of here. [IMPORTANT] ==== You must ensure that all xref:prerequisites_{context}[prerequisites] are met. @@ -147,22 +153,25 @@ VMware only: You must have the minimal set of xref:vmware-privileges_{context}[V VMware only: Creating a xref:creating-vddk-image_{context}[VMware Virtual Disk Development Kit (VDDK)] image will increase migration speed. ==== +// ANDY: Now we start the new VMware A-Z section. :!mtv: :context: vmware :vmware: [id="migrating-vmware-ui"] ==== Migrating virtual machines from VMvSphere - +// ANDY: VM Prerequisites will go here. include::modules/adding-source-provider.adoc[leveloffset=+4] include::modules/selecting-migration-network-for-vmware-source-provider.adoc[leveloffset=+5] :!vmware: +// The destination provider is the same for every vendor and is really the same procedure as the source provider, which uses conditional text. But we need a new context per vendor. :context: dest_vwmware :dest_vmware: include::modules/adding-source-provider.adoc[leveloffset=+4] include::modules/selecting-migration-network-for-virt-provider.adoc[leveloffset=+4] :!dest_vmware: +// ANDY: Now RHV ==== Migrating virtual machines from RHV :context: rhv @@ -175,7 +184,8 @@ include::modules/adding-source-provider.adoc[leveloffset=+4] include::modules/selecting-migration-network-for-virt-provider.adoc[leveloffset=+4] :!dest_rhv: -==== Migrating virtual machines from OStack +// ANDY: Now OpenStack +==== Migrating virtual machines from OpenStack :context: ostack :ostack: @@ -187,6 +197,7 @@ include::modules/adding-source-provider.adoc[leveloffset=+4] include::modules/selecting-migration-network-for-virt-provider.adoc[leveloffset=+4] :!dest_ostack: +// ANDY: Now OVA ==== Migrating virtual machines from OVA :context: ova @@ -197,8 +208,9 @@ include::modules/adding-source-provider.adoc[leveloffset=+4] :dest_ova: include::modules/adding-source-provider.adoc[leveloffset=+4] include::modules/selecting-migration-network-for-virt-provider.adoc[leveloffset=+4] -:!cnv_dest_ova: +:!dest_ova: +// ANDY: Now CNV ==== Migrating virtual machines from CNV :context: cnv @@ -211,20 +223,28 @@ include::modules/adding-source-provider.adoc[leveloffset=+4] include::modules/selecting-migration-network-for-virt-provider.adoc[leveloffset=+4] :!dest_cnv: +// ANDY: That's it for this PR. +// The Next PR will add "Creating migration plans". As we discussed, I will only include "Staring from VMs" because the user will have just created a source provider. +// This will avoid me having to do a very messy context shift from "" to "provider_start" to "" to " to "" for each of the five providers (look below). + + +:context: mtv +:mtv: +// ANDY: Last note in this file -- AFAIK, the network mapping and storage mapping pages are still broken, so they remain commented out. // include::modules/creating-network-mapping.adoc[leveloffset=+2] // include::modules/creating-storage-mapping.adoc[leveloffset=+2] -[id="creating-migration-plans-ui"] +[id="creating-migration-plans-ui_{context}"] === Creating migration plans 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. For your convenience, there are two procedures to create migration plans, starting with either a source provider or with specific VMs: -* 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]. +* To start with a source provider, see xref:creating-migration-plan-2-8_provider[Creating a migration plan starting with a source provider]. +* To start with specific VMs, see xref:creating-migration-plan-2-8_vms[Creating a migration plan starting with specific VMs]. [WARNING] ==== @@ -239,12 +259,12 @@ include::modules/snip_plan-limits.adoc[] :context: provider :provider: -include::modules/creating-migration-plan-2-6-3.adoc[leveloffset=+3] +include::modules/creating-migration-plan-2-8.adoc[leveloffset=+3] :provider!: :context: vms :vms: -include::modules/creating-migration-plan-2-6-3.adoc[leveloffset=+3] +include::modules/creating-migration-plan-2-8.adoc[leveloffset=+3] :vms!: :context: mtv @@ -307,10 +327,6 @@ include::modules/new-migrating-virtual-machines-cli.adoc[leveloffset=+3] :ostack!: :context: ova :ova: -//include::modules/new-migrating-virtual-machines-cli.adoc[leveloffset=+3] -//:ova!: -//:context: ostack -//:ostack: include::modules/new-migrating-virtual-machines-cli.adoc[leveloffset=+3] :ova!: :context: cnv @@ -386,7 +402,6 @@ include::modules/collected-logs-cr-info.adoc[leveloffset=+3] include::modules/accessing-logs-ui.adoc[leveloffset=+3] include::modules/accessing-logs-cli.adoc[leveloffset=+3] -// comment to create PR == Additional information diff --git a/documentation/modules/adding-source-provider.adoc b/documentation/modules/adding-source-provider.adoc index b2a6a8b925d..a1493341e63 100644 --- a/documentation/modules/adding-source-provider.adoc +++ b/documentation/modules/adding-source-provider.adoc @@ -41,7 +41,6 @@ You can add an {osp} source provider by using the {ocp} web console. ==== When you migrate an image-based VM from an {osp} provider, a snapshot is created for the image that is attached to the source VM and the data from the snapshot is copied over to the target VM. This means that the target VM will have the same state as that of the source VM at the time the snapshot was created. ==== - endif::[] ifdef::cnv[] = Adding a Red Hat {virt} source provider @@ -56,9 +55,8 @@ You can migrate VMs from the cluster that {project-short} is deployed on to anot ==== The {ocp} cluster version of the source provider must be 4.13 or later. ==== - endif::[] -ifdef::dest_vmware,dest_rhv,dest_ostack,dest_ova,dest_cnv[] +ifdef::dest_vmware,dest_rhv,dest_ostack,dest_ova[] = Adding {a-virt} destination provider You can use a Red Hat {virt} provider as both a source provider and destination provider. @@ -167,7 +165,7 @@ If both *URL* and *Service account bearer token* are left blank, the local {ocp- + include::snip-certificate-options.adoc[] endif::[] -ifdef::cnv2[] +ifdef::dest_vmware,dest_rhv,dest_ostack,dest_ova,dest_cnv[] . Click *{virt}*. . Specify the following fields: diff --git a/documentation/modules/creating-migration-plan-2-8.adoc b/documentation/modules/creating-migration-plan-2-8.adoc new file mode 100644 index 00000000000..08b21ccb44c --- /dev/null +++ b/documentation/modules/creating-migration-plan-2-8.adoc @@ -0,0 +1,70 @@ +// * documentation/doc-Migration_Toolkit_for_Virtualization/master.adoc + +:_mod-docs-content-type: PROCEDURE +[id="creating-migration-plan-2-8_{context}"] +ifdef::provider[] += Creating a migration plan starting with a source provider + +You can create a migration plan based on a source provider, starting on the *Plans for virtualization* page. Note the specific options for migrations from VMware or {rhv-short} providers. + +.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*. +endif::[] + +ifdef::vms[] += Creating a migration plan starting with specific VMs + +You can create a migration plan based on specific VMs, starting on the *Providers for virtualization* page. Note the specific options for migrations from VMware or {rhv-short} providers. + +.Procedure + +. In the {ocp} web console, click *Providers for virtualization*. +. In the row of the appropriate source provider, click *VMs*. ++ +The *Virtual Machines* tab opens. +. Select the VMs you want to migrate and click *Create migration plan*. +endif::[] ++ +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*. +. Make any needed changes to the editable items. +. Click *Add mapping* to edit a suggested network mapping or a storage mapping, or to add one or more additional mappings. +. 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. + +. VMware source providers only (All optional): + +* *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`. 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 looking at the conversion pod logs. + +. {rhv-short} source providers only (Optional): + +* *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, but, 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*. + +. If the plan is valid, +.. You can run the plan now by clicking *Start migration*. +.. You can run the plan later by selecting it on the *Plans for virtualization* page and following the procedure in xref:running-migration-plan_mtv[Running a migration plan]. ++ +include::snip_vmware-name-change.adoc[] diff --git a/documentation/modules/network-prerequisites.adoc b/documentation/modules/network-prerequisites.adoc index ef4027f694d..19945f4d658 100644 --- a/documentation/modules/network-prerequisites.adoc +++ b/documentation/modules/network-prerequisites.adoc @@ -17,7 +17,7 @@ The following prerequisites apply to all migrations: The firewalls must enable traffic over the following ports: - +// ANDY: The comments are for later, when I separate the ports by vendor. // ifdef::wmware[] [cols="1,1,1,1,2a",options="header"] .Network ports required for migrating from VMware vSphere diff --git a/documentation/modules/storage-support.adoc b/documentation/modules/storage-support.adoc index 55dfcd9b7ee..98a930699f6 100644 --- a/documentation/modules/storage-support.adoc +++ b/documentation/modules/storage-support.adoc @@ -77,6 +77,7 @@ See link:https://access.redhat.com/documentation/en-us/openshift_container_platf If your migration uses block storage and persistent volumes created with an EXT4 file system, increase the file system overhead in CDI to be more than 10%. The default overhead that is assumed by CDI does not completely include the reserved place for the root partition. If you do not increase the file system overhead in CDI by this amount, your migration might fail. ==== +?? ANDY: The comments are for later when I break this note into two, one for OpenStack and for RHV // ifdef::ostack[] [NOTE] ==== From af95931952671128ccce5b4a3b651c4f2307a6dd Mon Sep 17 00:00:00 2001 From: RichardHoch Date: Tue, 26 Nov 2024 13:55:47 +0200 Subject: [PATCH 4/7] resolved conflict Signed-off-by: RichardHoch --- documentation/modules/adding-source-provider.adoc | 4 ++++ 1 file changed, 4 insertions(+) diff --git a/documentation/modules/adding-source-provider.adoc b/documentation/modules/adding-source-provider.adoc index a1493341e63..382ca43682d 100644 --- a/documentation/modules/adding-source-provider.adoc +++ b/documentation/modules/adding-source-provider.adoc @@ -88,7 +88,10 @@ ifdef::vmware[] * *URL*: URL of the SDK endpoint of the vCenter on which the source VM is mounted. Ensure that the URL includes the `sdk` path, usually `/sdk`. For example, `https://vCenter-host-example.com/sdk`. If a certificate for FQDN is specified, the value of this field needs to match the FQDN in the certificate. * *VDDK init image*: `VDDKInitImage` path. It is strongly recommended to create a VDDK init image to accelerate migrations. For more information, see xref:../master.adoc#creating-vddk-image_mtv[Creating a VDDK image]. +<<<<<<< HEAD + +======= +>>>>>>> 0e58345e (resolved conflict) *Provider credentials* * *Username*: vCenter user or ESXi user. For example, `user@vsphere.local`. @@ -98,6 +101,7 @@ ifdef::vmware[] include::snip-certificate-options.adoc[] endif::[] + ifdef::rhv[] . Click *Red Hat Virtualization* . Specify the following fields: From e0b263d8203336b5b8750f2657e19af6307c986e Mon Sep 17 00:00:00 2001 From: RichardHoch Date: Tue, 26 Nov 2024 14:04:29 +0200 Subject: [PATCH 5/7] merge conflict Signed-off-by: RichardHoch --- documentation/modules/adding-source-provider.adoc | 4 +--- 1 file changed, 1 insertion(+), 3 deletions(-) diff --git a/documentation/modules/adding-source-provider.adoc b/documentation/modules/adding-source-provider.adoc index 382ca43682d..dd41ba8bda4 100644 --- a/documentation/modules/adding-source-provider.adoc +++ b/documentation/modules/adding-source-provider.adoc @@ -88,10 +88,8 @@ ifdef::vmware[] * *URL*: URL of the SDK endpoint of the vCenter on which the source VM is mounted. Ensure that the URL includes the `sdk` path, usually `/sdk`. For example, `https://vCenter-host-example.com/sdk`. If a certificate for FQDN is specified, the value of this field needs to match the FQDN in the certificate. * *VDDK init image*: `VDDKInitImage` path. It is strongly recommended to create a VDDK init image to accelerate migrations. For more information, see xref:../master.adoc#creating-vddk-image_mtv[Creating a VDDK image]. -<<<<<<< HEAD + + -======= ->>>>>>> 0e58345e (resolved conflict) *Provider credentials* * *Username*: vCenter user or ESXi user. For example, `user@vsphere.local`. From e294136a433f3bb3de8fa0cfb3c462fc6148bc89 Mon Sep 17 00:00:00 2001 From: RichardHoch Date: Sun, 1 Dec 2024 16:36:53 +0200 Subject: [PATCH 6/7] after Martin --- .../master.adoc | 12 ++++++------ 1 file changed, 6 insertions(+), 6 deletions(-) diff --git a/documentation/doc-Migration_Toolkit_for_Virtualization/master.adoc b/documentation/doc-Migration_Toolkit_for_Virtualization/master.adoc index 0f36250b3f5..650ea5ed4e3 100644 --- a/documentation/doc-Migration_Toolkit_for_Virtualization/master.adoc +++ b/documentation/doc-Migration_Toolkit_for_Virtualization/master.adoc @@ -44,7 +44,7 @@ Review the following prerequisites to ensure that your environment is prepared f [id="mtv-software-requirements_{context}"] === Software requirements -{product-first} has software requirements for all providers as well as specific software requirements per provider. +{project-first} has software requirements for all providers as well as specific software requirements per provider. [id="mtv-software-requirements-all-providers_{context}"] ==== Software requirements for all providers @@ -121,7 +121,7 @@ include::modules/configuring-mtv-operator.adoc[leveloffset=+2] [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 {project-short} user interface, which is located in the *Virtualization* section of the {ocp} web console. +You can migrate virtual machines (VMs) by using the {project-short} user interface, which is located in the *Migration* section of the {ocp} web console. include::modules/mtv-ui.adoc[leveloffset=+2] include::modules/mtv-overview-page.adoc[leveloffset=+3] @@ -159,7 +159,7 @@ VMware only: Creating a xref:creating-vddk-image_{context}[VMware Virtual Disk D :vmware: [id="migrating-vmware-ui"] -==== Migrating virtual machines from VMvSphere +==== Migrating virtual machines from VMsphere // ANDY: VM Prerequisites will go here. include::modules/adding-source-provider.adoc[leveloffset=+4] include::modules/selecting-migration-network-for-vmware-source-provider.adoc[leveloffset=+5] @@ -172,7 +172,7 @@ include::modules/selecting-migration-network-for-virt-provider.adoc[leveloffset= :!dest_vmware: // ANDY: Now RHV -==== Migrating virtual machines from RHV +==== Migrating virtual machines from {rhv-full} :context: rhv :rhv: @@ -185,7 +185,7 @@ include::modules/selecting-migration-network-for-virt-provider.adoc[leveloffset= :!dest_rhv: // ANDY: Now OpenStack -==== Migrating virtual machines from OpenStack +==== Migrating virtual machines from {osp} :context: ostack :ostack: @@ -211,7 +211,7 @@ include::modules/selecting-migration-network-for-virt-provider.adoc[leveloffset= :!dest_ova: // ANDY: Now CNV -==== Migrating virtual machines from CNV +==== Migrating virtual machines from {virt} :context: cnv :cnv: From 2fe61377fc18c050924c63b1576d45f7d49a333f Mon Sep 17 00:00:00 2001 From: RichardHoch Date: Mon, 2 Dec 2024 10:02:00 +0200 Subject: [PATCH 7/7] Minor --- .../doc-Migration_Toolkit_for_Virtualization/master.adoc | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/documentation/doc-Migration_Toolkit_for_Virtualization/master.adoc b/documentation/doc-Migration_Toolkit_for_Virtualization/master.adoc index 650ea5ed4e3..a81cf0fd3b9 100644 --- a/documentation/doc-Migration_Toolkit_for_Virtualization/master.adoc +++ b/documentation/doc-Migration_Toolkit_for_Virtualization/master.adoc @@ -159,7 +159,7 @@ VMware only: Creating a xref:creating-vddk-image_{context}[VMware Virtual Disk D :vmware: [id="migrating-vmware-ui"] -==== Migrating virtual machines from VMsphere +==== Migrating virtual machines from VMware vSphere // ANDY: VM Prerequisites will go here. include::modules/adding-source-provider.adoc[leveloffset=+4] include::modules/selecting-migration-network-for-vmware-source-provider.adoc[leveloffset=+5]