Make kvm domain persistent when unmanaged from CS #11541

sudo87 · 2025-09-01T06:03:32Z

Description

CS creates transient KVM domain.xml. When instance is unmanaged from CS, explicit dump of domain has to be taken to manage is outside of CS.

With this PR

domainXML gets backed up and becomes persistent for further management of Instance.
Stopped instance also can be unmanaged, last host for instance is considered for defining domain
hostid param is supported in unmanageVirtualMachine API for KVM hypervisor and for stopped Instances
hostid field in response of unmanageVirtualMachine, representing host used for unmanage operation
Disable unmanaging instance with config drive, use forced param from API for KVM

Doc PR:
apache/cloudstack-documentation#562

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):

In above screenshot, "i-2-3-VM" is no longer managed by CS and is brought down. It is still listed in response of:

virsh list --all

API payload and response:

How Has This Been Tested?

For Running Instance:

Created an instance and verified listing it using 'virsh list --all'
Unmanage the instance, xml is found in "/etc/libvirt/qemu" directory (persistent domains location)
Brought that instance down with 'virsh destory '
It is seen in response of 'virsh list --all'
Imported KVM instance in the CS to manage

For Stopped Instance:

Created an instance and verified listing it using 'virsh list --all'
Stop the VM, confirm that domain disappears with virsh
Unmanage the instance, xml gets registered in "/etc/libvirt/qemu" directory (persistent domains location)
Start the instance with 'virsh start '
Import KVM instance in the CS to manage

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

sudo87 · 2025-09-01T06:03:48Z

@blueorangutan package

codecov · 2025-09-01T06:11:57Z

Codecov Report

❌ Patch coverage is 55.74468% with 104 lines in your changes missing coverage. Please review.
✅ Project coverage is 17.53%. Comparing base (ec533cd) to head (c5d6b2f).
⚠️ Report is 8 commits behind head on main.

Files with missing lines	Patch %	Lines
...wrapper/LibvirtUnmanageInstanceCommandWrapper.java	32.91%	51 Missing and 2 partials ⚠️
...ck/api/command/admin/vm/UnmanageVMInstanceCmd.java	0.00%	13 Missing ⚠️
...a/com/cloud/agent/api/UnmanageInstanceCommand.java	50.00%	12 Missing ⚠️
...n/java/com/cloud/vm/VirtualMachineManagerImpl.java	88.37%	5 Missing and 5 partials ⚠️
...stack/api/response/UnmanageVMInstanceResponse.java	0.00%	6 Missing ⚠️
.../src/main/java/com/cloud/vm/UserVmManagerImpl.java	58.33%	5 Missing ⚠️
.../apache/cloudstack/vm/UnmanagedVMsManagerImpl.java	66.66%	0 Missing and 4 partials ⚠️
...va/com/cloud/agent/api/UnmanageInstanceAnswer.java	66.66%	1 Missing ⚠️

Additional details and impacted files

@@             Coverage Diff              @@
##               main   #11541      +/-   ##
============================================
+ Coverage     17.42%   17.53%   +0.10%     
- Complexity    15336    15462     +126     
============================================
  Files          5892     5897       +5     
  Lines        526521   527054     +533     
  Branches      64293    64359      +66     
============================================
+ Hits          91767    92430     +663     
+ Misses       424401   424231     -170     
- Partials      10353    10393      +40

Flag	Coverage Δ
uitests	`3.61% <ø> (ø)`
unittests	`18.59% <55.74%> (+0.11%)`	⬆️

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.

sudo87 · 2025-09-01T06:20:35Z

@blueorangutan package

blueorangutan · 2025-09-01T06:22:04Z

@sudo87 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 · 2025-09-01T07:55:41Z

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

sudo87 · 2025-09-02T04:28:47Z

@blueorangutan package

blueorangutan · 2025-09-02T04:30:03Z

@sudo87 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 · 2025-09-02T05:20:03Z

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

sudo87 · 2025-09-02T05:39:08Z

@blueorangutan package

blueorangutan · 2025-09-02T05:40:04Z

@sudo87 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 · 2025-09-02T07:06:32Z

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

sudo87 · 2025-09-04T11:18:01Z

@blueorangutan package

blueorangutan · 2025-09-04T11:20:04Z

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

shwstppr

@sudo87 Looks interesting use-case but I'm bit concerned about making stopped VMs persistent.
Current approach of preparing and saving domain definition seems logical but we may have to make sure there are no differences in the definition when compared to a Running VM.
Will need a good amount of testing

engine/orchestration/src/main/java/com/cloud/vm/VirtualMachineManagerImpl.java

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

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

engine/orchestration/src/main/java/com/cloud/vm/VirtualMachineManagerImpl.java

blueorangutan · 2025-09-04T12:56:47Z

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

blueorangutan · 2025-09-17T13:51:09Z

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

sudo87 · 2025-09-17T17:14:03Z

@blueorangutan package

blueorangutan · 2025-09-17T17:16:04Z

@sudo87 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 · 2025-09-17T18:33:59Z

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

sudo87 · 2025-09-18T10:56:06Z

@blueorangutan package

blueorangutan · 2025-09-18T10:58:03Z

@sudo87 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 · 2025-09-18T12:14:28Z

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

sudo87 · 2025-09-18T14:46:34Z

@blueorangutan test

blueorangutan · 2025-09-18T14:48:04Z

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

blueorangutan · 2025-09-19T08:10:04Z

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

