File-based disk-only VM snapshot with KVM as hypervisor by JoaoJandre · Pull Request #10632 · apache/cloudstack · GitHub

Description

This PR implements the spec available at #9524. For more information regarding it, please read the spec.

Furthermore, the following changes that are not contemplated in the spec were added:

The snapshot.merge.timeout agent property was added. It is only considered if libvirt.events.enabled is true;
A new snapshot merge process (which affects normal volume snapshots and this feature) was created. When libvirt.events.enabled is true, ACS will register to gather events from Libvirt and will collect information on the process, providing a progress report in the logs. If the configuration is false, the old process is used;
Volumes attached to VMs with file-based disk-only VM snapshots in KVM are able to be resized.

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

BLOCKER
Critical
Major
Minor
Trivial

Screenshots (if appropriate):

How Has This Been Tested?

Basic Tests

I created a test VM to carry out the tests below. Additionally, after performing the relevant operations, the VM's XML and the storage were checked to observe if the snapshots existed.

Snapshot Creation

The tests below were also repeated with the VM stopped.

N	Test	Result
1	Take a snapshot of VM 1 without specifying quiesceVM	Snapshot created
2	Take a snapshot of VM 2 specifying quiesceVM	Snapshot created

Snapshot Reversion

N	Test	Result
1	Revert VM in Running state to any snapshot	Error thrown
2	Revert VM in Stopped state to snapshot 1 and start it	VM reverted and started successfully

Snapshot Removal

N	Test	Result
1	Create a new snapshot 3 after the second reversion test and delete snapshot 1	I verified that the snapshot was no longer listed and had the correct database metadata, the file still existed because more than one delta depended on it
2	Delete snapshot 2	Snapshot deleted; snapshot 1 was merged with snapshot 3 since it only had the latter as a dependency
3	Delete snapshot 3 (current)	Snapshot removed, merged with the VM's volume
4	Create 3 snapshots and remove the first one	Snapshot removed, merged with the second snapshot
5	Create two snapshots, revert to the first, and delete the second	Snapshot deleted

Advanced Tests

Deletion Test

All tests were carried out with the VM stopped.

I created 3 snapshots: s1, s2, and s3.
I reverted the VM to snapshot s2.
I created snapshot s4.
I removed snapshot s2.

The snapshot was marked as hidden and was not removed from storage.

I removed snapshot s3.

Snapshot s3 was removed normally. Snapshot s2 was merged with snapshot s4.

I created snapshot s5.
I reverted to snapshot s4.
I removed snapshot s4.

Snapshot s4 was marked as hidden and was not removed from storage.

I removed snapshot s5.
Snapshot s5 was removed normally. Snapshot s4 was merged with the delta of the VM's volume.
I removed the last remaining snapshot (s1). It was removed normally.

Reversion Test

I created two snapshots: s1 and s2.
I reverted to snapshot s1.
I removed snapshot s1.

Snapshot s1 was marked as hidden and was not removed from storage.

I reverted to snapshot s2. Snapshot s1 was merged with the base volume.

Concurrent Test

I created 4 VMs and took a VM snapshot of each. Then, I instructed to remove them all at the same time. All snapshots were removed simultaneously and successfully.

Test with Multiple Volumes

I created a VM with one datadisk and attached 8 more datadisks (10 volumes in total), took two VM snapshots, and then instructed to remove one at a time. The snapshots were removed successfully.

Tests Changing the snapshot.merge.timeout Config

I changed the config to 1 and restarted the host;
I created a VM, took a VM snapshot, accessed it, and wrote 4GB of data to it;
I tried to remove the snapshot, an error occurred, and looking at the logs, it was possible to observe that it timed out;
I manually aborted the blockcommit process;
I changed the config to 0 and restarted the host;
I tried to remove the snapshot, and it was performed correctly;

Tests Related to Volume Resize with Disk-Only VM Snapshots on KVM

Test	Result	Expected?
Create a VM, take a snapshot, resize the volume	Resize performed successfully, both in metadata and when checked with qemu-img info	Y
Stop the VM and revert the snapshot	Revert performed successfully, volume size returned to original, both in metadata and qemu-img info	Y
Remove the snapshot with the VM stopped	The delta of the volume was correctly merged with the snapshot's, and the final size was that of the volume	Y
Start the VM, take a new snapshot, resize the volume, and remove the snapshot	Deltas were correctly merged, and the final size was that of the volume	Y

The last two tests were repeated on a VM with several snapshots, so that a merge between snapshots was performed. The result was the same.

Tests Related to Events:

