api,server: allow cleaning up vm extraconfig #11974

shwstppr · 2025-11-04T11:23:58Z

Description

Fixes #9878

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?

(local) 🐱 > update virtualmachine -h
updateVirtualMachine: Updates properties of a virtual machine. The VM has to be stopped and restarted for the new properties to take effect. UpdateVirtualMachine does not first check whether the VM is stopped. Therefore, stop the VM manually before issuing this call.
Required params: id, 
API Params               Type     Description
==========               ====     ===========
cleanupdetails           boolean  optional boolean field, which indicates i
                                  f details should be cleaned up or not (i
                                  f set to true, details removed for this 
                                  resource, details field ignored; if fals
                                  e or not set, no action)
cleanupextraconfig       boolean  Optional boolean field, which indicates i
                                  f extraconfig for the instance should be
                                   cleaned up or not (If set to true, extr
                                  aconfig removed for this instance, extra
                                  config field ignored; if false or not se
                                  t, no action)
customid                 string   an optional field, in case you want to se
                                  t a custom id to the resource. Allowed t
                                  o Root Admins only
...

(localcloud) 🐱 > list virtualmachines id=d6c566f9-bec2-4daf-b1fb-2da25683229e  filter=id,name,details
{
  "count": 1,
  "virtualmachine": [
    {
      "details": {
        "cpuOvercommitRatio": "2.0",
        "extraconfig-1": "alpha=123\nbeta=456"
      },
      "id": "d6c566f9-bec2-4daf-b1fb-2da25683229e",
      "name": "VM-d6c566f9-bec2-4daf-b1fb-2da25683229e"
    }
  ]
}
(localcloud) 🐱 > update virtualmachine id=d6c566f9-bec2-4daf-b1fb-2da25683229e cleanupextraconfig=true
{
  "virtualmachine": {
    "account": "admin",
    "affinitygroup": [],
    "arch": "x86_64",
    "cpunumber": 1,
    "cpuspeed": 500,
    "cpuused": "14.36%",
    "created": "2025-12-01T06:26:23+0000",
    "deleteprotection": false,
    "details": {
      "cpuOvercommitRatio": "2.0"
    },
    "diskioread": 0,
    "diskiowrite": 4,
    "diskkbsread": 0,
    "diskkbswrite": 24,
    "displayname": "VM-d6c566f9-bec2-4daf-b1fb-2da25683229e",
    "displayvm": true,
    "domain": "ROOT",
    "domainid": "82f87e9e-ce76-11f0-8a20-1e00060003cb",
    "domainpath": "ROOT",
    "guestosid": "83199135-ce76-11f0-8a20-1e00060003cb",
    "haenable": false,
    "hasannotations": false,
    "hostcontrolstate": "Enabled",
    "hostid": "5249cdbd-9ca9-4c00-a734-0537d89d0dbc",
    "hostname": "pr11974-t14893-kvm-ol8-kvm1",
    "hypervisor": "KVM",
    "id": "d6c566f9-bec2-4daf-b1fb-2da25683229e",
    "instancename": "i-2-3-VM",
    "isdynamicallyscalable": false,
    "lastupdated": "2025-12-01T06:26:37+0000",
    "memory": 512,
    "memoryintfreekbs": -1,
    "memorykbs": 524288,
    "memorytargetkbs": 524288,
    "name": "VM-d6c566f9-bec2-4daf-b1fb-2da25683229e",
    "networkkbsread": 0,
    "networkkbswrite": 0,
    "nic": [
      {
        "broadcasturi": "vlan://1262",
        "deviceid": "0",
        "extradhcpoption": [],
        "id": "4c576998-3258-4f52-9df1-766315d8f14e",
        "isdefault": true,
        "isolationuri": "vlan://1262",
        "macaddress": "02:01:00:cc:00:01",
        "networkid": "882de96d-a74f-4131-814d-9d8e09119125",
        "networkname": "test",
        "secondaryip": [],
        "traffictype": "Guest",
        "type": "L2"
      }
    ],
    "osdisplayname": "CentOS 5.5 (64-bit)",
    "ostypeid": "83199135-ce76-11f0-8a20-1e00060003cb",
    "passwordenabled": false,
    "pooltype": "NetworkFilesystem",
    "receivedbytes": 0,
    "rootdeviceid": 0,
    "rootdevicetype": "ROOT",
    "securitygroup": [],
    "sentbytes": 0,
    "serviceofferingid": "c049fc6b-1ff2-4ce5-a881-aaa26b9625e1",
    "serviceofferingname": "Small Instance",
    "state": "Running",
    "tags": [],
    "templatedisplaytext": "CentOS 5.5(64-bit) no GUI (KVM)",
    "templateformat": "QCOW2",
    "templateid": "82fe7d45-ce76-11f0-8a20-1e00060003cb",
    "templatename": "CentOS 5.5(64-bit) no GUI (KVM)",
    "templatetype": "BUILTIN",
    "userid": "bea6206e-ce76-11f0-8a20-1e00060003cb",
    "username": "admin",
    "zoneid": "15d72fa5-8b47-4d90-b1c2-9e2c0d0b78e5",
    "zonename": "pr11974-t14893-kvm-ol8"
  }
}
(localcloud) 🐱 > list virtualmachines id=d6c566f9-bec2-4daf-b1fb-2da25683229e  filter=id,name,details
{
  "count": 1,
  "virtualmachine": [
    {
      "details": {
        "cpuOvercommitRatio": "2.0"
      },
      "id": "d6c566f9-bec2-4daf-b1fb-2da25683229e",
      "name": "VM-d6c566f9-bec2-4daf-b1fb-2da25683229e"
    }
  ]
}

