Max concurrent virtual machine migrations

Signed-off-by: RichardHoch <[email protected]>

documentation/doc-Migration_Toolkit_for_Virtualization/master.adoc

@@ -102,7 +102,7 @@ include::modules/installing-mtv-operator.adoc[leveloffset=+2]
 :mtv:
 
 include::modules/configuring-mtv-operator.adoc[leveloffset=+2]
-
+include::modules/max-concurrent-vms.adoc[leveloffset=+3]
 
 [id="migrating-vms-web-console_{context}"]
 == Migrating virtual machines by using the {ocp} web console

documentation/modules/configuring-mtv-operator.adoc

@@ -8,7 +8,7 @@
 
 You can configure all of the following settings of the {operator-name} by modifying the `ForkliftController` CR, or in the *Settings* section of the *Overview* page, unless otherwise indicated.
 
-* Maximum number of virtual machines (VMs) per plan that can be migrated simultaneously.
+* Maximum number of virtual machines (VMs) or disks per plan that {project-first} can migrate simultaneously.
 * How long `must gather` reports are retained before being automatically deleted.
 * CPU limit allocated to the main controller container.
 * Memory limit allocated to the main controller container.
@@ -37,7 +37,13 @@ spec:
 |Label |Description |Default value
 
 |`controller_max_vm_inflight`
-|The maximum number of VMs per plan that can be migrated simultaneously.
+a|*Varies with provider as follows*:
+
+* {rhv-full}, {osp}, VMware warm migrations _or_ remote cold migrations: The maximum number of disks that {project-short} can transfer simultaneously.
+
+* OVA or VMware local cold migrations: The maximum number of VMs that {project-short} can migrate simultaneously.
++
+See xref:max-concurrent-vms_{context}[Configuring the controller_max_vm_inflight label] for a detailed explanation of this setting.
 |`20`
 
 |`must_gather_api_cleanup_max_age`

documentation/modules/max-concurrent-vms.adoc

@@ -0,0 +1,16 @@
+
+// Module included in the following assemblies:
+//
+// * documentation/doc-Migration_Toolkit_for_Virtualization/master.adoc
+
+:_content-type: PROCEDURE
+[id="max-concurrent-vms_{context}"]
+= Configuring the controller_max_vm_inflight label
+
+For {rhv-full}, {osp}, VMware warm migrations _or_ remote cold migrations, the setting `controller_max_vm_inflight` (shown in the UI as *Max concurrent virtual machine migrations*) specifies the maximum number of _disks_ that {project-first} can transfer simultaneously. In these migrations, {project-short} migrates the disks in parallel. This means that if the combined number of disks that you want to migrate is greater than the value of the setting, additional disks must wait until the queue is free, without regard for whether a VM has finished being migrating.
+
+Example: If the value of the setting is 15, and VM A has 5 disks, VM B has 5 disks, and VM C has 6 disks, all the disks except for the 16th begin migrating at the same time. Once any of them has migrated, the 16th disk can be migrated, whether or not all the disks on VM A and VM B have finished migrating.
+
+However, for OVA or for local VMware local cold migrations, the setting specifies the maximum number of _VMs_ that {project-short} can migrate simultaneously, meaning that all additional disks must wait until at least one VM has been completely migrated.
+
+Example: If the value of the setting is 2, and VM A has 5 disks, VM B has 5 disks, and VM C has 6 disks, all the disks on VM C must wait until either all the disks on VM A or on VM B have finished migrating.

documentation/modules/mtv-settings.adoc

@@ -14,27 +14,33 @@ If you have Administrator privileges, you can access the *Overview* page and cha
 |Setting |Description |Default value
 
 |Max concurrent virtual machine migrations
-|The maximum number of VMs per plan that can be migrated simultaneously
+a|*Varies with provider as follows*:
+
+* {rhv-full}, {osp}, VMware warm migrations _or_ remote cold migrations: The maximum number of disks that {project-first} can transfer simultaneously.
+
+* OVA or VMware local cold migrations: The maximum number of VMs that {project-short} can migrate simultaneously.
++
+See xref:max-concurrent-vms_{context}[Configuring the controller_max_vm_inflight label] for a detailed explanation of this setting.
 |20
 
 |Must gather cleanup after (hours)
-|The duration for retaining `must gather` reports before they are automatically deleted
+|The duration for retaining `must gather` reports before they are automatically deleted.
 |Disabled
 
 |Controller main container CPU limit
-|The CPU limit allocated to the main controller container
+|The CPU limit allocated to the main controller container.
 |500 m
 
 |Controller main container Memory limit
-|The memory limit allocated to the main controller container
+|The memory limit allocated to the main controller container.
 |800 Mi
 
 |Precopy internal (minutes)
-|The interval at which a new snapshot is requested before initiating a warm migration
+|The interval at which a new snapshot is requested before initiating a warm migration.
 |60
 
 |Snapshot polling interval (seconds)
-|The frequency with which the system checks the status of snapshot creation or removal during a warm migration
+|The frequency with which the system checks the status of snapshot creation or removal during a warm migration.
 |10
 |===
 
@@ -44,3 +50,4 @@ If you have Administrator privileges, you can access the *Overview* page and cha
 . In the *Settings* list, click the Edit icon of the setting you want to change.
 . Choose a setting from the list.
 . Click *Save*.
+