clean up CloudStack metadata (zone, pod, cluster, host details) for vm (kvm) unmanage operation. by pavanaravapalli · Pull Request #12127 · apache/cloudstack

pavanaravapalli · 2025-11-24T22:22:49Z

PR fixes #12126.

Description

This PR...

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?

codecov · 2025-11-25T10:51:31Z

Codecov Report

❌ Patch coverage is 53.84615% with 6 lines in your changes missing coverage. Please review.
✅ Project coverage is 17.57%. Comparing base (8171d95) to head (6632809).
⚠️ Report is 91 commits behind head on main.

Files with missing lines	Patch %	Lines
...a/com/cloud/agent/api/UnmanageInstanceCommand.java	50.00%	2 Missing ⚠️
...wrapper/LibvirtUnmanageInstanceCommandWrapper.java	0.00%	2 Missing ⚠️
.../java/com/cloud/agent/api/to/VirtualMachineTO.java	50.00%	1 Missing ⚠️
...ervisor/kvm/resource/LibvirtComputingResource.java	50.00%	0 Missing and 1 partial ⚠️

Additional details and impacted files

@@            Coverage Diff            @@
##               main   #12127   +/-   ##
=========================================
  Coverage     17.56%   17.57%           
- Complexity    15538    15547    +9     
=========================================
  Files          5912     5913    +1     
  Lines        529383   529452   +69     
  Branches      64660    64671   +11     
=========================================
+ Hits          92984    93026   +42     
- Misses       425941   425967   +26     
- Partials      10458    10459    +1

