UI support for extraconfig in deploy and update instance #11719

abh1sar · 2025-09-25T09:38:16Z

Description

This PR fixes #7849

Also fixes a bug in kvm extraconfig #11718

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-09-25T09:47:12Z

Codecov Report

❌ Patch coverage is 11.11111% with 8 lines in your changes missing coverage. Please review.
✅ Project coverage is 16.17%. Comparing base (36cfd76) to head (3d9d2ba).
⚠️ Report is 4 commits behind head on 4.20.

Files with missing lines	Patch %	Lines
.../cloudstack/api/response/CapabilitiesResponse.java	0.00%	3 Missing ⚠️
.../src/main/java/com/cloud/vm/UserVmManagerImpl.java	0.00%	3 Missing ⚠️
...k/api/command/user/config/ListCapabilitiesCmd.java	0.00%	1 Missing ⚠️
...in/java/com/cloud/server/ManagementServerImpl.java	0.00%	1 Missing ⚠️

Additional details and impacted files

@@             Coverage Diff              @@
##               4.20   #11719      +/-   ##
============================================
- Coverage     16.17%   16.17%   -0.01%     
- Complexity    13296    13297       +1     
============================================
  Files          5656     5656              
  Lines        498219   498240      +21     
  Branches      60451    60457       +6     
============================================
+ Hits          80579    80580       +1     
- Misses       408672   408691      +19     
- Partials       8968     8969       +1

