api/server: support deploy-as-is template as VNF template #12499

weizhouapache · 2026-01-22T07:49:37Z

Description

This PR fixes #12186

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?

weizhouapache · 2026-01-22T07:50:05Z

@blueorangutan package

blueorangutan · 2026-01-22T07:50:35Z

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

codecov · 2026-01-22T07:57:57Z

Codecov Report

✅ All modified and coverable lines are covered by tests.
✅ Project coverage is 4.03%. Comparing base (cd5bb09) to head (976b969).
⚠️ Report is 4 commits behind head on 4.20.

❗ There is a different number of reports uploaded between BASE (cd5bb09) and HEAD (976b969). Click for more details.

HEAD has 1 upload less than BASE

Flag BASE (cd5bb09) HEAD (976b969)

unittests 1 0

Additional details and impacted files

@@              Coverage Diff              @@
##               4.20   #12499       +/-   ##
=============================================
- Coverage     17.10%    4.03%   -13.08%     
=============================================
  Files          5255      402     -4853     
  Lines        466415    32721   -433694     
  Branches      54746     5832    -48914     
=============================================
- Hits          79763     1319    -78444     
+ Misses       377768    31247   -346521     
+ Partials       8884      155     -8729

Flag	Coverage Δ
uitests	`4.03% <ø> (?)`
unittests	`?`

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

clgtm, one (dumb luser) question .

DaanHoogland · 2026-01-22T07:52:50Z

api/src/main/java/org/apache/cloudstack/storage/template/VnfTemplateUtils.java

+            if (registerCmd.isDeployAsIs() && CollectionUtils.isNotEmpty(registerCmd.getVnfNics())) {
+                throw new InvalidParameterValueException("VNF Template cannot be registered with VNF nics as Template settings are read from OVA.");
+            }


Do we want this always to be true? I could imagine a VNF getting a default gateway… Probably my lack of knowledge. I hope this is in the documentation.

Suggested change

if (registerCmd.isDeployAsIs() && CollectionUtils.isNotEmpty(registerCmd.getVnfNics())) {

throw new InvalidParameterValueException("VNF Template cannot be registered with VNF nics as Template settings are read from OVA.");

}

if (registerCmd.isDeployAsIs() && CollectionUtils.isNotEmpty(registerCmd.getVnfNics())) {

throw new InvalidParameterValueException("VNF nics cannot be specified when register a deploy-as-is Template. Please wait until Template settings are read from OVA.");

}

is it clear now ? @DaanHoogland

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

Copilot

Pull request overview

This PR adds support for deploying VNF appliances using deploy-as-is templates (OVA files) by allowing the VNF template functionality to work with templates that have network configurations already defined in the OVA. Previously, deploying such templates failed with "VNF nics list is empty" error.

Changes:

Added conditional validation logic to handle both regular VNF templates (using networkIds list) and deploy-as-is VNF templates (using vmNetworkMap)
Modified UI to disable network selection when deploy-as-is template networks are pre-configured
Added validation to prevent registering/updating VNF nics on deploy-as-is templates since settings are read from the OVA

Reviewed changes

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

Show a summary per file

File	Description
ui/src/views/compute/wizard/VnfNicsSelection.vue	Adds `templateNics` prop and disables network selection for deploy-as-is templates
ui/src/views/compute/DeployVnfAppliance.vue	Passes `templateNics` to VnfNicsSelection component and updates validation logic to handle deploy-as-is template networks
api/src/main/java/org/apache/cloudstack/storage/template/VnfTemplateManager.java	Adds new interface method `validateVnfApplianceNetworksMap` for deploy-as-is template validation
server/src/main/java/org/apache/cloudstack/storage/template/VnfTemplateManagerImpl.java	Implements `validateVnfApplianceNetworksMap` and adds check to prevent VNF nics on deploy-as-is templates
api/src/main/java/org/apache/cloudstack/storage/template/VnfTemplateUtils.java	Adds validation methods for deploy-as-is templates: prevents VNF nics registration and validates OVF networks
server/src/main/java/com/cloud/vm/UserVmManagerImpl.java	Routes to appropriate validation method based on whether template is deploy-as-is
server/src/main/java/com/cloud/template/TemplateManagerImpl.java	Adds validation for VNF nics updates on deploy-as-is templates using OVF network data
server/src/test/java/com/cloud/template/TemplateManagerImplTest.java	Adds mock bean for TemplateDeployAsIsDetailsDao to support new validation

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

