Added vddk support in vmware to kvm migrations by harikrishna-patnala · Pull Request #12970 · apache/cloudstack

harikrishna-patnala · 2026-04-07T04:43:47Z

Description

This PR introduces the VDDK implementation as part of VMware to KVM migration which reduces the migration time by half when compared to the existing implementation with exportOVF

Solution: Introduce VDDK configuration at both the host agent level and per-API-call level, wired through the migration execution pipeline on the KVM host.

Key Capabilities

Capability	Detail
Host-level config	Four new `agent.properties` keys configure VDDK defaults per KVM host
API-level overrides	Callers can pass VDDK settings via `importVm` `details`, overriding host defaults
Secure password handling	vCenter password written to a temp file, passed via `-ip` or `--password-file` based on virt-v2v version, and deleted immediately after use
Auto-thumbprint fetch	If no thumbprint is configured, it is automatically retrieved from vCenter via `openssl s_client`

Configuration Keys

libguestfs.backend   # LIBGUESTFS backend (default: direct)
vddk.lib.dir         # Path to VDDK library directory
vddk.transports      # Transport preference, e.g. nbd:nbdssl
vddk.thumbprint      # vCenter SHA1 thumbprint (auto-fetched if unset)

Precedence

API details  >  agent.properties

Doc PR: apache/cloudstack-documentation#640

Types of changes

Breaking change (fix or feature that would cause existing functionality to change)
New feature (non-breaking change which adds functionality)
Bug fix (non-breaking change which fixes an issue)
Enhancement (improves an existing feature and functionality)
Cleanup (Code refactoring and cleanup, that may add test cases)
Build/CI
Test (unit or integration test code)

Feature/Enhancement Scale or Bug Severity

Feature/Enhancement Scale

Major
Minor

Bug Severity

Screenshots (if appropriate):

How Has This Been Tested?

How did you try to break this feature and the system with this change?

harikrishna-patnala · 2026-04-07T04:49:18Z

@blueorangutan package

blueorangutan · 2026-04-07T04:50:04Z

@harikrishna-patnala a [SL] Jenkins job has been kicked to build packages. It will be bundled with KVM, XenServer and VMware SystemVM templates. I'll keep you posted as I make progress.

codecov · 2026-04-07T05:45:34Z

Codecov Report

❌ Patch coverage is 32.40938% with 317 lines in your changes missing coverage. Please review.
✅ Project coverage is 17.62%. Comparing base (4708121) to head (aa710bd).
⚠️ Report is 17 commits behind head on 4.22.

Files with missing lines	Patch %	Lines
...ervisor/kvm/resource/LibvirtComputingResource.java	5.35%	106 Missing ⚠️
.../wrapper/LibvirtConvertInstanceCommandWrapper.java	48.02%	82 Missing and 10 partials ⚠️
.../apache/cloudstack/vm/UnmanagedVMsManagerImpl.java	46.51%	25 Missing and 21 partials ⚠️
...va/com/cloud/agent/api/ConvertInstanceCommand.java	0.00%	30 Missing ⚠️
...java/com/cloud/agent/manager/AgentManagerImpl.java	0.00%	17 Missing ⚠️
...m/cloud/agent/api/CheckConvertInstanceCommand.java	29.41%	12 Missing ⚠️
.../java/com/cloud/agent/api/to/RemoteInstanceTO.java	23.07%	10 Missing ⚠️
...e/cloudstack/api/command/admin/vm/ImportVmCmd.java	0.00%	3 Missing ⚠️
...per/LibvirtCheckConvertInstanceCommandWrapper.java	85.71%	0 Missing and 1 partial ⚠️

Additional details and impacted files

@@             Coverage Diff              @@
##               4.22   #12970      +/-   ##
============================================
+ Coverage     17.60%   17.62%   +0.01%     
- Complexity    15677    15703      +26     
============================================
  Files          5918     5918              
  Lines        531681   532250     +569     
  Branches      65005    65107     +102     
============================================
+ Hits          93623    93792     +169     
- Misses       427498   427867     +369     
- Partials      10560    10591      +31

Flag	Coverage Δ
uitests	`3.70% <ø> (-0.01%)`	⬇️
unittests	`18.69% <32.40%> (+0.01%)`	⬆️

Flags with carried forward coverage won't be shown. Click here to find out more.

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.

🚀 New features to boost your workflow:

❄️ Test Analytics: Detect flaky tests, report on failures, and find test suite problems.
📦 JS Bundle Analysis: Save yourself from yourself by tracking and limiting bundle sizes in JS merges.

harikrishna-patnala · 2026-04-07T05:54:02Z

@blueorangutan package

blueorangutan · 2026-04-07T05:58:39Z

@harikrishna-patnala a [SL] Jenkins job has been kicked to build packages. It will be bundled with KVM, XenServer and VMware SystemVM templates. I'll keep you posted as I make progress.

harikrishna-patnala · 2026-04-07T05:58:45Z

@blueorangutan package

blueorangutan · 2026-04-07T06:02:56Z