Flag	Coverage Δ
uitests	`4.00% <ø> (-0.01%)`	⬇️
unittests	`17.02% <11.11%> (-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.

weizhouapache · 2025-09-25T11:38:44Z

@blueorangutan package

blueorangutan · 2025-09-25T11:40:04Z

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

weizhouapache

code lgtm

added to 4.20.2 milestone

blueorangutan · 2025-09-25T13:27:25Z

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

abh1sar · 2025-09-25T14:47:22Z

@blueorangutan package

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

@abh1sar 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-25T16:11:00Z

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

weizhouapache · 2025-09-25T17:05:40Z

@blueorangutan test

blueorangutan · 2025-09-25T17:08:04Z

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

shwstppr

LGTM - haven't tested

shwstppr · 2025-09-26T06:37:32Z

api/src/main/java/org/apache/cloudstack/api/response/CapabilitiesResponse.java

    private Boolean dynamicScalingEnabled;

+    @SerializedName(ApiConstants.ADDITONAL_CONFIG_ENABLED)
+    @Param(description = "true if additional configurations or extraconfig can be passed to Instances", since = "4.20.2")


Not related to this PR but as some point we should start using a generic Map response or some other means. Adding a new response param for a new global setting value is an unnecessary hassle

shwstppr · 2025-09-26T06:38:37Z

ui/src/views/compute/EditVM.vue

        opts: []
-      }
+      },
+      extraConfigEnabled: this.$store.getters.features.additionalconfigenabled


curious - why a computed variable in DeployVM and a data variable here?

no specific reason. It could have been a data variable in DeployVM as well. Just followed the existing pattern in the file.

blueorangutan · 2025-09-26T09:16:38Z

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

Test	Result	Time (s)	Test File

shwstppr

Tested 4.20.2 env with changes. I could see extraconfig being processed by the host,

2025-09-26 09:15:58,523 DEBUG [kvm.resource.LibvirtComputingResource] (AgentRequest-Handler-1:[]) (logid:) Appending extra configuration data [{extraconfig-1=abc=444, extraconfig-2=xyz=777}] to guest VM [VM {id: "23", name: "i-2-23-VM", uuid: "f6c36574-f999-4ea2-b9b0-3474067b0c0f", type: "User"}] domain XML.

For update VM,

Maybe we should highlight that VM needs to be stop-started or allow extraconfig only for stopped VM. a-alert can be used to show an appropriate message.
Currently, existing extraconfig value is overridden so it would be better if UpdateVM form shows the existing value pre-filled.

@abh1sar

abh1sar · 2025-09-26T12:22:02Z

For update VM,

Maybe we should highlight that VM needs to be stop-started or allow extraconfig only for stopped VM. a-alert can be used to show an appropriate message.

I'll add that @shwstppr

Currently, existing extraconfig value is overridden so it would be better if UpdateVM form shows the existing value pre-filled.

This can be done but is a bit tricky as multiple extraconfigs are stored and shown as separate keys. e.g,

    "details": {                                     
      "Message.ReservedCapacityFreed.Flag": "false",
      "cpuOvercommitRatio": "2.0",
      "extraconfig-1": "<memoryBacking>\n    <locked/>\n</memoryBacking>",
      "extraconfig-2": "<memoryBacking>\n    <nosharepages/>\n</memoryBacking>"
    },

I would have to combine these into a single string in UI

<memoryBacking>
    <locked/>
</memoryBacking>

<memoryBacking>
    <nosharepages/>
</memoryBacking>

One more thing is that the separator is different in VMware/XenServer and KVM
Vmware/Xen : Single new line (String[] extraConfigs = decodedUrl.split("\\r?\\n");
KVM : Double new lines ( String[] extraConfigs = decodedUrl.split("\n\n");

I am thinking that for displaying, I can insert two double lines between extra config by default. And modify the VMware/Xen separator to handle multiple newlines split.("\\r?\\n+)". That will take care of both cases

This would need testing on all 3 hypervisors

abh1sar · 2025-09-29T11:46:35Z

@blueorangutan package

abh1sar · 2025-09-29T11:47:51Z

Maybe we should highlight that VM needs to be stop-started or allow extraconfig only for stopped VM. a-alert can be used to show an appropriate message.

@shwstppr the form already contains a warning at the top

blueorangutan · 2025-09-29T11:48:03Z

@abh1sar 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-29T13:09:35Z

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

weizhouapache · 2025-09-29T14:12:30Z

@blueorangutan test

weizhouapache

code lgtm

shwstppr

LGTM. Existing config shown in the Update VM form. Tested with a KVM env

weizhouapache · 2025-09-30T07:20:30Z

thanks @shwstppr for the testing

merging

abh1sar added 3 commits September 25, 2025 15:03

UI support for extraconfig in deploy and update instance

6e47c4c

Fix kvm multiple extraconfig bug

6f35254

getAPI -> api

3a6a7a5

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

abh1sar changed the title ~~Econfig~~ UI support for extraconfig in deploy and update instance Sep 25, 2025

This was linked to issues Sep 25, 2025

UI: deploy and update vm instances with extraconfig #7849

Closed

Multiple extra config values cannot be set on KVM #11718

Closed

weizhouapache added this to the 4.20.2 milestone Sep 25, 2025

weizhouapache approved these changes Sep 25, 2025

View reviewed changes

add additionalconfigenabled to listCapabilities

4d2ef00

boring-cyborg bot added component:api component:management-server labels Sep 25, 2025

abh1sar requested a review from weizhouapache September 25, 2025 14:43

shwstppr approved these changes Sep 26, 2025

View reviewed changes

shwstppr reviewed Sep 26, 2025

View reviewed changes

pre-populate editvm.vue with extraconfig

3d9d2ba

abh1sar requested a review from shwstppr September 29, 2025 11:48

weizhouapache approved these changes Sep 29, 2025

View reviewed changes

shwstppr approved these changes Sep 30, 2025

View reviewed changes

weizhouapache merged commit 70af55e into apache:4.20 Sep 30, 2025
41 of 43 checks passed

This was referenced Sep 30, 2025

Multiple extra config values cannot be set on KVM #11718

Closed

UI: deploy and update vm instances with extraconfig #7849

Closed

abh1sar deleted the econfig branch September 30, 2025 10:32

UI support for extraconfig in deploy and update instance #11719

UI support for extraconfig in deploy and update instance #11719

Uh oh!

Conversation

abh1sar commented Sep 25, 2025

Description

Types of changes

Feature/Enhancement Scale or Bug Severity

Feature/Enhancement Scale

Bug Severity

Screenshots (if appropriate):

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

Uh oh!

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

Uh oh!

Codecov Report

Uh oh!

weizhouapache commented Sep 25, 2025

Uh oh!

blueorangutan commented Sep 25, 2025

Uh oh!

weizhouapache left a comment

Choose a reason for hiding this comment

Uh oh!

blueorangutan commented Sep 25, 2025

Uh oh!

abh1sar commented Sep 25, 2025

Uh oh!

blueorangutan commented Sep 25, 2025

Uh oh!

blueorangutan commented Sep 25, 2025

Uh oh!

weizhouapache commented Sep 25, 2025

Uh oh!

blueorangutan commented Sep 25, 2025

Uh oh!

shwstppr left a comment

Choose a reason for hiding this comment

Uh oh!

shwstppr Sep 26, 2025

Choose a reason for hiding this comment

Uh oh!

abh1sar Sep 26, 2025

Choose a reason for hiding this comment

Uh oh!

shwstppr Sep 26, 2025

Choose a reason for hiding this comment

Uh oh!

abh1sar Sep 26, 2025

Choose a reason for hiding this comment

Uh oh!

blueorangutan commented Sep 26, 2025

Uh oh!

shwstppr left a comment

Choose a reason for hiding this comment

Uh oh!

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

Uh oh!

Uh oh!

abh1sar commented Sep 29, 2025

Uh oh!

abh1sar commented Sep 29, 2025

Uh oh!

blueorangutan commented Sep 29, 2025

Uh oh!

blueorangutan commented Sep 29, 2025

Uh oh!

weizhouapache commented Sep 29, 2025

Uh oh!

weizhouapache left a comment

Choose a reason for hiding this comment

Uh oh!

shwstppr left a comment • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Choose a reason for hiding this comment

Uh oh!

weizhouapache commented Sep 30, 2025

Uh oh!

Uh oh!

Reviewers

codecov bot commented Sep 25, 2025 •

edited

Loading

abh1sar commented Sep 26, 2025 •

edited

Loading

shwstppr left a comment •

edited

Loading