ui/src/views/compute/wizard/VnfNicsSelection.vue

Copilot · 2026-01-22T08:13:11Z

api/src/main/java/org/apache/cloudstack/storage/template/VnfTemplateUtils.java

+            if (vnfNic.getDeviceId() < ovfNetworks.size() && !vnfNic.isRequired()) {
+                throw new InvalidParameterValueException(String.format("The VNF nic [device ID: %s ] is required as it is defined in the OVA template.", vnfNic.getDeviceId()));
+            }


The validation logic has a flaw. It checks if vnfNic.getDeviceId() < ovfNetworks.size() && !vnfNic.isRequired(), which throws an error if the vnfNic is NOT required. This is backwards - the error message says "The VNF nic [device ID: %s ] is required" but the condition checks !vnfNic.isRequired(). The logic should be: if the device ID corresponds to an OVF network, the VNF nic MUST be required. So the condition should be checking if it's defined in OVF but marked as not required in the VNF configuration.

server/src/main/java/org/apache/cloudstack/storage/template/VnfTemplateManagerImpl.java

Copilot · 2026-01-22T08:13:12Z

server/src/main/java/org/apache/cloudstack/storage/template/VnfTemplateManagerImpl.java

+    @Override
+    public void validateVnfApplianceNetworksMap(VirtualMachineTemplate template, Map<Integer, Long> vmNetworkMap) {
+        if (MapUtils.isEmpty(vmNetworkMap)) {
+            throw new InvalidParameterValueException("VNF networks map is empty");
+        }
+        List<VnfTemplateNicVO> vnfNics = vnfTemplateNicDao.listByTemplateId(template.getId());
+        for (VnfTemplateNicVO vnfNic : vnfNics) {
+            if (vnfNic.isRequired() && vmNetworkMap.size() <= vnfNic.getDeviceId()) {
+                throw new InvalidParameterValueException("VNF nic is required but not found: " + vnfNic);
+            }
+        }
+    }


The new method validateVnfApplianceNetworksMap is not covered by any unit tests. Since this is a critical validation method for deploy-as-is VNF templates and similar validation methods in the codebase have test coverage, unit tests should be added to verify the validation logic works correctly.

Copilot · 2026-01-22T08:13:12Z

api/src/main/java/org/apache/cloudstack/storage/template/VnfTemplateUtils.java

+    public static void validateDeployAsIsTemplateVnfNics(List<OVFNetworkTO> ovfNetworks, List<VNF.VnfNic> vnfNics) {
+        if (CollectionUtils.isEmpty(vnfNics)) {
+            return;
+        }
+        if (CollectionUtils.isEmpty(ovfNetworks)) {
+            throw new InvalidParameterValueException("The list of networks read from OVA is empty. Please wait until the template is fully downloaded and processed.");
+        }
+        for (VNF.VnfNic vnfNic : vnfNics) {
+            if (vnfNic.getDeviceId() < ovfNetworks.size() && !vnfNic.isRequired()) {
+                throw new InvalidParameterValueException(String.format("The VNF nic [device ID: %s ] is required as it is defined in the OVA template.", vnfNic.getDeviceId()));
+            }
+        }
+    }


The new method validateDeployAsIsTemplateVnfNics is not covered by any unit tests. This is a new validation method for deploy-as-is VNF templates, and given that similar validation methods in the codebase have test coverage, unit tests should be added to ensure the validation logic works as expected.

blueorangutan · 2026-01-22T08:47:52Z

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

server/src/main/java/org/apache/cloudstack/storage/template/VnfTemplateManagerImpl.java

nvazquez · 2026-01-22T11:15:02Z