@harikrishna-patnala a [SL] Jenkins job has been kicked to build packages. It will be bundled with KVM, XenServer and VMware SystemVM templates. I'll keep you posted as I make progress.

blueorangutan · 2026-04-07T06:52:35Z

Packaging result [SF]: ✔️ el8 ✔️ el9 ✔️ el10 ✔️ debian ✔️ suse15. SL-JID 17380

harikrishna-patnala · 2026-04-07T13:39:58Z

@blueorangutan package

agent/conf/agent.properties

sureshanaparti · 2026-04-08T04:23:32Z

agent/conf/agent.properties

 # Instance conversion VIRT_V2V_TMPDIR env var
 #convert.instance.env.virtv2v.tmpdir=
+
+# LIBGUESTFS backend to use for VMware to KVM conversion via VDDK (default: direct)


should keep other possible options in the comment (other than direct) ?

if direct is the only option supported for vddk, can remove this config?

api/src/main/java/org/apache/cloudstack/api/command/admin/vm/ImportVmCmd.java

...ain/java/com/cloud/hypervisor/kvm/resource/wrapper/LibvirtConvertInstanceCommandWrapper.java

blueorangutan · 2026-04-09T01:25:30Z

Packaging result [SF]: ✔️ el8 ✔️ el9 ✔️ el10 ✔️ debian ✔️ suse15. SL-JID 17411

...ain/java/com/cloud/hypervisor/kvm/resource/wrapper/LibvirtConvertInstanceCommandWrapper.java

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

sureshanaparti · 2026-04-09T04:57:16Z

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

