api,server,ui: allow cleaning up external details for host and serviceoffering #11548
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
offering Adds parameter - 'cleanupexternaldetails' for updateHost and updateServiceOffering API to allow cleaning up external details. Signed-off-by: Abhishek Kumar <abhishek.mrt22@gmail.com>
Codecov Report❌ Patch coverage is Additional details and impacted files@@ Coverage Diff @@
## main #11548 +/- ##
=========================================
Coverage 17.50% 17.50%
- Complexity 15427 15431 +4
=========================================
Files 5894 5894
Lines 526847 526879 +32
Branches 64335 64342 +7
=========================================
+ Hits 92234 92246 +12
- Misses 424236 424256 +20
Partials 10377 10377
Flags with carried forward coverage won't be shown. Click here to find out more. ☔ View full report in Codecov by Sentry. 🚀 New features to boost your workflow:
|
Contributor
Author
|
@blueorangutan package |
|
@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. |
|
Packaging result [SF]: ✔️ el8 ✔️ el9 ✔️ debian ✔️ suse15. SL-JID 14804 |
Contributor
|
@shwstppr is it better to handle this using externalDetails param itself somehow ? may be we need to tweak some code while handling empty map! |
Contributor
Author
@harikrishna-patnala no, I don't think so. With a map parameter, it is not possible to ascertain if an empty map is because the user wanted to clean up the existing details or wants them to be unchanged. |
Contributor
Author
|
@blueorangutan package |
|
@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. |
|
Packaging result [SF]: ✔️ el8 ✔️ el9 ✔️ el10 ✔️ debian ✔️ suse15. SL-JID 14889 |
github-project-automation
bot
moved this from In Progress
to Done
in Apache CloudStack 4.22.0
Signed-off-by: Abhishek Kumar <abhishek.mrt22@gmail.com>
Contributor
Author
|
@blueorangutan package |
|
@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. |
|
Packaging result [SF]: ✔️ el8 ✔️ el9 ✔️ el10 ✔️ debian ✔️ suse15. SL-JID 15247 |
RosiKyu
approved these changes
Oct 13, 2025
Collaborator
RosiKyu
left a comment
RosiKyu
left a comment
There was a problem hiding this comment.
LGTM
External details functionality was thoroughly verified for Hosts and Service Offerings.
- Add external details: Successfully added and reflected in API and UI with the External: prefix.
- Cleanup: cleanupexternaldetails=true consistently removes all external details without impacting other fields.
- Re-add after cleanup: Works as expected.
- Precedence test: When both externaldetails and cleanupexternaldetails are passed, cleanup correctly takes precedence.
- Idempotency: Running cleanup on already clean entities causes no errors or side effects.
- Persistence: No data persisted in DB for either entity type (in-memory only), which matches current implementation scope.
- UI behavior: Reflects API state correctly before and after cleanup.
Detailed Test Results
Host External Details Cleanup Testing Results
Step 1: Add external details
- Added 2 external details (abc, testKey) using externaldetails param.
Expected Result: External details should be stored with External: prefix.
Actual Result: External details successfully added to the host. Non-external fields unaffected.
(localcloud) 🐱 > update host id=a2eac7e2-4b45-4fe3-b52c-d6fd22ecd4fc externaldetails[0].abc=123 externaldetails[0].testKey=testValue
{
"host": {
"arch": "x86_64",
"capabilities": "hvm,snapshot",
"clusterid": "e4780f28-dc1a-49bc-90dc-1b67f5bee503",
"clustername": "p1-c1",
"clustertype": "CloudManaged",
"cpuallocated": "0.00%",
"cpuallocatedpercentage": "0.00%",
"cpuallocatedvalue": 0,
"cpuallocatedwithoverprovisioning": "0.00%",
"cpuloadaverage": 0,
"cpunumber": 3,
"cpusockets": 3,
"cpuspeed": 2100,
"cpuused": "0.62%",
"cpuwithoverprovisioning": "12600",
"created": "2025-10-13T12:05:27+0000",
"details": {
"External:abc": "123",
"External:testKey": "testValue",
"Host.OS": "Red Hat Enterprise Linux",
"Host.OS.Kernel.Version": "5.4.17-2136.309.5.1.el8uek.x86_64",
"Host.OS.Version": "8.6",
"com.cloud.network.Networks.RouterPrivateIpStrategy": "HostLocal",
"host.uefi.enable": "true",
"secured": "true"
},
"encryptionsupported": true,
"events": "AgentDisconnected; HostDown; ManagementServerDown; StartAgentRebalance; PingTimeout; AgentConnected; Remove; Ping; ShutdownRequested",
"hahost": false,
"hasannotations": false,
"hostha": {
"haenable": false,
"hastate": "Disabled"
},
"hypervisor": "KVM",
"id": "a2eac7e2-4b45-4fe3-b52c-d6fd22ecd4fc",
"instanceconversionsupported": false,
"ipaddress": "10.0.34.96",
"islocalstorageactive": false,
"lastpinged": "1970-01-20T21:31:38+0000",
"managementserverid": "c8acac1d-29c4-4dbf-a306-18a6cd277db3",
"managementservername": "ref-trl-9667-k-mol8-rositsa-kyuchukova-mgmt1.sofia.shapeblue.com",
"memoryallocated": 0,
"memoryallocatedbytes": 0,
"memoryallocatedpercentage": "0.00%",
"memorytotal": 7259144192,
"memoryused": 647360512,
"memorywithoverprovisioning": "7259144192",
"name": "ref-trl-9667-k-Mol8-rositsa-kyuchukova-kvm1",
"networkkbsread": 6531,
"networkkbswrite": 0,
"outofbandmanagement": {
"enabled": false,
"powerstate": "Disabled"
},
"podid": "8c8d6db8-572b-4cb4-9407-b71942c757ac",
"podname": "Pod1",
"resourcestate": "Enabled",
"state": "Up",
"type": "Routing",
"ueficapability": true,
"version": "4.22.0.0-SNAPSHOT",
"zoneid": "f3b9301a-d74e-4794-a887-98e0eb756ce1",
"zonename": "ref-trl-9667-k-Mol8-rositsa-kyuchukova"
}
}
(localcloud) 🐱 >
Step 2: Cleanup external details
- Removed all external details using cleanupexternaldetails=true.
Expected Result: Only External: keys removed, others remain.
Actual Result: All external keys were removed while internal details remained intact.
(localcloud) 🐱 > update host id=a2eac7e2-4b45-4fe3-b52c-d6fd22ecd4fc cleanupexternaldetails=true
{
"host": {
"arch": "x86_64",
"capabilities": "hvm,snapshot",
"clusterid": "e4780f28-dc1a-49bc-90dc-1b67f5bee503",
"clustername": "p1-c1",
"clustertype": "CloudManaged",
"cpuallocated": "0.00%",
"cpuallocatedpercentage": "0.00%",
"cpuallocatedvalue": 0,
"cpuallocatedwithoverprovisioning": "0.00%",
"cpuloadaverage": 0,
"cpunumber": 3,
"cpusockets": 3,
"cpuspeed": 2100,
"cpuused": "0.62%",
"cpuwithoverprovisioning": "12600",
"created": "2025-10-13T12:05:27+0000",
"details": {
"Host.OS": "Red Hat Enterprise Linux",
"Host.OS.Kernel.Version": "5.4.17-2136.309.5.1.el8uek.x86_64",
"Host.OS.Version": "8.6",
"com.cloud.network.Networks.RouterPrivateIpStrategy": "HostLocal",
"host.uefi.enable": "true",
"secured": "true"
},
"encryptionsupported": true,
"events": "AgentDisconnected; HostDown; ManagementServerDown; StartAgentRebalance; PingTimeout; AgentConnected; Remove; Ping; ShutdownRequested",
"hahost": false,
"hasannotations": false,
"hostha": {
"haenable": false,
"hastate": "Disabled"
},
"hypervisor": "KVM",
"id": "a2eac7e2-4b45-4fe3-b52c-d6fd22ecd4fc",
"instanceconversionsupported": false,
"ipaddress": "10.0.34.96",
"islocalstorageactive": false,
"lastpinged": "1970-01-20T21:31:38+0000",
"managementserverid": "c8acac1d-29c4-4dbf-a306-18a6cd277db3",
"managementservername": "ref-trl-9667-k-mol8-rositsa-kyuchukova-mgmt1.sofia.shapeblue.com",
"memoryallocated": 0,
"memoryallocatedbytes": 0,
"memoryallocatedpercentage": "0.00%",
"memorytotal": 7259144192,
"memoryused": 647360512,
"memorywithoverprovisioning": "7259144192",
"name": "ref-trl-9667-k-Mol8-rositsa-kyuchukova-kvm1",
"networkkbsread": 6531,
"networkkbswrite": 0,
"outofbandmanagement": {
"enabled": false,
"powerstate": "Disabled"
},
"podid": "8c8d6db8-572b-4cb4-9407-b71942c757ac",
"podname": "Pod1",
"resourcestate": "Enabled",
"state": "Up",
"type": "Routing",
"ueficapability": true,
"version": "4.22.0.0-SNAPSHOT",
"zoneid": "f3b9301a-d74e-4794-a887-98e0eb756ce1",
"zonename": "ref-trl-9667-k-Mol8-rositsa-kyuchukova"
}
}
Step 3: Re-add external details
- Re-added abc and testKey to confirm re-adding works after cleanup.
Expected Result: External details reappear.
Actual Result: External details successfully re-added after cleanup..
(localcloud) 🐱 > update host id=a2eac7e2-4b45-4fe3-b52c-d6fd22ecd4fc externaldetails[0].abc=123 externaldetails[0].testKey=testValue
{
"host": {
"arch": "x86_64",
"capabilities": "hvm,snapshot",
"clusterid": "e4780f28-dc1a-49bc-90dc-1b67f5bee503",
"clustername": "p1-c1",
"clustertype": "CloudManaged",
"cpuallocated": "0.00%",
"cpuallocatedpercentage": "0.00%",
"cpuallocatedvalue": 0,
"cpuallocatedwithoverprovisioning": "0.00%",
"cpuloadaverage": 0,
"cpunumber": 3,
"cpusockets": 3,
"cpuspeed": 2100,
"cpuused": "0.59%",
"cpuwithoverprovisioning": "12600",
"created": "2025-10-13T12:05:27+0000",
"details": {
"External:abc": "123",
"External:testKey": "testValue",
"Host.OS": "Red Hat Enterprise Linux",
"Host.OS.Kernel.Version": "5.4.17-2136.309.5.1.el8uek.x86_64",
"Host.OS.Version": "8.6",
"com.cloud.network.Networks.RouterPrivateIpStrategy": "HostLocal",
"host.uefi.enable": "true",
"secured": "true"
},
"encryptionsupported": true,
"events": "AgentDisconnected; HostDown; ManagementServerDown; StartAgentRebalance; PingTimeout; AgentConnected; Remove; Ping; ShutdownRequested",
"hahost": false,
"hasannotations": false,
"hostha": {
"haenable": false,
"hastate": "Disabled"
},
"hypervisor": "KVM",
"id": "a2eac7e2-4b45-4fe3-b52c-d6fd22ecd4fc",
"instanceconversionsupported": false,
"ipaddress": "10.0.34.96",
"islocalstorageactive": false,
"lastpinged": "1970-01-20T21:31:38+0000",
"managementserverid": "c8acac1d-29c4-4dbf-a306-18a6cd277db3",
"managementservername": "ref-trl-9667-k-mol8-rositsa-kyuchukova-mgmt1.sofia.shapeblue.com",
"memoryallocated": 0,
"memoryallocatedbytes": 0,
"memoryallocatedpercentage": "0.00%",
"memorytotal": 7259144192,
"memoryused": 649945088,
"memorywithoverprovisioning": "7259144192",
"name": "ref-trl-9667-k-Mol8-rositsa-kyuchukova-kvm1",
"networkkbsread": 6643,
"networkkbswrite": 0,
"outofbandmanagement": {
"enabled": false,
"powerstate": "Disabled"
},
"podid": "8c8d6db8-572b-4cb4-9407-b71942c757ac",
"podname": "Pod1",
"resourcestate": "Enabled",
"state": "Up",
"type": "Routing",
"ueficapability": true,
"version": "4.22.0.0-SNAPSHOT",
"zoneid": "f3b9301a-d74e-4794-a887-98e0eb756ce1",
"zonename": "ref-trl-9667-k-Mol8-rositsa-kyuchukova"
}
}
(localcloud) 🐱 >
Step 4: Cleanup precedence (externaldetails + cleanup)
- Passed both externaldetails and cleanupexternaldetails in the same request.
Expected Result: Cleanup should win, leaving no External: keys.
Actual Result: Cleanup takes precedence - no external keys remain, proving correct API behavior.
(localcloud) 🐱 > update host id=a2eac7e2-4b45-4fe3-b52c-d6fd22ecd4fc externaldetails[0].xyz=SHOULD_BE_REMOVED cleanupexternaldetails=true
{
"host": {
"arch": "x86_64",
"capabilities": "hvm,snapshot",
"clusterid": "e4780f28-dc1a-49bc-90dc-1b67f5bee503",
"clustername": "p1-c1",
"clustertype": "CloudManaged",
"cpuallocated": "0.00%",
"cpuallocatedpercentage": "0.00%",
"cpuallocatedvalue": 0,
"cpuallocatedwithoverprovisioning": "0.00%",
"cpuloadaverage": 0,
"cpunumber": 3,
"cpusockets": 3,
"cpuspeed": 2100,
"cpuused": "0.59%",
"cpuwithoverprovisioning": "12600",
"created": "2025-10-13T12:05:27+0000",
"details": {
"Host.OS": "Red Hat Enterprise Linux",
"Host.OS.Kernel.Version": "5.4.17-2136.309.5.1.el8uek.x86_64",
"Host.OS.Version": "8.6",
"com.cloud.network.Networks.RouterPrivateIpStrategy": "HostLocal",
"host.uefi.enable": "true",
"secured": "true"
},
"encryptionsupported": true,
"events": "AgentDisconnected; HostDown; ManagementServerDown; StartAgentRebalance; PingTimeout; AgentConnected; Remove; Ping; ShutdownRequested",
"hahost": false,
"hasannotations": false,
"hostha": {
"haenable": false,
"hastate": "Disabled"
},
"hypervisor": "KVM",
"id": "a2eac7e2-4b45-4fe3-b52c-d6fd22ecd4fc",
"instanceconversionsupported": false,
"ipaddress": "10.0.34.96",
"islocalstorageactive": false,
"lastpinged": "1970-01-20T21:31:38+0000",
"managementserverid": "c8acac1d-29c4-4dbf-a306-18a6cd277db3",
"managementservername": "ref-trl-9667-k-mol8-rositsa-kyuchukova-mgmt1.sofia.shapeblue.com",
"memoryallocated": 0,
"memoryallocatedbytes": 0,
"memoryallocatedpercentage": "0.00%",
"memorytotal": 7259144192,
"memoryused": 649945088,
"memorywithoverprovisioning": "7259144192",
"name": "ref-trl-9667-k-Mol8-rositsa-kyuchukova-kvm1",
"networkkbsread": 6643,
"networkkbswrite": 0,
"outofbandmanagement": {
"enabled": false,
"powerstate": "Disabled"
},
"podid": "8c8d6db8-572b-4cb4-9407-b71942c757ac",
"podname": "Pod1",
"resourcestate": "Enabled",
"state": "Up",
"type": "Routing",
"ueficapability": true,
"version": "4.22.0.0-SNAPSHOT",
"zoneid": "f3b9301a-d74e-4794-a887-98e0eb756ce1",
"zonename": "ref-trl-9667-k-Mol8-rositsa-kyuchukova"
}
}
(localcloud) 🐱 >
Step 5: Cleanup on an already clean host
- Run cleanup again when there are no External: details.
Expected Result:
- No changes in output.
- No errors.
- Internal details remain intact.
Actual Result: As expected - the response contained only non-external fields (e.g. Host.OS, host.uefi.enable, secured), proving cleanup is idempotent.
(localcloud) 🐱 > update host id=a2eac7e2-4b45-4fe3-b52c-d6fd22ecd4fc cleanupexternaldetails=true
{
"host": {
"arch": "x86_64",
"capabilities": "hvm,snapshot",
"clusterid": "e4780f28-dc1a-49bc-90dc-1b67f5bee503",
"clustername": "p1-c1",
"clustertype": "CloudManaged",
"cpuallocated": "0.00%",
"cpuallocatedpercentage": "0.00%",
"cpuallocatedvalue": 0,
"cpuallocatedwithoverprovisioning": "0.00%",
"cpuloadaverage": 0,
"cpunumber": 3,
"cpusockets": 3,
"cpuspeed": 2100,
"cpuused": "0.63%",
"cpuwithoverprovisioning": "12600",
"created": "2025-10-13T12:05:27+0000",
"details": {
"Host.OS": "Red Hat Enterprise Linux",
"Host.OS.Kernel.Version": "5.4.17-2136.309.5.1.el8uek.x86_64",
"Host.OS.Version": "8.6",
"com.cloud.network.Networks.RouterPrivateIpStrategy": "HostLocal",
"host.uefi.enable": "true",
"secured": "true"
},
"encryptionsupported": true,
"events": "AgentDisconnected; HostDown; ManagementServerDown; StartAgentRebalance; PingTimeout; AgentConnected; Remove; Ping; ShutdownRequested",
"hahost": false,
"hasannotations": false,
"hostha": {
"haenable": false,
"hastate": "Disabled"
},
"hypervisor": "KVM",
"id": "a2eac7e2-4b45-4fe3-b52c-d6fd22ecd4fc",
"instanceconversionsupported": false,
"ipaddress": "10.0.34.96",
"islocalstorageactive": false,
"lastpinged": "1970-01-20T21:31:38+0000",
"managementserverid": "c8acac1d-29c4-4dbf-a306-18a6cd277db3",
"managementservername": "ref-trl-9667-k-mol8-rositsa-kyuchukova-mgmt1.sofia.shapeblue.com",
"memoryallocated": 0,
"memoryallocatedbytes": 0,
"memoryallocatedpercentage": "0.00%",
"memorytotal": 7259144192,
"memoryused": 654086144,
"memorywithoverprovisioning": "7259144192",
"name": "ref-trl-9667-k-Mol8-rositsa-kyuchukova-kvm1",
"networkkbsread": 8148,
"networkkbswrite": 0,
"outofbandmanagement": {
"enabled": false,
"powerstate": "Disabled"
},
"podid": "8c8d6db8-572b-4cb4-9407-b71942c757ac",
"podname": "Pod1",
"resourcestate": "Enabled",
"state": "Up",
"type": "Routing",
"ueficapability": true,
"version": "4.22.0.0-SNAPSHOT",
"zoneid": "f3b9301a-d74e-4794-a887-98e0eb756ce1",
"zonename": "ref-trl-9667-k-Mol8-rositsa-kyuchukova"
}
}
Step 6: Add non-external details (e.g. host tags)
- Update another field while keeping external details untouched.
Expected Result:
- External: keys remain unchanged (or none if already cleaned).
- Only host tags are updated.
- Confirms cleanup doesn’t interfere with unrelated updates.
Actual Result Host tags were successfully updated (explicithosttags and hosttags now show mytag), and external details remained untouched (none present, as expected). Updating unrelated fields works normally and does not interact with the external details cleanup mechanism.
(localcloud) 🐱 > update host id=a2eac7e2-4b45-4fe3-b52c-d6fd22ecd4fc hosttags=mytag
{
"host": {
"arch": "x86_64",
"capabilities": "hvm,snapshot",
"clusterid": "e4780f28-dc1a-49bc-90dc-1b67f5bee503",
"clustername": "p1-c1",
"clustertype": "CloudManaged",
"cpuallocated": "0.00%",
"cpuallocatedpercentage": "0.00%",
"cpuallocatedvalue": 0,
"cpuallocatedwithoverprovisioning": "0.00%",
"cpuloadaverage": 0,
"cpunumber": 3,
"cpusockets": 3,
"cpuspeed": 2100,
"cpuused": "0.59%",
"cpuwithoverprovisioning": "12600",
"created": "2025-10-13T12:05:27+0000",
"details": {
"Host.OS": "Red Hat Enterprise Linux",
"Host.OS.Kernel.Version": "5.4.17-2136.309.5.1.el8uek.x86_64",
"Host.OS.Version": "8.6",
"com.cloud.network.Networks.RouterPrivateIpStrategy": "HostLocal",
"host.uefi.enable": "true",
"secured": "true"
},
"encryptionsupported": true,
"events": "AgentDisconnected; HostDown; ManagementServerDown; StartAgentRebalance; PingTimeout; AgentConnected; Remove; Ping; ShutdownRequested",
"explicithosttags": "mytag",
"hahost": false,
"hasannotations": false,
"hostha": {
"haenable": false,
"hastate": "Disabled"
},
"hosttags": "mytag",
"hypervisor": "KVM",
"id": "a2eac7e2-4b45-4fe3-b52c-d6fd22ecd4fc",
"instanceconversionsupported": false,
"ipaddress": "10.0.34.96",
"islocalstorageactive": false,
"istagarule": false,
"lastpinged": "1970-01-20T21:31:38+0000",
"managementserverid": "c8acac1d-29c4-4dbf-a306-18a6cd277db3",
"managementservername": "ref-trl-9667-k-mol8-rositsa-kyuchukova-mgmt1.sofia.shapeblue.com",
"memoryallocated": 0,
"memoryallocatedbytes": 0,
"memoryallocatedpercentage": "0.00%",
"memorytotal": 7259144192,
"memoryused": 655081472,
"memorywithoverprovisioning": "7259144192",
"name": "ref-trl-9667-k-Mol8-rositsa-kyuchukova-kvm1",
"networkkbsread": 8797,
"networkkbswrite": 0,
"outofbandmanagement": {
"enabled": false,
"powerstate": "Disabled"
},
"podid": "8c8d6db8-572b-4cb4-9407-b71942c757ac",
"podname": "Pod1",
"resourcestate": "Enabled",
"state": "Up",
"type": "Routing",
"ueficapability": true,
"version": "4.22.0.0-SNAPSHOT",
"zoneid": "f3b9301a-d74e-4794-a887-98e0eb756ce1",
"zonename": "ref-trl-9667-k-Mol8-rositsa-kyuchukova"
}
}
Step 7: UI Check
- Update external details -> Check UI -> cleanup external details -> Check UI
Before cleanup
After cleanup
Service Offering External Details Cleanup Testing Results
Step 1: Add ext details to Service offering
Expected Result External details are added
Actual Result: External details successfully added and returned in the API response and present in the UI
(localcloud) 🐱 > update serviceoffering id=67aee29b-fab5-484c-a2cd-8b66b0383a9f externaldetails[0].abc=123 externaldetails[0].xyz=456
{
"serviceoffering": {
"cpunumber": 1,
"cpuspeed": 500,
"created": "2025-10-13T11:44:00+0000",
"defaultuse": false,
"diskofferingdisplaytext": "Small Instance",
"diskofferingid": "d0094cbf-673c-4945-8c83-2a3f828cba8b",
"diskofferingname": "Small Instance",
"diskofferingstrictness": false,
"displaytext": "Small Instance",
"dynamicscalingenabled": true,
"encryptroot": false,
"hasannotations": false,
"id": "67aee29b-fab5-484c-a2cd-8b66b0383a9f",
"iscustomized": false,
"issystem": false,
"isvolatile": false,
"limitcpuuse": false,
"memory": 512,
"name": "Small Instance",
"offerha": false,
"provisioningtype": "thin",
"rootdisksize": 0,
"serviceofferingdetails": {
"External:abc": "123",
"External:xyz": "456"
},
"state": "Active",
"storagetype": "shared"
}
}
Step 2: Update One External Detail (No Cleanup)
Expected Result:
- External:abc remains unchanged.
- External:xyz updates to NEWVALUE.
Actual Result Same as expected
(localcloud) 🐱 > update serviceoffering id=67aee29b-fab5-484c-a2cd-8b66b0383a9f externaldetails[0].xyz=NEWVALUE
{
"serviceoffering": {
"cpunumber": 1,
"cpuspeed": 500,
"created": "2025-10-13T11:44:00+0000",
"defaultuse": false,
"diskofferingdisplaytext": "Small Instance",
"diskofferingid": "d0094cbf-673c-4945-8c83-2a3f828cba8b",
"diskofferingname": "Small Instance",
"diskofferingstrictness": false,
"displaytext": "Small Instance",
"dynamicscalingenabled": true,
"encryptroot": false,
"hasannotations": false,
"id": "67aee29b-fab5-484c-a2cd-8b66b0383a9f",
"iscustomized": false,
"issystem": false,
"isvolatile": false,
"limitcpuuse": false,
"memory": 512,
"name": "Small Instance",
"offerha": false,
"provisioningtype": "thin",
"rootdisksize": 0,
"serviceofferingdetails": {
"External:xyz": "NEWVALUE"
},
"state": "Active",
"storagetype": "shared"
}
}
Step 3: Cleanup External Details
Expected Result:
- All external keys should be removed from the response.
- serviceofferingdetails should no longer contain any External: keys.
Actual Restul:
- cleanupexternaldetails=true removed all previously set external keys from the API response.
- UI shows only the standard service offering properties (as in your screenshot).
(localcloud) 🐱 > update serviceoffering id=67aee29b-fab5-484c-a2cd-8b66b0383a9f cleanupexternaldetails=true
{
"serviceoffering": {
"cpunumber": 1,
"cpuspeed": 500,
"created": "2025-10-13T11:44:00+0000",
"defaultuse": false,
"diskofferingdisplaytext": "Small Instance",
"diskofferingid": "d0094cbf-673c-4945-8c83-2a3f828cba8b",
"diskofferingname": "Small Instance",
"diskofferingstrictness": false,
"displaytext": "Small Instance",
"dynamicscalingenabled": true,
"encryptroot": false,
"hasannotations": false,
"id": "67aee29b-fab5-484c-a2cd-8b66b0383a9f",
"iscustomized": false,
"issystem": false,
"isvolatile": false,
"limitcpuuse": false,
"memory": 512,
"name": "Small Instance",
"offerha": false,
"provisioningtype": "thin",
"rootdisksize": 0,
"state": "Active",
"storagetype": "shared"
}
}
Step 4: Precedence Test
Expected Result:
- Cleanup wins over externaldetails in the same request.
- serviceofferingdetails should remain empty.
- UI shows no external details.
(localcloud) 🐱 > update serviceoffering id=67aee29b-fab5-484c-a2cd-8b66b0383a9f externaldetails[0].xyz=SHOULD_BE_REMOVED cleanupexternaldetails=true
{
"serviceoffering": {
"cpunumber": 1,
"cpuspeed": 500,
"created": "2025-10-13T11:44:00+0000",
"defaultuse": false,
"diskofferingdisplaytext": "Small Instance",
"diskofferingid": "d0094cbf-673c-4945-8c83-2a3f828cba8b",
"diskofferingname": "Small Instance",
"diskofferingstrictness": false,
"displaytext": "Small Instance",
"dynamicscalingenabled": true,
"encryptroot": false,
"hasannotations": false,
"id": "67aee29b-fab5-484c-a2cd-8b66b0383a9f",
"iscustomized": false,
"issystem": false,
"isvolatile": false,
"limitcpuuse": false,
"memory": 512,
"name": "Small Instance",
"offerha": false,
"provisioningtype": "thin",
"rootdisksize": 0,
"state": "Active",
"storagetype": "shared"
}
}
(localcloud) 🐱 >
Contributor
Author
|
Thanks alot @rosi-shapeblue for exhaustive tests |
github-project-automation
bot
moved this from In Progress
to Done
in Apache CloudStack 4.22.0
dhslove
pushed a commit
to ablecloud-team/ablestack-cloud
that referenced
this pull request
Oct 17, 2025
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
5 participants
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Description
Adds parameter - 'cleanupexternaldetails' for updateHost and updateServiceOffering API to allow cleaning up external details.
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?