Create VM, take disk-only VM snapshot, resize the root volume by 1GB more, stop the VM, revert the snapshot. It was observed through the cloud.usage_event table that the resize event was correctly triggered, and it was also observed via GUI that the account's resource limit was updated.
Repeat the test above with a VM with two volumes, with only one resized. The test had the same result, and only one resize event was triggered, for the volume that had been resized.

@blueorangutan package

Codecov Report

Attention: Patch coverage is 9.41402% with 943 lines in your changes missing coverage. Please review.

Project coverage is 16.56%. Comparing base (6fdaf51) to head (44868f6).
Report is 140 commits behind head on main.

Files with missing lines	Patch %	Lines
...napshot/KvmFileBasedStorageVmSnapshotStrategy.java	0.24%	414 Missing and 1 partial ⚠️
...LibvirtCreateDiskOnlyVMSnapshotCommandWrapper.java	1.04%	95 Missing ⚠️
...ervisor/kvm/resource/LibvirtComputingResource.java	43.93%	71 Missing and 3 partials ⚠️
.../LibvirtMergeDiskOnlyVMSnapshotCommandWrapper.java	1.38%	71 Missing ⚠️
...LibvirtRevertDiskOnlyVMSnapshotCommandWrapper.java	1.96%	50 Missing ⚠️
...d/hypervisor/kvm/resource/BlockCommitListener.java	28.12%	22 Missing and 1 partial ⚠️
...m/cloud/agent/api/storage/SnapshotMergeTreeTO.java	0.00%	21 Missing ⚠️
...tack/storage/snapshot/DefaultSnapshotStrategy.java	0.00%	19 Missing ⚠️
...java/org/apache/cloudstack/utils/qemu/QemuImg.java	0.00%	19 Missing ⚠️
...nt/api/storage/MergeDiskOnlyVmSnapshotCommand.java	0.00%	18 Missing ⚠️
... and 19 more

Additional details and impacted files

@@             Coverage Diff              @@
##               main   #10632      +/-   ##
============================================
+ Coverage     16.41%   16.56%   +0.15%     
- Complexity    13629    14008     +379     
============================================
  Files          5702     5758      +56     
  Lines        503405   511750    +8345     
  Branches      60976    62242    +1266     
============================================
+ Hits          82626    84774    +2148     
- Misses       411594   417506    +5912     
- Partials       9185     9470     +285

Flag	Coverage Δ
uitests	3.91% <ø> (-0.09%)	⬇️
unittests	17.46% <9.41%> (+0.18%)	⬆️

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.

This pull request has merge conflicts. Dear author, please fix the conflicts and sync your branch with the base branch.

@blueorangutan package

@JoaoJandre 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.

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

@rohityadavcloud @sureshanaparti @weizhouapache could we run the CI?

@blueorangutan test

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

[SF] Trillian test result (tid-13177)
Environment: kvm-ol8 (x2), Advanced Networking with Mgmt server ol8
Total time taken: 54050 seconds
Marvin logs: https://github.com/blueorangutan/acs-prs/releases/download/trillian/pr10632-t13177-kvm-ol8.zip
Smoke tests completed. 140 look OK, 1 have errors, 0 did not run
Only failed and skipped tests results shown below:

Test	Result	Time (s)	Test File
test_02_restore_vm_strict_tags_failure	Failure	53.35	test_vm_strict_host_tags.py
test_02_scale_vm_strict_tags_failure	Failure	54.75	test_vm_strict_host_tags.py
test_06_deploy_vm_on_any_host_with_strict_tags_failure	Failure	4.69	test_vm_strict_host_tags.py

This pull request has merge conflicts. Dear author, please fix the conflicts and sync your branch with the base branch.

…shot

This pull request has merge conflicts. Dear author, please fix the conflicts and sync your branch with the base branch.

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

[SF] Trillian test result (tid-13740)
Environment: kvm-ol8 (x2), Advanced Networking with Mgmt server ol8
Total time taken: 88337 seconds
Marvin logs: https://github.com/blueorangutan/acs-prs/releases/download/trillian/pr10632-t13740-kvm-ol8.zip
Smoke tests completed. 129 look OK, 12 have errors, 0 did not run
Only failed and skipped tests results shown below:

Test	Result	Time (s)	Test File
test_04_autoscale_kubernetes_cluster	Failure	97.38	test_kubernetes_clusters.py
test_nic_secondaryip_add_remove	Error	1527.10	test_multipleips_per_nic.py
ContextSuite context=TestNestedVirtualization>:setup	Error	0.00	test_nested_virtualization.py
ContextSuite context=TestNetworkACL>:setup	Error	0.00	test_network_acl.py
ContextSuite context=TestIpv6Network>:setup	Error	0.00	test_network_ipv6.py
test_delete_account	Error	1517.23	test_network.py
test_delete_network_while_vm_on_it	Error	1.22	test_network.py
test_deploy_vm_l2network	Error	1.22	test_network.py
test_l2network_restart	Error	2.46	test_network.py
ContextSuite context=TestPortForwarding>:setup	Error	3.75	test_network.py
ContextSuite context=TestPublicIP>:setup	Error	13.47	test_network.py
test_reboot_router	Failure	0.10	test_network.py
test_releaseIP	Error	7.04	test_network.py
test_releaseIP_using_IP	Error	6.64	test_network.py
ContextSuite context=TestRouterRules>:setup	Error	6.72	test_network.py
ContextSuite context=TestSharedNetworkWithConfigDrive>:setup	Error	1522.41	test_network.py
ContextSuite context=TestPrivateGwACL>:setup	Error	0.00	test_privategw_acl.py
ContextSuite context=TestAdapterTypeForNic>:setup	Error	0.00	test_nic_adapter_type.py
ContextSuite context=TestNonStrictAffinityGroups>:setup	Error	0.00	test_nonstrict_affinity_group.py
ContextSuite context=TestIsolatedNetworksPasswdServer>:setup	Error	0.00	test_password_server.py
ContextSuite context=TestPortForwardingRules>:setup	Error	0.00	test_portforwardingrules.py
ContextSuite context=TestProjectSuspendActivate>:setup	Error	1528.69	test_projects.py

@DaanHoogland I'm pretty sure these test results are not linked to this PR, could we try one more time?

…o kvm-disk-only-vm-snapshot

@slavkap I've pushed a new commit based on your suggestions. Could you check?

@blueorangutan package

@DaanHoogland 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.

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

I checked the debian build in the background. There is nothing wrong. It was one of those timing unit-test that failed

18:11:30 [ERROR]   ConfigKeyScheduledExecutionWrapperTest.scheduleDynamicTest:110 Runnable ran four times per second
18:11:30 Expected: one of {<7>, <8>}
18:11:30      but: was <6>

I think we should modify those to be more robust to virtualised environments.

I checked the debian build in the background. There is nothing wrong. It was one of those timing unit-test that failed
18:11:30 [ERROR]   ConfigKeyScheduledExecutionWrapperTest.scheduleDynamicTest:110 Runnable ran four times per second
18:11:30 Expected: one of {<7>, <8>}
18:11:30      but: was <6>
I think we should modify those to be more robust to virtualised environments.

Thanks for checking. I agree we should make these tests more robust.

I checked the debian build in the background. There is nothing wrong. It was one of those timing unit-test that failed

fyi I ran the build in the background and it passes without issues

@DaanHoogland are we good to merge then?

I'm fine with it.
How about you @slavkap ?

code LGTM
I didn't have time to run tests with NFS except for creating/deleting VM snapshots on running and stopped VMs.
This doesn't affect other storage plug-ins, but I have executed the StorPool tests that have passed

Co-authored-by: João Jandre <joao@scclouds.com.br> Co-authored-by: Fabricio Duarte <fabricio.duarte.jr@gmail.com>

File-based disk-only VM snapshot with KVM as hypervisor

2027f25

JoaoJandre added the type:new-feature label Mar 28, 2025

JoaoJandre added this to the 4.22.0 milestone Mar 28, 2025

boring-cyborg Bot added component:agent component:api component:kvm component:storage labels Mar 28, 2025

winterhazel self-requested a review March 28, 2025 17:09

yadvr requested review from sureshanaparti and weizhouapache April 1, 2025 10:21

github-actions Bot added the status:has-conflicts label Apr 28, 2025

Merge remote-tracking branch 'origin' into kvm-disk-only-vm-snapshot

73b6820

github-actions Bot removed the status:has-conflicts label Apr 28, 2025

github-actions Bot added the status:has-conflicts label May 2, 2025

Merge remote-tracking branch 'origin/main' into kvm-disk-only-vm-snap…

3d2be3f

…shot

github-actions Bot removed the status:has-conflicts label May 5, 2025

Merge remote-tracking branch 'origin/main' into kvm-disk-only-vm-snap…

0e0c6d8

…shot

github-actions Bot added the status:has-conflicts label May 12, 2025

DaanHoogland linked an issue Jul 10, 2025 that may be closed by this pull request

KVM Disk-only VM Snapshots #9524

Closed

slavkap reviewed Jul 11, 2025

View reviewed changes

Comment thread ...e/snapshot/src/main/java/org/apache/cloudstack/storage/snapshot/DefaultSnapshotStrategy.java Resolved