server/src/main/java/com/cloud/template/TemplateManagerImpl.java

            if (cmd instanceof UpdateVnfTemplateCmd) {
                VnfTemplateUtils.validateApiCommandParams(cmd, template);
+                UpdateVnfTemplateCmd updateCmd = (UpdateVnfTemplateCmd) cmd;
+                if (template.isDeployAsIs() && CollectionUtils.isNotEmpty(updateCmd.getVnfNics())) {


Why is this parameter allowed on update but not on VM creation? (https://github.com/apache/cloudstack/pull/12499/files#diff-f5ab861d900497f6f7c83d03a840a7994f407c2dd52c237a4b560aaf9e75c202R128)

@nvazquez
when register a deploy-as-is template, the template NICs are not available until the template is downloaded successfully.
I think it is better that user configures VNF nics only when template NICs are fetched from OVA template.

Co-authored-by: Copilot <175728472+Copilot@users.noreply.github.com>

…mplateUtils.java

…fTemplateManagerImpl.java Co-authored-by: Copilot <175728472+Copilot@users.noreply.github.com>

…plate/VnfTemplateManagerImpl.java" This reverts commit 0bfc65a.

github-actions · 2026-01-22T12:07:19Z

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

…s-is

RosiKyu · 2026-01-22T13:11:37Z

NOTE #12436 (comment) -> check tooltip fix while verifying this PR

weizhouapache · 2026-01-22T15:27:14Z

@blueorangutan package

weizhouapache · 2026-01-22T15:27:56Z

thanks @DaanHoogland

@nvazquez can you please review ? thanks

api/server: support deploy-as-is template as VNF template

d64089d

boring-cyborg bot added component:api component:storage component:UI labels Jan 22, 2026

weizhouapache added this to the 4.20.3 milestone Jan 22, 2026

DaanHoogland approved these changes Jan 22, 2026

View reviewed changes

DaanHoogland added the status:needs-testing label Jan 22, 2026

DaanHoogland requested review from Copilot and nvazquez January 22, 2026 08:03

Copilot started reviewing on behalf of DaanHoogland January 22, 2026 08:03 View session

Copilot AI reviewed Jan 22, 2026

View reviewed changes

nvazquez reviewed Jan 22, 2026

View reviewed changes

weizhouapache and others added 7 commits January 22, 2026 12:29

Update ui/src/views/compute/wizard/VnfNicsSelection.vue

3337808

Co-authored-by: Copilot <175728472+Copilot@users.noreply.github.com>

Update api/src/main/java/org/apache/cloudstack/storage/template/VnfTe…

74e3b55

…mplateUtils.java

server: update validateVnfApplianceNics instead of a new method

fb012c8

Update server/src/main/java/org/apache/cloudstack/storage/template/Vn…

0bfc65a

…fTemplateManagerImpl.java Co-authored-by: Copilot <175728472+Copilot@users.noreply.github.com>

api: add change

9889064

Revert "Update server/src/main/java/org/apache/cloudstack/storage/tem…

ed56c59

…plate/VnfTemplateManagerImpl.java" This reverts commit 0bfc65a.

api/ui: fix wrong message

469df6b

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

weizhouapache mentioned this pull request Jan 22, 2026

UI: fix issues when deploy VNF applicance on network with SG #12436

Merged

14 tasks

Merge remote-tracking branch 'apache/4.20' into 4.20-fix-vnf-deploy-a…

4d9c382

…s-is

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

RosiKyu self-assigned this Jan 22, 2026

RosiKyu added the status:testing label Jan 22, 2026

server: fix build failures

976b969

api/server: support deploy-as-is template as VNF template #12499

Are you sure you want to change the base?

api/server: support deploy-as-is template as VNF template #12499

Conversation

weizhouapache commented Jan 22, 2026

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!

weizhouapache commented Jan 22, 2026

Uh oh!

blueorangutan commented Jan 22, 2026

Uh oh!

codecov bot commented Jan 22, 2026 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Codecov Report

Uh oh!

DaanHoogland left a comment

Choose a reason for hiding this comment

Uh oh!

DaanHoogland Jan 22, 2026

Choose a reason for hiding this comment

Uh oh!

weizhouapache Jan 22, 2026

Choose a reason for hiding this comment

Uh oh!

weizhouapache Jan 22, 2026

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Copilot AI left a comment

Choose a reason for hiding this comment

Pull request overview

Reviewed changes

Uh oh!

Uh oh!

Copilot AI Jan 22, 2026

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Copilot AI Jan 22, 2026

Choose a reason for hiding this comment

Uh oh!

Copilot AI Jan 22, 2026

Choose a reason for hiding this comment

Uh oh!

blueorangutan commented Jan 22, 2026

Uh oh!

Uh oh!

nvazquez Jan 22, 2026

Choose a reason for hiding this comment

Uh oh!

weizhouapache Jan 22, 2026

Choose a reason for hiding this comment

Uh oh!

github-actions bot commented Jan 22, 2026

Uh oh!

RosiKyu commented Jan 22, 2026

Uh oh!

weizhouapache commented Jan 22, 2026

Uh oh!

weizhouapache commented Jan 22, 2026

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

5 participants

codecov bot commented Jan 22, 2026 •

edited

Loading