OVF export tool parallel threads code improvements

Author: sureshanaparti

api/src/main/java/org/apache/cloudstack/vm/UnmanagedVMsManager.java

@@ -49,7 +49,9 @@ public interface UnmanagedVMsManager extends VmImportService, UnmanageVMService,
             "threads.on.kvm.host.to.transfer.vmware.vm.files",
             "Advanced",
             "0",
-            "Number of threads to use on the KVM host (by ovftool) to transfer VMware VM files, zero (or less than zero) would use total disks count. Default (0)",
+            "Threads to use on the KVM host (by OVF Tool, supported from version >= 4.4.0) to transfer VMware VM files," +
+                    " less than zero - disabled, zero - uses total disks count, value should be less than 100 which is approximated to the number" +
+                    " of CPU cores minus one. Default: 0.",
             true,
             ConfigKey.Scope.Global,
             null);

plugins/hypervisors/kvm/src/main/java/com/cloud/hypervisor/kvm/resource/LibvirtComputingResource.java

@@ -307,7 +307,11 @@ public class LibvirtComputingResource extends ServerResourceBase implements Serv
     public static final String TUNGSTEN_PATH = "scripts/vm/network/tungsten";
 
     public static final String INSTANCE_CONVERSION_SUPPORTED_CHECK_CMD = "virt-v2v --version";
+    // virt-v2v --version => sample output: virt-v2v 1.42.0rhel=8,release=22.module+el8.10.0+1590+a67ab969
     public static final String OVF_EXPORT_SUPPORTED_CHECK_CMD = "ovftool --version";
+    // ovftool --version => sample output: VMware ovftool 4.6.0 (build-21452615)
+    public static final String OVF_EXPORT_TOOl_GET_VERSION_CMD = "ovftool --version | awk '{print $3}'";
+
     public static final String WINDOWS_GUEST_CONVERSION_SUPPORTED_CHECK_CMD = "rpm -qa | grep -i virtio-win";
     public static final String UBUNTU_WINDOWS_GUEST_CONVERSION_SUPPORTED_CHECK_CMD = "dpkg -l virtio-win";
     public static final String UBUNTU_NBDKIT_PKG_CHECK_CMD = "dpkg -l nbdkit";
@@ -5167,6 +5171,26 @@ public boolean hostSupportsOvfExport() {
         return exitValue == 0;
     }
 
+    public boolean ovfExportToolSupportsParallelThreads() {
+        String ovfExportToolVersion = Script.runSimpleBashScript(OVF_EXPORT_TOOl_GET_VERSION_CMD);
+        if (StringUtils.isBlank(ovfExportToolVersion)) {
+            return false;
+        }
+        String[] ovfExportToolVersions = ovfExportToolVersion.trim().split("\\.");
+        if (ovfExportToolVersions.length > 1) {
+            try {
+                int majorVersion = Integer.parseInt(ovfExportToolVersions[0]);
+                int minorVersion = Integer.parseInt(ovfExportToolVersions[1]);
+                //ovftool version >= 4.4 supports parallel threads
+                if (majorVersion > 4 || (majorVersion == 4 && minorVersion >= 4)) {
+                    return true;
+                }
+            } catch (NumberFormatException ignored) {
+            }
+        }
+        return false;
+    }
+
     private void setCpuTopology(CpuModeDef cmd, int vCpusInDef, Map<String, String> details) {
         if (!enableManuallySettingCpuTopologyOnKvmVm) {
             s_logger.debug(String.format("Skipping manually setting CPU topology on VM's XML due to it is disabled in agent.properties {\"property\": \"%s\", \"value\": %s}.",

plugins/hypervisors/kvm/src/main/java/com/cloud/hypervisor/kvm/resource/wrapper/LibvirtConvertInstanceCommandWrapper.java

@@ -106,6 +106,9 @@ public Answer execute(ConvertInstanceCommand cmd, LibvirtComputingResource serve
             }
 
             int noOfThreads = cmd.getThreadsCountToExportOvf();
+            if (noOfThreads > 1 && !serverResource.ovfExportToolSupportsParallelThreads()) {
+                noOfThreads = 0;
+            }
             ovfTemplateDirOnConversionLocation = UUID.randomUUID().toString();
             temporaryStoragePool.createFolder(ovfTemplateDirOnConversionLocation);
             sourceOVFDirPath = String.format("%s/%s/", temporaryConvertPath, ovfTemplateDirOnConversionLocation);
@@ -370,13 +373,11 @@ private boolean exportOVAFromVMOnVcenter(String vmExportUrl,
                                              String targetOvfDir,
                                              int noOfThreads,
                                              long timeout) {
-        if (noOfThreads <= 0) {
-            // '--parallelThreads': Value must be greater than zero
-            noOfThreads = 1;
-        }
         Script script = new Script("ovftool", timeout, s_logger);
         script.add("--noSSLVerify");
-        script.add(String.format("--parallelThreads=%s", noOfThreads));
+        if (noOfThreads > 1) {
+            script.add(String.format("--parallelThreads=%s", noOfThreads));
+        }
         script.add(vmExportUrl);
         script.add(targetOvfDir);
 

server/src/main/java/com/cloud/configuration/ConfigurationManagerImpl.java

@@ -559,6 +559,7 @@ private void populateConfigValuesForValidationSet() {
         configValuesForValidation.add(StorageManager.STORAGE_POOL_CLIENT_MAX_CONNECTIONS.key());
         configValuesForValidation.add(UserDataManager.VM_USERDATA_MAX_LENGTH_STRING);
         configValuesForValidation.add(UnmanagedVMsManager.RemoteKvmInstanceDisksCopyTimeout.key());
+        configValuesForValidation.add(UnmanagedVMsManager.ThreadsOnKVMHostToTransferVMwareVMFiles.key());
     }
 
     private void weightBasedParametersForValidation() {
@@ -1292,6 +1293,12 @@ private String validateConfigurationValue(final String name, String value, final
                         throw new InvalidParameterValueException("Please enter a value less than 1048576 for the configuration parameter:" + name);
                     }
                 }
+
+                if (UnmanagedVMsManager.ThreadsOnKVMHostToTransferVMwareVMFiles.key().equalsIgnoreCase(name)) {
+                    if (val >= 100) {
+                        throw new InvalidParameterValueException("Please enter a value less than 100 for the configuration parameter:" + name);
+                    }
+                }
             } catch (final NumberFormatException e) {
                 s_logger.error("There was an error trying to parse the integer value for:" + name);
                 throw new InvalidParameterValueException("There was an error trying to parse the integer value for:" + name);

server/src/main/java/org/apache/cloudstack/vm/UnmanagedVMsManagerImpl.java

@@ -1881,8 +1881,8 @@ private UnmanagedInstanceTO convertVmwareInstanceToKVMAfterExportingOVFToConvert
         int timeoutSeconds = UnmanagedVMsManager.ConvertVmwareInstanceToKvmTimeout.value() * 60 * 60;
         cmd.setWait(timeoutSeconds);
         int noOfThreads = UnmanagedVMsManager.ThreadsOnKVMHostToTransferVMwareVMFiles.value();
-        if (noOfThreads <= 0) {
-            // Use threads as the disks count
+        if (noOfThreads == 0) {
+            // Use no. of threads as the disks count
             noOfThreads = clonedInstance.getDisks().size();
         }
         cmd.setThreadsCountToExportOvf(noOfThreads);