Test	Result	Time (s)	Test File
test_03_deploy_and_scale_kubernetes_cluster	`Failure`	1.17	test_kubernetes_clusters.py
test_04_autoscale_kubernetes_cluster	`Failure`	27.88	test_kubernetes_clusters.py

DaanHoogland · 2025-09-19T13:07:39Z

@sudo87 , will this be symetric? (haven’t reviewed fully yet, forgive me) I mean will a persisted domain be removed on managing the VM?

sudo87 · 2025-09-22T05:21:54Z

@sudo87 , will this be symetric? (haven’t reviewed fully yet, forgive me) I mean will a persisted domain be removed on managing the VM?

CS always manages transient VMs, so yes. Once Instance is managed again with CS, domain looses Persistent property.

github-actions · 2025-09-25T08:24:20Z

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

sudo87 · 2025-09-25T15:31:33Z

@blueorangutan package

blueorangutan · 2025-09-25T15:32:04Z

@sudo87 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 · 2025-09-25T17:12:31Z

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

sudo87 · 2025-09-29T06:58:03Z

@blueorangutan package

blueorangutan · 2025-09-29T07:00:04Z

@sudo87 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 · 2025-09-29T08:39:14Z

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

persist kvm domain when unmanaged from CS

88333b3

boring-cyborg bot added component:api component:compute component:kvm component:orchestration labels Sep 1, 2025

fetch domainxml from vm

b8901a1

Merge branch 'main' into persistentKVM

097583f

cleanup code

c9bfec1

sudo87 changed the title ~~persist kvm domain when unmanaged from CS~~ Persist kvm domain when unmanaged from CS Sep 2, 2025

sudo87 changed the title ~~Persist kvm domain when unmanaged from CS~~ Make kvm domain persistent when unmanaged from CS Sep 2, 2025

rescontruct vmspec to unmanage Stopped VM

be93681

shwstppr reviewed Sep 4, 2025

View reviewed changes

shwstppr requested review from rohityadavcloud and weizhouapache September 4, 2025 12:05

weizhouapache reviewed Sep 4, 2025

View reviewed changes

...ypervisors/kvm/src/main/java/com/cloud/hypervisor/kvm/resource/LibvirtComputingResource.java Outdated Show resolved Hide resolved

engine/orchestration/src/main/java/com/cloud/vm/VirtualMachineManagerImpl.java Outdated Show resolved Hide resolved

weizhouapache added this to the 4.22.0 milestone Sep 4, 2025

generate unmanage event and improve code coverage

237cda9

sudo87 force-pushed the persistentKVM branch from 6adb509 to 237cda9 Compare September 18, 2025 09:37

DaanHoogland added the status:needs-testing label Sep 19, 2025

github-actions bot added the status:has-conflicts label Sep 25, 2025

sudo87 added 2 commits September 25, 2025 20:53

fix unmanage stopped instance in vmware

d5e4259

merge main changes

9604964

boring-cyborg bot added the component:UI label Sep 25, 2025

github-actions bot removed the status:has-conflicts label Sep 25, 2025

Use forced true to unmanage instance with config drive

c5d6b2f

sudo87 closed this Sep 29, 2025

sudo87 reopened this Sep 29, 2025

Make kvm domain persistent when unmanaged from CS #11541

Are you sure you want to change the base?

Make kvm domain persistent when unmanaged from CS #11541

Conversation

sudo87 commented Sep 1, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Description

Types of changes

Feature/Enhancement Scale or Bug Severity

Feature/Enhancement Scale

Bug Severity

Screenshots (if appropriate):

How Has This Been Tested?

For Running Instance:

For Stopped Instance:

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

Uh oh!

sudo87 commented Sep 1, 2025

Uh oh!

codecov bot commented Sep 1, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Codecov Report

Uh oh!

sudo87 commented Sep 1, 2025

Uh oh!

blueorangutan commented Sep 1, 2025

Uh oh!

blueorangutan commented Sep 1, 2025

Uh oh!

sudo87 commented Sep 2, 2025

Uh oh!

blueorangutan commented Sep 2, 2025

Uh oh!

blueorangutan commented Sep 2, 2025

Uh oh!

sudo87 commented Sep 2, 2025

Uh oh!

blueorangutan commented Sep 2, 2025

Uh oh!

blueorangutan commented Sep 2, 2025

Uh oh!

sudo87 commented Sep 4, 2025

Uh oh!

blueorangutan commented Sep 4, 2025

Uh oh!

shwstppr left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

blueorangutan commented Sep 4, 2025

Uh oh!

blueorangutan commented Sep 17, 2025

Uh oh!

sudo87 commented Sep 17, 2025

Uh oh!

blueorangutan commented Sep 17, 2025

Uh oh!

blueorangutan commented Sep 17, 2025

Uh oh!

sudo87 commented Sep 18, 2025

Uh oh!

blueorangutan commented Sep 18, 2025

Uh oh!

blueorangutan commented Sep 18, 2025

Uh oh!

sudo87 commented Sep 18, 2025

Uh oh!

blueorangutan commented Sep 18, 2025

Uh oh!

blueorangutan commented Sep 19, 2025

Uh oh!

DaanHoogland commented Sep 19, 2025

Uh oh!

sudo87 commented Sep 22, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

sudo87 commented Sep 1, 2025 •

edited

Loading

codecov bot commented Sep 1, 2025 •

edited

Loading

sudo87 commented Sep 22, 2025 •

edited

Loading