+            }
+            if (!volumeApiService.doesStoragePoolSupportDiskOffering(selectedStoragePool, rootDiskOffering)) {
+                throw new InvalidParameterValueException(String.format("The root disk offering '%s' is not supported by the selected conversion storage pool '%s'. " +
+                        "When using VDDK, all selected disk offerings must be compatible with the conversion storage pool, as it will become the primary storage for the imported volumes.",


conversion storage pool is option parameter, and for ovf export scenario, secondary storage is used as the default conversion storage. ensure conversion storage pool is set in case of vddk (and update the update the importVm API parameter convertinstancepoolid description that it is the primary storage for vddk enabled conversion).

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

sureshanaparti · 2026-04-09T05:08:11Z

engine/orchestration/src/main/java/com/cloud/agent/manager/AgentManagerImpl.java

+                        } else {
+                            host.getDetails().put(Host.HOST_VDDK_VERSION, vddkVersion);
+                        }
+                        updateNeeded = true;


do we need all these params in host_details? Persisting Host.HOST_VDDK_VERSION should be enough when vddk lib is properly set, to indicate vddk support.

Version identification is not just enough to claim the support but we will also need the directory where it is located as we need to pass that in the virt-v2v command with vddk.

harikrishna-patnala · 2026-04-09T09:08:15Z

@blueorangutan package

blueorangutan · 2026-04-09T09:10:05Z

@harikrishna-patnala a [SL] Jenkins job has been kicked to build packages. It will be bundled with KVM, XenServer and VMware SystemVM templates. I'll keep you posted as I make progress.

blueorangutan · 2026-04-09T09:51:38Z

Packaging result [SF]: ✖️ el8 ✖️ el9 ✖️ debian ✖️ suse15. SL-JID 17420

harikrishna-patnala · 2026-04-09T10:03:03Z

@blueorangutan package

blueorangutan · 2026-04-09T10:04:05Z

@harikrishna-patnala a [SL] Jenkins job has been kicked to build packages. It will be bundled with KVM, XenServer and VMware SystemVM templates. I'll keep you posted as I make progress.

blueorangutan · 2026-04-09T11:02:49Z

Packaging result [SF]: ✔️ el8 ✔️ el9 ✔️ el10 ✔️ debian ✔️ suse15. SL-JID 17421

sureshanaparti · 2026-04-10T04:51:57Z

@blueorangutan test

blueorangutan · 2026-04-10T04:54:03Z

@sureshanaparti a [SL] Trillian-Jenkins test job (ol8 mgmt + kvm-ol8) has been kicked to run smoke tests

harikrishna-patnala · 2026-04-10T10:29:13Z

@blueorangutan package

blueorangutan · 2026-04-10T10:30:04Z

@harikrishna-patnala a [SL] Jenkins job has been kicked to build packages. It will be bundled with KVM, XenServer and VMware SystemVM templates. I'll keep you posted as I make progress.

blueorangutan · 2026-04-10T11:23:21Z

Packaging result [SF]: ✔️ el8 ✔️ el9 ✔️ el10 ✔️ debian ✔️ suse15. SL-JID 17446

sureshanaparti · 2026-04-10T11:28:12Z

agent/src/main/java/com/cloud/agent/properties/AgentProperties.java

+     * Data type: String.<br>
+     * Default value: <code>direct</code>
+     */
+    public static final Property<String> LIBGUESTFS_BACKEND = new Property<>("libguestfs.backend", "direct", String.class);


Suggested change

public static final Property<String> LIBGUESTFS_BACKEND = new Property<>("libguestfs.backend", "direct", String.class);

sureshanaparti · 2026-04-10T11:29:23Z

core/src/main/java/com/cloud/agent/api/ConvertInstanceCommand.java

    private int threadsCountToExportOvf = 0;
    private String extraParams;
+    private boolean useVddk;
+    private String libguestfsBackend;


Suggested change

private String libguestfsBackend;

sureshanaparti · 2026-04-10T11:29:58Z

...ypervisors/kvm/src/main/java/com/cloud/hypervisor/kvm/resource/LibvirtComputingResource.java

+            LOGGER.info("Detected nbdkit VDDK plugin version: {}", vddkVersion);
+        }
+
+        libguestfsBackend = StringUtils.defaultIfBlank(


Suggested change

libguestfsBackend = StringUtils.defaultIfBlank(

sureshanaparti · 2026-04-10T11:30:10Z

...ypervisors/kvm/src/main/java/com/cloud/hypervisor/kvm/resource/LibvirtComputingResource.java

+        }
+
+        libguestfsBackend = StringUtils.defaultIfBlank(
+                AgentPropertiesFileHandler.getPropertyValue(AgentProperties.LIBGUESTFS_BACKEND), "direct");


Suggested change

AgentPropertiesFileHandler.getPropertyValue(AgentProperties.LIBGUESTFS_BACKEND), "direct");

sureshanaparti · 2026-04-10T11:30:43Z

...ypervisors/kvm/src/main/java/com/cloud/hypervisor/kvm/resource/LibvirtComputingResource.java

    private boolean convertInstanceVerboseMode = false;
    private Map<String, String> convertInstanceEnv = null;
+    private String vddkLibDir = null;
+    private String libguestfsBackend = "direct";


Suggested change

private String libguestfsBackend = "direct";

private static final String libguestfsBackend = "direct";

libguestfs has two main backends:

libvirt (default)

direct (QEMU directly)

The libvirt backend adds an extra virtualization layer and restricts device access and networking paths. This conflicts with how Virtual Disk Development Kit (VDDK) works, which needs direct disk/NBD access. So, need to keep 'direct' for VDDK conversion. No need of any detail/property for this.

sureshanaparti · 2026-04-10T11:46:41Z

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

    private static final List<Storage.StoragePoolType> forceConvertToPoolAllowedTypes =
            Arrays.asList(Storage.StoragePoolType.NetworkFilesystem, Storage.StoragePoolType.Filesystem,
                    Storage.StoragePoolType.SharedMountPoint);
+    private static final String DETAIL_LIBGUESTFS_BACKEND = "libguestfs.backend";


Suggested change

private static final String DETAIL_LIBGUESTFS_BACKEND = "libguestfs.backend";

boring-cyborg bot added component:agent component:api component:kvm component:UI labels Apr 7, 2026

Added vddk support in vmware to kvm migrations

7dc5d50

harikrishna-patnala force-pushed the Introduce-vddk-in-vmware-to-kvm-migrations-422 branch from b95cfb7 to 7dc5d50 Compare April 7, 2026 04:48

harikrishna-patnala added this to the 4.22.1 milestone Apr 7, 2026

harikrishna-patnala added 2 commits April 7, 2026 10:44

Fix UI

d380447

Add defaults in the UI

fbd8082

Added validations for selected storage and selected diskofferings

cb42c2f

harikrishna-patnala added 2 commits April 7, 2026 17:36

password file related changes and vddk support addition in host details

ababa52

Detect password file option while kvm initialisation

7fb0b85

boring-cyborg bot added the component:orchestration label Apr 7, 2026

harikrishna-patnala requested a review from sureshanaparti April 7, 2026 13:40

sureshanaparti reviewed Apr 8, 2026

View reviewed changes

agent/conf/agent.properties Show resolved Hide resolved

sureshanaparti reviewed Apr 8, 2026

View reviewed changes

api/src/main/java/org/apache/cloudstack/api/command/admin/vm/ImportVmCmd.java Outdated Show resolved Hide resolved

sureshanaparti reviewed Apr 8, 2026

View reviewed changes

...ain/java/com/cloud/hypervisor/kvm/resource/wrapper/LibvirtConvertInstanceCommandWrapper.java Outdated Show resolved Hide resolved

sureshanaparti reviewed Apr 8, 2026

View reviewed changes

...ain/java/com/cloud/hypervisor/kvm/resource/wrapper/LibvirtConvertInstanceCommandWrapper.java Outdated Show resolved Hide resolved

sureshanaparti reviewed Apr 8, 2026

View reviewed changes

...ain/java/com/cloud/hypervisor/kvm/resource/wrapper/LibvirtConvertInstanceCommandWrapper.java Outdated Show resolved Hide resolved

sureshanaparti reviewed Apr 8, 2026

View reviewed changes

...ain/java/com/cloud/hypervisor/kvm/resource/wrapper/LibvirtConvertInstanceCommandWrapper.java Outdated Show resolved Hide resolved

harikrishna-patnala mentioned this pull request Apr 9, 2026

Add VDDK support in VMware to KVM migration apache/cloudstack-documentation#640

Draft