DaanHoogland linked an issue Jul 11, 2025 that may be closed by this pull request

Volume Snapshots of an Instance in a Powered Off State #9496

Closed

JoaoJandre added status:waiting-for-smoketest-results and removed status:needs-testing labels Jul 11, 2025

slavkap reviewed Jul 14, 2025

View reviewed changes

Comment thread ...ain/java/org/apache/cloudstack/storage/vmsnapshot/KvmFileBasedStorageVmSnapshotStrategy.java Resolved

slavkap reviewed Jul 14, 2025

View reviewed changes

sureshanaparti moved this from Done to In Progress in Apache CloudStack 4.21.0 Jul 14, 2025

JoaoJandre added 2 commits July 14, 2025 11:44

address review

1c6db4f

Merge remote-tracking branch 'scclouds/kvm-disk-only-vm-snapshot' int…

44868f6

…o kvm-disk-only-vm-snapshot

slavkap approved these changes Jul 16, 2025

View reviewed changes

DaanHoogland merged commit 53eb2c5 into apache:main Jul 16, 2025

github-project-automation Bot moved this from In Progress to Done in Apache CloudStack 4.21.0 Jul 16, 2025

weizhouapache mentioned this pull request Aug 15, 2025

Failed to create snapshot due to an internal error (4.21.0.0-RC3) #11453

Closed

weizhouapache mentioned this pull request Aug 28, 2025

Block use of internal and external snapshots on KVM #11039

Merged

2 of 14 tasks

JoaoJandre mentioned this pull request Mar 9, 2026

Introduce new backup provider (KBOSS) #12758

Merged

2 of 14 tasks

vishesh92 mentioned this pull request May 20, 2026

Don't allow vmsnapshot and volume snapshot operations on a vm which has encrypted volumes attached #13188

Open

File-based disk-only VM snapshot with KVM as hypervisor by JoaoJandre · Pull Request #10632 · apache/cloudstack · GitHub

Repository navigation

File-based disk-only VM snapshot with KVM as hypervisor - #10632

File-based disk-only VM snapshot with KVM as hypervisor#10632DaanHoogland merged 15 commits intoapache:mainapache/cloudstack:mainfrom scclouds:kvm-disk-only-vm-snapshotscclouds/cloudstack:kvm-disk-only-vm-snapshotCopy head branch name to clipboard

Conversation

JoaoJandre commented Mar 28, 2025

Description

Types of changes

Feature/Enhancement Scale or Bug Severity

Feature/Enhancement Scale

Bug Severity

Screenshots (if appropriate):

How Has This Been Tested?

Basic Tests

Snapshot Creation

Snapshot Reversion

Snapshot Removal

Advanced Tests

Deletion Test

Reversion Test

Concurrent Test

Test with Multiple Volumes

Tests Changing the snapshot.merge.timeout Config

Tests Related to Volume Resize with Disk-Only VM Snapshots on KVM

Tests Related to Events:

Uh oh!

JoaoJandre commented Mar 28, 2025

Uh oh!

codecov Bot commented Mar 28, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Codecov Report

Uh oh!

github-actions Bot commented Apr 28, 2025

Uh oh!

JoaoJandre commented Apr 28, 2025

Uh oh!

blueorangutan commented Apr 28, 2025

Uh oh!

blueorangutan commented Apr 28, 2025

Uh oh!

JoaoJandre commented Apr 28, 2025

Uh oh!

DaanHoogland commented Apr 29, 2025

Uh oh!

blueorangutan commented Apr 29, 2025

Uh oh!

blueorangutan commented Apr 29, 2025

Uh oh!

github-actions Bot commented May 2, 2025

Uh oh!

github-actions Bot commented May 12, 2025

Uh oh!

blueorangutan commented Jul 9, 2025

Uh oh!

blueorangutan commented Jul 10, 2025

Uh oh!

JoaoJandre commented Jul 10, 2025

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

JoaoJandre commented Jul 14, 2025

Uh oh!

DaanHoogland commented Jul 14, 2025

Uh oh!

blueorangutan commented Jul 14, 2025

Uh oh!

blueorangutan commented Jul 14, 2025

Uh oh!

DaanHoogland commented Jul 15, 2025

Uh oh!

JoaoJandre commented Jul 15, 2025

Uh oh!

DaanHoogland commented Jul 15, 2025

File-based disk-only VM snapshot with KVM as hypervisor#10632
DaanHoogland merged 15 commits into
apache:mainfrom
scclouds:kvm-disk-only-vm-snapshot

codecov Bot commented Mar 28, 2025 •
edited
Loading