clear-vm-extraconfig.mp4

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

Fixes apache#9878 Signed-off-by: Abhishek Kumar <abhishek.mrt22@gmail.com>

codecov · 2025-11-04T11:32:08Z

Codecov Report

❌ Patch coverage is 89.65517% with 3 lines in your changes missing coverage. Please review.
✅ Project coverage is 17.86%. Comparing base (04b58ac) to head (c3b6012).
⚠️ Report is 82 commits behind head on main.

Files with missing lines	Patch %	Lines
...he/cloudstack/api/command/user/vm/UpdateVMCmd.java	0.00%	3 Missing ⚠️

Additional details and impacted files

@@             Coverage Diff              @@
##               main   #11974      +/-   ##
============================================
+ Coverage     17.84%   17.86%   +0.01%     
- Complexity    15983    16008      +25     
============================================
  Files          5929     5930       +1     
  Lines        531084   531457     +373     
  Branches      64914    64973      +59     
============================================
+ Hits          94795    94923     +128     
- Misses       425675   425908     +233     
- Partials      10614    10626      +12

Flag	Coverage Δ
uitests	`3.58% <ø> (-0.01%)`	⬇️
unittests	`18.95% <89.65%> (+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.

shwstppr · 2025-11-13T04:43:49Z

@blueorangutan package

blueorangutan · 2025-11-13T04:46:04Z

@shwstppr 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-13T06:24:45Z

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

…g-updatevm

Signed-off-by: Abhishek Kumar <abhishek.mrt22@gmail.com>

shwstppr · 2025-12-01T06:50:19Z

@blueorangutan package

blueorangutan · 2025-12-01T06:52:04Z

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

DaanHoogland

clgtm

DaanHoogland · 2025-12-01T07:32:19Z

engine/schema/src/main/java/com/cloud/vm/dao/VMInstanceDetailsDaoImpl.java

+        sb.and("vmId", sb.entity().getResourceId(), SearchCriteria.Op.EQ);
+        sb.and("prefix", sb.entity().getName(), SearchCriteria.Op.LIKE);
+        sb.done();
+        SearchCriteria<VMInstanceDetailVO> sc = sb.create();
+        sc.setParameters("vmId", vmId);
+        sc.setParameters("prefix", prefix + "%");


This bit gives me to think that we might want to include these in a DbConstants, similar to the ApiConstants. No critisism on this PR as I know this is the general practice atm.

blueorangutan · 2025-12-01T08:04:07Z

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

abh1sar

A minor comment. Otherwise the code LGTM.

server/src/test/java/com/cloud/vm/UserVmManagerImplTest.java

Signed-off-by: Abhishek Kumar <abhishek.mrt22@gmail.com>

shwstppr · 2025-12-09T09:44:19Z

@blueorangutan package

blueorangutan · 2025-12-09T09:46:04Z

@shwstppr 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-12-09T11:56:46Z

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

rajujith · 2026-01-13T05:55:39Z

@shwstppr Since this is for the 4.22.1 release, could you retarget the PR to the 4.22 branch?

shwstppr · 2026-01-13T07:29:53Z

@rajujith this adds a new API request param, so I think it is better to go in 4.23. I feel this was wrongly added to 4.22.1

github-actions · 2026-01-19T13:07:23Z

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

…g-updatevm

vishesh92 · 2026-01-28T07:13:39Z

@blueorangutan package

blueorangutan · 2026-01-28T07:14:05Z

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

Copilot

Pull request overview

Enables updateVirtualMachine to remove (“clean up”) stored VM extraconfig entries, with UI support and unit tests.

Changes:

Added cleanupextraconfig API parameter to updateVirtualMachine.
Implemented server-side extraconfig cleanup via a new DAO helper that removes VM instance details by prefix.
Updated the UI to send cleanupextraconfig=true when extraconfig is cleared, and added unit tests for the new behavior.

Reviewed changes

Copilot reviewed 8 out of 8 changed files in this pull request and generated 3 comments.

Show a summary per file

File	Description
ui/src/views/compute/EditVM.vue	Sends `cleanupextraconfig` when the user clears extraconfig in the Edit VM form.
api/src/main/java/org/apache/cloudstack/api/ApiConstants.java	Adds the `CLEAN_UP_EXTRA_CONFIG` API constant.
api/src/main/java/org/apache/cloudstack/api/command/user/vm/UpdateVMCmd.java	Adds the `cleanupextraconfig` request parameter and accessor.
server/src/main/java/com/cloud/vm/UserVmManagerImpl.java	Adds `updateVmExtraConfig` logic and wires `cleanupextraconfig` into `updateVirtualMachine`.
engine/schema/src/main/java/com/cloud/vm/dao/VMInstanceDetailsDao.java	Extends DAO contract with `removeDetailsWithPrefix`.
engine/schema/src/main/java/com/cloud/vm/dao/VMInstanceDetailsDaoImpl.java	Implements prefix-based detail deletion.
server/src/test/java/com/cloud/vm/UserVmManagerImplTest.java	Adds unit tests for `updateVmExtraConfig` and config toggling helper.
engine/schema/src/test/java/com/cloud/vm/dao/VMInstanceDetailsDaoImplTest.java	Adds unit tests for `removeDetailsWithPrefix`.

💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.

Copilot · 2026-01-28T07:23:19Z

ui/src/views/compute/EditVM.vue

        if (values.extraconfig && values.extraconfig.length > 0) {
          params.extraconfig = encodeURIComponent(values.extraconfig)


In the UI, whitespace-only values for extraconfig are treated as “present” (length > 0), so the request sends extraconfig instead of cleanupextraconfig. On the server side StringUtils.isNotBlank treats whitespace as blank, so this results in no update and the existing extraconfig is not cleaned. Consider trimming before the length check (or using a blank check) so clearing via whitespace triggers cleanup as expected.

Suggested change

if (values.extraconfig && values.extraconfig.length > 0) {

params.extraconfig = encodeURIComponent(values.extraconfig)

const extraConfig = typeof values.extraconfig === 'string' ? values.extraconfig.trim() : values.extraconfig

if (extraConfig && extraConfig.length > 0) {

params.extraconfig = encodeURIComponent(extraConfig)

server/src/main/java/com/cloud/vm/UserVmManagerImpl.java

engine/schema/src/main/java/com/cloud/vm/dao/VMInstanceDetailsDaoImpl.java

blueorangutan · 2026-01-28T07:57:37Z

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

Signed-off-by: Abhishek Kumar <abhishek.mrt22@gmail.com>

shwstppr · 2026-01-28T12:24:04Z

@blueorangutan package

blueorangutan · 2026-01-28T12:26:04Z

@shwstppr 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-28T13:25:24Z

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

DaanHoogland · 2026-01-28T15:36:24Z

@blueorangutan test

blueorangutan · 2026-01-28T15:38:04Z

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

api,server: allow cleaning up vm extraconfig

6bd4f62

Fixes apache#9878 Signed-off-by: Abhishek Kumar <abhishek.mrt22@gmail.com>

boring-cyborg bot added the component:api label Nov 4, 2025

shwstppr added 2 commits December 1, 2025 11:58

Merge remote-tracking branch 'apache/main' into add-cleanupextraconfi…

7856a37

…g-updatevm

ui change

3793688

Signed-off-by: Abhishek Kumar <abhishek.mrt22@gmail.com>

boring-cyborg bot added the component:UI label Dec 1, 2025

shwstppr requested review from DaanHoogland, nvazquez and weizhouapache December 1, 2025 06:46

shwstppr marked this pull request as ready for review December 1, 2025 06:46

shwstppr requested a review from abh1sar December 1, 2025 07:29

DaanHoogland approved these changes Dec 1, 2025

View reviewed changes

DaanHoogland added the status:needs-testing label Dec 1, 2025

abh1sar approved these changes Dec 1, 2025

View reviewed changes

server/src/test/java/com/cloud/vm/UserVmManagerImplTest.java Outdated Show resolved Hide resolved

shwstppr added 2 commits December 9, 2025 15:12

update

b24f8cc

Signed-off-by: Abhishek Kumar <abhishek.mrt22@gmail.com>

change

189f291

sureshanaparti added this to the 4.22.1 milestone Jan 7, 2026

sureshanaparti added this to Apache CloudStack 4.22.1 Jan 7, 2026

sureshanaparti moved this to In Progress in Apache CloudStack 4.22.1 Jan 7, 2026

shwstppr modified the milestones: 4.22.1, 4.23.0 Jan 13, 2026

Merge branch 'main' into add-cleanupextraconfig-updatevm

e1772fe

github-actions bot added the status:has-conflicts label Jan 19, 2026

Merge remote-tracking branch 'apache/main' into add-cleanupextraconfi…

b98a95b

…g-updatevm

github-actions bot removed the status:has-conflicts label Jan 20, 2026

RosiKyu assigned RosiKyu and unassigned RosiKyu Jan 26, 2026

vishesh92 requested review from Copilot and removed request for weizhouapache January 28, 2026 07:13

vishesh92 self-assigned this Jan 28, 2026

Copilot started reviewing on behalf of vishesh92 January 28, 2026 07:13 View session

Copilot AI reviewed Jan 28, 2026

View reviewed changes

handle cleanupExtraConfig separately

c3b6012

Signed-off-by: Abhishek Kumar <abhishek.mrt22@gmail.com>

		if (values.extraconfig && values.extraconfig.length > 0) {
		params.extraconfig = encodeURIComponent(values.extraconfig)

-        if (values.extraconfig && values.extraconfig.length > 0) {
-          params.extraconfig = encodeURIComponent(values.extraconfig)
+        const extraConfig = typeof values.extraconfig === 'string' ? values.extraconfig.trim() : values.extraconfig
+        if (extraConfig && extraConfig.length > 0) {
+          params.extraconfig = encodeURIComponent(extraConfig)

api,server: allow cleaning up vm extraconfig #11974

Are you sure you want to change the base?

api,server: allow cleaning up vm extraconfig #11974

Uh oh!

Conversation

shwstppr commented Nov 4, 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?

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

Uh oh!

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

Uh oh!

Codecov Report

Uh oh!

shwstppr commented Nov 13, 2025

Uh oh!

blueorangutan commented Nov 13, 2025

Uh oh!

blueorangutan commented Nov 13, 2025

Uh oh!

shwstppr commented Dec 1, 2025

Uh oh!

blueorangutan commented Dec 1, 2025

Uh oh!

DaanHoogland left a comment

Choose a reason for hiding this comment

Uh oh!

DaanHoogland Dec 1, 2025

Choose a reason for hiding this comment

Uh oh!

blueorangutan commented Dec 1, 2025

Uh oh!

abh1sar left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

shwstppr commented Dec 9, 2025

Uh oh!

blueorangutan commented Dec 9, 2025

Uh oh!

blueorangutan commented Dec 9, 2025

Uh oh!

rajujith commented Jan 13, 2026

Uh oh!

shwstppr commented Jan 13, 2026

Uh oh!

github-actions bot commented Jan 19, 2026

Uh oh!

vishesh92 commented Jan 28, 2026

Uh oh!

blueorangutan commented Jan 28, 2026

Uh oh!

Copilot AI left a comment

Choose a reason for hiding this comment

Pull request overview

Reviewed changes

Uh oh!

Copilot AI Jan 28, 2026

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

blueorangutan commented Jan 28, 2026

Uh oh!

shwstppr commented Jan 28, 2026

Uh oh!

blueorangutan commented Jan 28, 2026

Uh oh!

blueorangutan commented Jan 28, 2026

Uh oh!

DaanHoogland commented Jan 28, 2026

Uh oh!

blueorangutan commented Jan 28, 2026

Uh oh!

shwstppr commented Nov 4, 2025 •

edited

Loading

codecov bot commented Nov 4, 2025 •

edited

Loading