Support VPC public gateway rate throttling, built on NIC/network rate persistence and precedence fixes by sudo87 · Pull Request #13325 · apache/cloudstack

sudo87 · 2026-06-03T09:56:15Z

Description

Adds an operator-configurable data transfer rate for a VPC's public/internet-facing gateway, independent of the per-tier rates that network offerings already control.

Precedence:

VPC offering  rate >  vpc.public.network.throttling.rate (default unlimited)

In addition to vpc, there is a change in precedence order for network rate for NIC and VRs being added in this PR.

For NICs:

Default used to select network rate based on below:

Bandwidth from compute offering  > "vm.network.throttling.rate" config

Other NICs use:

Bandwidth from Network offering > "network.throttling.rate" config

Going forward Default NIC precedence will be used for all NICs

For VR's guest interface:

Old precendence:

Bandwidth from Network offering > "network.throttling.rate" config

New one:

Bandwidth from System offering > Network offering > "network.throttling.rate" config

Also persists the effective network rate per NIC and Network and exposes the effective network rate (bandwidth throttling) configured for NICs and guest networks in the API responses and UI.

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?

Verified end-to-end in a lab: API responses, the actual libvirt bandwidth configuration on the router, and measured live throughput across a multi-tier VPC confirming tiers correctly share one capped public-gateway.

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

codecov · 2026-06-03T10:30:01Z

Codecov Report

✅ All modified and coverable lines are covered by tests.
✅ Project coverage is 3.70%. Comparing base (d3f0700) to head (a1d80a9).

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

HEAD has 1 upload less than BASE

Flag BASE (d3f0700) HEAD (a1d80a9)

unittests 1 0

Additional details and impacted files

@@              Coverage Diff              @@
##               main   #13325       +/-   ##
=============================================
- Coverage     20.39%    3.70%   -16.70%     
=============================================
  Files          6481      493     -5988     
  Lines        588040    42549   -545491     
  Branches      72021     8067    -63954     
=============================================
- Hits         119957     1577   -118380     
+ Misses       455052    40746   -414306     
+ Partials      13031      226    -12805

Flag	Coverage Δ
uitests	`3.70% <ø> (-0.01%)`	⬇️
unittests	`?`

Flags with carried forward coverage won't be shown. Click here to find out more.

☔ View full report in Codecov by Harness.
📢 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.

…e offering

github-actions · 2026-06-08T07:10:22Z

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

# Conflicts: # server/src/main/java/com/cloud/vm/UserVmManagerImpl.java # ui/src/config/section/network.js

- Add network_rate column to nics table (schema-42300to42400.sql) - Add DB upgrade path: Upgrade42300to42400 registered in DatabaseUpgradeChecker - Add network_rate field and getter/setter to NicVO - Set network_rate on NicVO in NetworkOrchestrator.allocateNic() where rate is already computed, eliminating secondary per-NIC update calls - Add getNetworkRate() to Nic interface so ApiResponseHelper.createNicResponse can call result.getNetworkRate() without casting or extra DB queries - Add nic_network_rate to user_vm_view and UserVmJoinVO so listVirtualMachines reads rate from the join without extra per-NIC findNicById calls - Update UserVmJoinDaoImpl to use uvo.getNicNetworkRate() directly - Expose network_rate in NicResponse as Integer (null = unlimited) - Refresh NIC rates on VM start via refreshNicNetworkRates in UserVmManagerImpl

sudo87 · 2026-09-04T11:27:37Z

@blueorangutan package

blueorangutan · 2026-09-04T11:28:05Z

@sudo87 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-09-04T12:15:36Z

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

github-actions · 2026-09-07T09:45:12Z

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

sudo87 · 2026-09-07T16:55:53Z

@blueorangutan package

blueorangutan · 2026-09-07T16:58:04Z

@sudo87 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-09-07T17:47:49Z

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

blueorangutan · 2026-10-06T11:52:22Z

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

weizhouapache

code lgtm

Copilot

🟡 Changes recommended

Four moderate issues remain unresolved, including stale NIC rates, partial VPC persistence, an N+1 query, and fractional-rate validation.