Flag	Coverage Δ
uitests	`3.58% <ø> (+<0.01%)`	⬆️
unittests	`18.63% <53.84%> (+<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.

DaanHoogland · 2025-11-25T14:44:48Z

@pavanaravapalli , looks good. Please forgive me if I am mistaken, but didn’t we agree that leaving metadata in unmanaged VMs should be optional?
I see you unconditionally remove it on un-manage.

DaanHoogland · 2025-11-25T14:45:00Z

@blueorangutan package

blueorangutan · 2025-11-25T14:46:04Z

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

blueorangutan · 2025-11-25T15:52:50Z

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

pavanaravapalli · 2025-11-25T17:51:50Z

@DaanHoogland

Thanks for checking. I wasn’t fully aligned with leaving the metadata as-is without a cleanup option, since it can lead to repetitive manual work and also raises data-security concerns when unmanaged VMs keep CS details.

As this PR is still in progress, I plan to add a toggle kvm.libvirt.xml.metadata.clean=true/false( global config ) to control metadata cleanup on unmanage.

… details) from Libvirt XML for KVM VMs after an unmanage operation, controlled by the global config vm.unmanage.libvirt.metadata.cleanup [default: true]

pavanaravapalli · 2025-11-27T08:34:38Z

@blueorangutan package

blueorangutan · 2025-11-27T08:36:03Z

@pavanaravapalli 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-11-27T09:59:57Z

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

DaanHoogland

clgtm

DaanHoogland · 2025-11-27T13:38:21Z

@blueorangutan test

blueorangutan · 2025-11-27T13:40:03Z

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

blueorangutan · 2025-11-27T14:08:50Z

[SF] Trillian Build Failed (tid-14876)

pavanaravapalli · 2025-11-27T14:52:53Z

I believe the Jenkins build issues aren’t related to my code changes; they seem to be caused by the DB schema upgrade.

DaanHoogland · 2025-11-27T15:36:29Z

@blueorangutan package

blueorangutan · 2025-11-27T15:38:05Z

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

blueorangutan · 2025-11-27T17:22:23Z

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

DaanHoogland · 2025-11-28T09:04:30Z

@blueorangutan test

blueorangutan · 2025-11-28T09:06:04Z

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

blueorangutan · 2025-11-29T00:26:27Z

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

Test	Result	Time (s)	Test File
test_01_unmanage_vm_cycle_persistent_domain	`Error`	68.43	test_vm_lifecycle_unmanage_kvm_import.py
test_01_unmanage_vm_cycle_persistent_domain	`Error`	68.44	test_vm_lifecycle_unmanage_kvm_import.py
ContextSuite context=TestUnmanageKvmVM>:teardown	`Error`	240.96	test_vm_lifecycle_unmanage_kvm_import.py

vladimirpetrov · 2026-01-28T08:54:58Z

@blueorangutan package

blueorangutan · 2026-01-28T08:56:04Z

@vladimirpetrov a [SL] Jenkins job has been kicked to build packages. It will be bundled with no SystemVM templates. I'll keep you posted as I make progress.

blueorangutan · 2026-01-28T09:40:59Z

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

vladimirpetrov · 2026-01-30T16:33:33Z

I'm getting the following error when trying to unmanage instance @pavanaravapalli:

2026-01-30 16:31:41,120 DEBUG [c.c.a.t.Request] (API-Job-Executor-39:[ctx-c0e7c82c, job-48, ctx-89088ece]) (logid:64a7100b) Seq 1-5360972406431160699: Sending  { Cmd , MgmtId: 32988536504755, via: 1(ref-tr
l-10755-k-Mol9-vladimir-petrov-kvm1), Ver: v1, Flags: 100011, [{"com.cloud.agent.api.UnmanageInstanceCommand":{"instanceName":"i-2-5-VM","executeInSequence":"false","isConfigDriveAttached":"false","isLibvi
rtMetadataCleanUpEnabled":"true","wait":"0","bypassHostMaintenance":"false"}}] }
2026-01-30 16:31:41,164 DEBUG [c.c.a.t.Request] (AgentManager-Handler-15:[]) (logid:) Seq 1-5360972406431160699: Processing:  { Ans: , MgmtId: 32988536504755, via: 1, Ver: v1, Flags: 10, [{"com.cloud.agent
.api.Answer":{"result":"false","details":"java.lang.NullPointerException: Cannot invoke "com.cloud.agent.api.to.VirtualMachineTO.setExcludeMetadata(boolean)" because "vmSpec" is null
        at com.cloud.hypervisor.kvm.resource.wrapper.LibvirtUnmanageInstanceCommandWrapper.execute(LibvirtUnmanageInstanceCommandWrapper.java:71)
        at com.cloud.hypervisor.kvm.resource.wrapper.LibvirtUnmanageInstanceCommandWrapper.execute(LibvirtUnmanageInstanceCommandWrapper.java:62)
        at com.cloud.hypervisor.kvm.resource.wrapper.LibvirtRequestWrapper.execute(LibvirtRequestWrapper.java:78)
        at com.cloud.hypervisor.kvm.resource.LibvirtComputingResource.executeRequest(LibvirtComputingResource.java:2282)
        at com.cloud.agent.Agent.processRequest(Agent.java:813)
        at com.cloud.agent.Agent$AgentRequestHandler.doTask(Agent.java:1295)
        at com.cloud.utils.nio.Task.call(Task.java:83)
        at com.cloud.utils.nio.Task.call(Task.java:29)
        at java.base/java.util.concurrent.FutureTask.run(FutureTask.java:317)
        at java.base/java.util.concurrent.ThreadPoolExecutor.runWorker(ThreadPoolExecutor.java:1144)
        at java.base/java.util.concurrent.ThreadPoolExecutor$Worker.run(ThreadPoolExecutor.java:642)
        at java.base/java.lang.Thread.run(Thread.java:1583)
","wait":"0","bypassHostMaintenance":"false"}}] }
2026-01-30 16:31:41,164 DEBUG [c.c.a.t.Request] (API-Job-Executor-39:[ctx-c0e7c82c, job-48, ctx-89088ece]) (logid:64a7100b) Seq 1-5360972406431160699: Received:  { Ans: , MgmtId: 32988536504755, via: 1(ref
-trl-10755-k-Mol9-vladimir-petrov-kvm1), Ver: v1, Flags: 10, { Answer } }
2026-01-30 16:31:41,164 DEBUG [c.c.v.ClusteredVirtualMachineManagerImpl] (API-Job-Executor-39:[ctx-c0e7c82c, job-48, ctx-89088ece]) (logid:64a7100b) Failed to persist domain XML for Instance: i-2-5-VM on h
ost ID: 1
2026-01-30 16:31:41,165 ERROR [c.c.v.UserVmManagerImpl] (API-Job-Executor-39:[ctx-c0e7c82c, job-48, ctx-89088ece]) (logid:64a7100b) Could not unmanage VM VM instance {"id":5,"instanceName":"i-2-5-VM","stat
e":"Running","type":"User","uuid":"b4ad6cd5-68b2-47ea-9044-303c39cf7148"} com.cloud.utils.exception.CloudRuntimeException: Failed to persist domain XML for Instance: i-2-5-VM on host ID: 1
        at com.cloud.vm.VirtualMachineManagerImpl.persistDomainForKVM(VirtualMachineManagerImpl.java:2103)
        at com.cloud.vm.VirtualMachineManagerImpl.unmanage(VirtualMachineManagerImpl.java:2037)
        at com.cloud.vm.UserVmManagerImpl.unmanageUserVM(UserVmManagerImpl.java:9541)
        at java.base/jdk.internal.reflect.DirectMethodHandleAccessor.invoke(DirectMethodHandleAccessor.java:103)
        at java.base/java.lang.reflect.Method.invoke(Method.java:580)
        at org.springframework.aop.support.AopUtils.invokeJoinpointUsingReflection(AopUtils.java:344)
        at org.springframework.aop.framework.ReflectiveMethodInvocation.invokeJoinpoint(ReflectiveMethodInvocation.java:198)
        at org.springframework.aop.framework.ReflectiveMethodInvocation.proceed(ReflectiveMethodInvocation.java:163)
        at org.springframework.aop.interceptor.ExposeInvocationInterceptor.invoke(ExposeInvocationInterceptor.java:97)
        at org.springframework.aop.framework.ReflectiveMethodInvocation.proceed(ReflectiveMethodInvocation.java:186)
        at org.springframework.aop.framework.JdkDynamicAopProxy.invoke(JdkDynamicAopProxy.java:215)
        at jdk.proxy3/jdk.proxy3.$Proxy221.unmanageUserVM(Unknown Source)
        at org.apache.cloudstack.vm.UnmanagedVMsManagerImpl.unmanageVMInstance(UnmanagedVMsManagerImpl.java:2466)
        at java.base/jdk.internal.reflect.DirectMethodHandleAccessor.invoke(DirectMethodHandleAccessor.java:103)
        at java.base/java.lang.reflect.Method.invoke(Method.java:580)
        at org.springframework.aop.support.AopUtils.invokeJoinpointUsingReflection(AopUtils.java:344)
        at org.springframework.aop.framework.ReflectiveMethodInvocation.invokeJoinpoint(ReflectiveMethodInvocation.java:198)
        at org.springframework.aop.framework.ReflectiveMethodInvocation.proceed(ReflectiveMethodInvocation.java:163)
        at org.apache.cloudstack.network.contrail.management.EventUtils$EventInterceptor.invoke(EventUtils.java:109)
        at org.springframework.aop.framework.ReflectiveMethodInvocation.proceed(ReflectiveMethodInvocation.java:175)
        at com.cloud.event.ActionEventInterceptor.invoke(ActionEventInterceptor.java:52)
        at org.springframework.aop.framework.ReflectiveMethodInvocation.proceed(ReflectiveMethodInvocation.java:175)
        at org.springframework.aop.interceptor.ExposeInvocationInterceptor.invoke(ExposeInvocationInterceptor.java:97)
        at org.springframework.aop.framework.ReflectiveMethodInvocation.proceed(ReflectiveMethodInvocation.java:186)
        at org.springframework.aop.framework.JdkDynamicAopProxy.invoke(JdkDynamicAopProxy.java:215)
        at jdk.proxy3/jdk.proxy3.$Proxy541.unmanageVMInstance(Unknown Source)
        at org.apache.cloudstack.api.command.admin.vm.UnmanageVMInstanceCmd.execute(UnmanageVMInstanceCmd.java:125)
        at com.cloud.api.ApiDispatcher.dispatch(ApiDispatcher.java:173)
        at com.cloud.api.ApiAsyncJobDispatcher.runJob(ApiAsyncJobDispatcher.java:110)
        at org.apache.cloudstack.framework.jobs.impl.AsyncJobManagerImpl$5.runInContext(AsyncJobManagerImpl.java:698)
        at org.apache.cloudstack.managed.context.ManagedContextRunnable$1.run(ManagedContextRunnable.java:49)
        at org.apache.cloudstack.managed.context.impl.DefaultManagedContext$1.call(DefaultManagedContext.java:56)
        at org.apache.cloudstack.managed.context.impl.DefaultManagedContext.callWithContext(DefaultManagedContext.java:103)
        at org.apache.cloudstack.managed.context.impl.DefaultManagedContext.runWithContext(DefaultManagedContext.java:53)
        at org.apache.cloudstack.managed.context.ManagedContextRunnable.run(ManagedContextRunnable.java:46)
        at org.apache.cloudstack.framework.jobs.impl.AsyncJobManagerImpl$5.run(AsyncJobManagerImpl.java:646)
        at java.base/java.util.concurrent.Executors$RunnableAdapter.call(Executors.java:572)
        at java.base/java.util.concurrent.FutureTask.run(FutureTask.java:317)
        at java.base/java.util.concurrent.ThreadPoolExecutor.runWorker(ThreadPoolExecutor.java:1144)
        at java.base/java.util.concurrent.ThreadPoolExecutor$Worker.run(ThreadPoolExecutor.java:642)
        at java.base/java.lang.Thread.run(Thread.java:1583)

when the global setting vm.unmanage.libvirt.metadata.cleanup = true. When it's set to 'false', the operation is successful.

pavanaravapalli · 2026-01-31T09:07:42Z

Okay i will check it.

pavanaravapalli · 2026-01-31T16:42:27Z

Cannot invoke "com.cloud.agent.api.to.VirtualMachineTO.setExcludeMetadata(boolean)" because "vmSpec" is null
at com.cloud.hypervisor.kvm.resource.wrapper.LibvirtUnmanageInstanc

@vladimirpetrov

just wanted to confirm is agent binaries replaced with the PR changes and can i have agent error logs as well if possible.

boring-cyborg bot added component:api component:kvm labels Nov 24, 2025

pavanaravapalli marked this pull request as draft November 24, 2025 22:22

pavanaravapalli changed the title ~~Fix: clean up CloudStack metadata (zone, pod, cluster, host details) for vm (kvm) unmanage operation.~~ WIP: clean up CloudStack metadata (zone, pod, cluster, host details) for vm (kvm) unmanage operation. Nov 24, 2025

DaanHoogland added this to the 4.23 milestone Nov 25, 2025

Added support to remove CloudStack metadata (zone, pod, cluster, host…

6632809

… details) from Libvirt XML for KVM VMs after an unmanage operation, controlled by the global config vm.unmanage.libvirt.metadata.cleanup [default: true]

pavanaravapalli force-pushed the remove-libvirt-metadata-unmanaged-kvm-vm branch from 4ed2729 to 6632809 Compare November 27, 2025 08:32

boring-cyborg bot added component:compute component:orchestration labels Nov 27, 2025

pavanaravapalli changed the title ~~WIP: clean up CloudStack metadata (zone, pod, cluster, host details) for vm (kvm) unmanage operation.~~ clean up CloudStack metadata (zone, pod, cluster, host details) for vm (kvm) unmanage operation. Nov 27, 2025

pavanaravapalli marked this pull request as ready for review November 27, 2025 12:22

DaanHoogland approved these changes Nov 27, 2025

View reviewed changes

DaanHoogland added the status:needs-testing label Nov 27, 2025

DaanHoogland closed this Dec 1, 2025

DaanHoogland reopened this Dec 1, 2025

DaanHoogland requested review from RosiKyu, bernardodemarco and nvazquez December 1, 2025 07:12

RosiKyu assigned RosiKyu and unassigned RosiKyu Jan 26, 2026

vladimirpetrov self-assigned this Jan 28, 2026

Conversation

pavanaravapalli commented Nov 24, 2025

Description

Types of changes

Feature/Enhancement Scale or Bug Severity

Feature/Enhancement Scale

Bug Severity

Screenshots (if appropriate):

How Has This Been Tested?

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

Uh oh!

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

Uh oh!

Codecov Report

Uh oh!

DaanHoogland commented Nov 25, 2025

Uh oh!

DaanHoogland commented Nov 25, 2025

Uh oh!

blueorangutan commented Nov 25, 2025

Uh oh!

blueorangutan commented Nov 25, 2025

Uh oh!

pavanaravapalli commented Nov 25, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

pavanaravapalli commented Nov 27, 2025

Uh oh!

blueorangutan commented Nov 27, 2025

Uh oh!

blueorangutan commented Nov 27, 2025

Uh oh!

DaanHoogland left a comment

Choose a reason for hiding this comment

Uh oh!

DaanHoogland commented Nov 27, 2025

Uh oh!

blueorangutan commented Nov 27, 2025

Uh oh!

blueorangutan commented Nov 27, 2025

Uh oh!

pavanaravapalli commented Nov 27, 2025

Uh oh!

DaanHoogland commented Nov 27, 2025

Uh oh!

blueorangutan commented Nov 27, 2025

Uh oh!

blueorangutan commented Nov 27, 2025

Uh oh!

DaanHoogland commented Nov 28, 2025

Uh oh!

blueorangutan commented Nov 28, 2025

Uh oh!

blueorangutan commented Nov 29, 2025

Uh oh!

vladimirpetrov commented Jan 28, 2026

Uh oh!

blueorangutan commented Jan 28, 2026

Uh oh!

blueorangutan commented Jan 28, 2026

Uh oh!

vladimirpetrov commented Jan 30, 2026

Uh oh!

pavanaravapalli commented Jan 31, 2026

Uh oh!

pavanaravapalli commented Jan 31, 2026

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

5 participants

codecov bot commented Nov 25, 2025 •

edited

Loading

pavanaravapalli commented Nov 25, 2025 •

edited

Loading