2 open findings

Avoid N+1 VPC detail queries in list responses · New
Refresh persisted NIC rates after changing network offering · New

🧠 Review effort: Lite

Give feedback about Copilot approvals in this survey to enter a drawing for a $150 gift card.

sudo87 · 2026-10-08T07:39:02Z

@blueorangutan package

blueorangutan · 2026-10-08T07:40:05Z

@sudo87 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-10-08T08:30:55Z

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

github-actions · 2026-10-08T16:48:30Z

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

Copilot

Warning

Copilot couldn't run its full agentic review because it didn't start before the timeout. Make sure your repository has a runner available, or add a copilot-code-review.yml file specifying one with the runs-on attribute. See the docs for more details.

Copilot review overview

0 open findings

2 resolved since last review

Refresh persisted NIC rates after changing network offering
Avoid N+1 VPC detail queries in list responses

🧠 Review effort: Lite

sudo87 · 2026-10-09T12:22:38Z

@blueorangutan package

blueorangutan · 2026-10-09T12:24:05Z

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

Warning

Copilot couldn't run its full agentic review because it didn't start before the timeout. Make sure your repository has a runner available, or add a copilot-code-review.yml file specifying one with the runs-on attribute. See the docs for more details.

Copilot review overview

2 open findings

When the networkrate detail is absent (e.g., older rows, partial migrations, or any failure to… · New
If the publicnetworkrate VPC detail is missing, the response is forced to -1 (unlimited), which… · New

🧠 Review effort: Lite

blueorangutan · 2026-10-09T13:16:11Z

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

github-actions · 2026-10-14T19:13:34Z

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

Copilot

🔵 Needs a closer look

The form validation needs correction, and the broad rate-precedence and data-migration changes warrant final human review.

1 open finding

Validate publicnetworkrate as an integer before submission · New

2 resolved since last review

If the publicnetworkrate VPC detail is missing, the response is forced to -1 (unlimited), which…
When the networkrate detail is absent (e.g., older rows, partial migrations, or any failure to…

🧠 Review effort: Lite

+      if (value && (isNaN(value) || value < -1)) {
+        return Promise.reject(this.$t('message.error.number'))
+      }


boring-cyborg Bot added component:api component:networking component:orchestration component:UI labels Jun 3, 2026

sudo87 changed the title ~~persist and expose effective network rate for NIC, Network and compute offering~~ Persist and expose effective network rate for NIC, Network and compute offering Jun 3, 2026

sudo87 marked this pull request as draft June 3, 2026 09:56

bernardodemarco requested a review from hsato03 June 3, 2026 12:23

persist and expose effective network rate for NIC, Network and comput…

498b69b

…e offering

github-actions Bot added the status:has-conflicts label Jun 8, 2026

weizhouapache added this to the 4.24.0 milestone Jun 29, 2026

DaanHoogland added this to CloudStack Testing Aug 31, 2026

github-project-automation Bot moved this to Backlog in CloudStack Testing Aug 31, 2026

DaanHoogland moved this from Backlog to conflict/waiting for author in CloudStack Testing Aug 31, 2026

Merge branch 'main' into networkThrottling

c8ac2a0

# Conflicts: # server/src/main/java/com/cloud/vm/UserVmManagerImpl.java # ui/src/config/section/network.js

sudo87 force-pushed the networkThrottling branch from 35bcb26 to c8ac2a0 Compare September 4, 2026 06:14

github-actions Bot removed the status:has-conflicts label Sep 4, 2026

github-actions Bot added the status:has-conflicts label Sep 7, 2026

Merge branch 'main' into networkThrottling

fb7cce0

github-actions Bot removed the status:has-conflicts label Sep 7, 2026

fix ui build due to merge conflict

b684b88

weizhouapache approved these changes Oct 7, 2026

View reviewed changes

Comment thread ...ain/java/org/apache/cloudstack/engine/orchestration/service/NetworkOrchestrationService.java Outdated

unit tests for code coverage improvement

27c0a73

Copilot AI lite review requested due to automatic review settings October 8, 2026 06:27

Copilot started reviewing on behalf of sudo87 October 8, 2026 06:27

View session

Copilot AI reviewed Oct 8, 2026

View reviewed changes

Comment thread server/src/main/java/com/cloud/api/ApiResponseHelper.java

Comment thread server/src/main/java/com/cloud/network/NetworkServiceImpl.java

github-actions Bot added the status:has-conflicts label Oct 8, 2026

Update NIC network rates when compute offering changes on a stopped VM

7308759

Copilot AI lite review requested due to automatic review settings October 9, 2026 11:53

Merge apache/main into networkThrottling

80f7ce9

Copilot AI reviewed Oct 9, 2026

View reviewed changes

Copilot AI lite review requested due to automatic review settings October 9, 2026 12:11

Copilot stopped reviewing on behalf of sudo87 due to an error October 9, 2026 12:12
An unexpected error occurred. For more details, see the detailed logs in GitHub Actions.

github-actions Bot removed the status:has-conflicts label Oct 9, 2026

Copilot AI reviewed Oct 9, 2026

View reviewed changes

Comment thread server/src/main/java/com/cloud/api/ApiResponseHelper.java

Comment thread server/src/main/java/com/cloud/api/ApiResponseHelper.java

Copilot stopped reviewing on behalf of sudo87 due to an error October 9, 2026 12:32
An unexpected error occurred. For more details, see the detailed logs in GitHub Actions.

github-actions Bot added the status:has-conflicts label Oct 14, 2026

Merge apache/main into networkThrottling

a1d80a9

Copilot AI lite review requested due to automatic review settings October 15, 2026 06:43

github-actions Bot removed the status:has-conflicts label Oct 15, 2026

Copilot AI reviewed Oct 15, 2026

View reviewed changes

Comment thread ui/src/views/offering/AddVpcOffering.vue

Comment on lines +772 to +774

if (value && (isNaN(value) || value < -1)) {

return Promise.reject(this.$t('message.error.number'))

}

Copilot started reviewing on behalf of sudo87 October 15, 2026 07:34

View session

Conversation

sudo87 commented Jun 3, 2026 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Description

For NICs:

For VR's guest interface:

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 Jun 3, 2026 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Codecov Report

Uh oh!

github-actions Bot commented Jun 8, 2026

Uh oh!

sudo87 commented Sep 4, 2026

Uh oh!

blueorangutan commented Sep 4, 2026

Uh oh!

blueorangutan commented Sep 4, 2026

Uh oh!

github-actions Bot commented Sep 7, 2026

Uh oh!

sudo87 commented Sep 7, 2026

Uh oh!

blueorangutan commented Sep 7, 2026

Uh oh!

blueorangutan commented Sep 7, 2026

Uh oh!

blueorangutan commented Oct 6, 2026

Uh oh!

weizhouapache left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Copilot AI left a comment

Choose a reason for hiding this comment

🟡 Changes recommended

Uh oh!

Uh oh!

Uh oh!

sudo87 commented Oct 8, 2026

Uh oh!

blueorangutan commented Oct 8, 2026

Uh oh!

blueorangutan commented Oct 8, 2026

Uh oh!

github-actions Bot commented Oct 8, 2026

Uh oh!

Copilot AI left a comment

Choose a reason for hiding this comment

Copilot review overview

Uh oh!

sudo87 commented Oct 9, 2026

Uh oh!

blueorangutan commented Oct 9, 2026

Uh oh!

Copilot AI left a comment

Choose a reason for hiding this comment

Copilot review overview

Uh oh!

Uh oh!

Uh oh!

blueorangutan commented Oct 9, 2026

Uh oh!

github-actions Bot commented Oct 14, 2026

Uh oh!

Copilot AI left a comment

Choose a reason for hiding this comment

🔵 Needs a closer look

Uh oh!

This branch has not been deployed

Reviewers

Assignees

Labels

sudo87 commented Jun 3, 2026 •

edited

Loading

codecov Bot commented Jun 3, 2026 •

edited

Loading