Change the global configuration `vm.network.throttling.rate` to be dynamic by gruckbit · Pull Request #12567 · apache/cloudstack

gruckbit · 2026-02-02T13:38:20Z

Description

ACS has the global configuration vm.network.throttling.rate that allows limiting the maximum bandwidth of the default NIC for end-user VMs when it is not defined in compute offerings. However, currently, the setting is static, implying the requirement of restarting the Management Servers after changing its value.
Given this scenario, changes have been applied to make the configuration dynamic. As a consequence, it is not required to restart the Management Servers after each value update; the updated value is automatically considered in the Apache CloudStack internal workflows.

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

Screenshots (if appropriate):

How Has This Been Tested?

The default value of vm.network.throttling.rate is 200, and after changing its value to 100 the VM's domain XML presented the following change:

Before:

virsh dumpxml 4 | grep "bandwidth" -A 2
      <bandwidth>
        <inbound average='25000' peak='25000'/>
        <outbound average='25000' peak='25000'/>
      </bandwidth>
      <target dev='vnet10'/>
      <model type='virtio'/>

After:

 virsh dumpxml 5 | grep "bandwidth" -A 2
      <bandwidth>
        <inbound average='12500' peak='12500'/>
        <outbound average='12500' peak='12500'/>
      </bandwidth>
      <target dev='vnet11'/>
      <model type='virtio'/>

boring-cyborg · 2026-02-02T13:38:24Z

Congratulations on your first Pull Request and welcome to the Apache CloudStack community! If you have any issues or are unsure about any anything please check our Contribution Guide (https://github.com/apache/cloudstack/blob/main/CONTRIBUTING.md)
Here are some useful points:

In case of a new feature add useful documentation (raise doc PR at https://github.com/apache/cloudstack-documentation)
Be patient and persistent. It might take some time to get a review or get the final approval from the committers.
Pay attention to the quality of your code, ensure tests are passing and your PR doesn't have conflicts.
Please follow ASF Code of Conduct for all communication including (but not limited to) comments on Pull Requests, Issues, Mailing list and Slack.
Be sure to read the CloudStack Coding Conventions.
Apache CloudStack is a community-driven project and together we are making it better 🚀.
In case of doubts contact the developers at:
Mailing List: dev@cloudstack.apache.org (https://cloudstack.apache.org/mailing-lists.html)
Slack: https://apachecloudstack.slack.com/

bernardodemarco · 2026-02-02T13:42:35Z

@blueorangutan package

blueorangutan · 2026-02-02T13:44:05Z

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

codecov · 2026-02-02T13:59:01Z

Codecov Report

❌ Patch coverage is 50.00000% with 1 line in your changes missing coverage. Please review.
✅ Project coverage is 18.11%. Comparing base (3f6866d) to head (2b58028).

Files with missing lines	Patch %	Lines
.../cloud/configuration/ConfigurationManagerImpl.java	0.00%	1 Missing ⚠️

Additional details and impacted files

@@            Coverage Diff            @@
##               main   #12567   +/-   ##
=========================================
  Coverage     18.11%   18.11%           
- Complexity    16757    16761    +4     
=========================================
  Files          6037     6037           
  Lines        542783   542783           
  Branches      66454    66454           
=========================================
+ Hits          98301    98348   +47     
+ Misses       433438   433387   -51     
- Partials      11044    11048    +4

Flag	Coverage Δ
uitests	`3.51% <ø> (ø)`
unittests	`19.28% <50.00%> (+<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.

blueorangutan · 2026-02-02T14:27:03Z

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

DaanHoogland

clgtm and malkes functional sense

sureshanaparti

clgtm

DaanHoogland · 2026-02-03T14:22:12Z

btw @gruckbit , if you feel this would benefit older release branches as well feel free to rebase on 4.20 or 4.22.

DaanHoogland · 2026-02-03T14:22:37Z

@blueorangutan test

blueorangutan · 2026-02-03T14:24:04Z

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

blueorangutan · 2026-02-04T05:39:32Z

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

Test	Result	Time (s)	Test File
ContextSuite context=TestListIdsParams>:teardown	`Error`	1.11	test_list_ids_parameter.py
test_01_snapshot_root_disk	`Error`	3.90	test_snapshots.py
test_02_list_snapshots_with_removed_data_store	`Error`	46.57	test_snapshots.py
test_02_list_snapshots_with_removed_data_store	`Error`	46.58	test_snapshots.py
ContextSuite context=TestSnapshotStandaloneBackup>:teardown	`Error`	25.32	test_snapshots.py
test_01_snapshot_usage	`Error`	20.56	test_usage.py
test_01_vpn_usage	`Error`	1.10	test_usage.py

gruckbit · 2026-02-06T14:13:44Z

btw @gruckbit , if you feel this would benefit older release branches as well feel free to rebase on 4.20 or 4.22.

Sure, I'll check later if the changes could be applied to these versions as well.

weizhouapache · 2026-02-19T13:56:38Z

    ConfigKey<Boolean> NSX_ENABLED = new ConfigKey<>(Boolean.class, "nsx.plugin.enable", "Advanced", "false",
            "Indicates whether to enable the NSX plugin", false, ConfigKey.Scope.Zone, null);

+    ConfigKey<Integer> VmNetworkThrottlingRate = new ConfigKey<Integer>("Network", Integer.class, "vm.network.throttling.rate", "200",


maybe extent to a zone-level setting ?

similar to

ConfigKey<Integer> NetworkThrottlingRate = new ConfigKey<>("Network", Integer.class, NetworkThrottlingRateCK, "200", "Default data transfer rate in megabits per second allowed in network.", true, ConfigKey.Scope.Zone);

Sure, I'll check this suggestion as well.

kiranchavala

LGTM

Tested manually

Create a network offering with no "Network rate (Mb/s)"
Create a network with the above network offering
Make sure the global setting "vm.network.throttling.rate" is set to 200
Deploy a vm
Login to the kvm host where the vm is deployed and check the bandwidth and rate limit

[root@ref-trl-11266-k-Mol8-kiran-chavala-kvm1 ~]# virsh dumpxml 4 | grep -A10 interface
    <interface type='bridge'>
      <mac address='02:01:00:cc:00:01'/>
      <source bridge='breth1-1808'/>
      <bandwidth>
        <inbound average='25000' peak='25000'/>
        <outbound average='25000' peak='25000'/>
      </bandwidth>
      <target dev='vnet9'/>
      <model type='virtio'/>
      <link state='up'/>
      <alias name='net0'/>


[root@ref-trl-11266-k-Mol8-kiran-chavala-kvm1 ~]# virsh domiflist 4
 Interface   Type     Source        Model    MAC
----------------------------------------------------------------
 vnet9       bridge   breth1-1808   virtio   02:01:00:cc:00:01

[root@ref-trl-11266-k-Mol8-kiran-chavala-kvm1 ~]# tc class show dev vnet9
class htb 1:1 root leaf 2: prio 0 rate 200Mbit ceil 200Mbit burst 1600b cburst 1600b

Change the global setting "vm.network.throttling.rate" is set to 400
Stop/Start the vm
Check the the bandwidth and rate limit

[root@ref-trl-11266-k-Mol8-kiran-chavala-kvm1 ~]# virsh dumpxml 5 | grep -A10 interface
    <interface type='bridge'>
      <mac address='02:01:00:cc:00:01'/>
      <source bridge='breth1-1808'/>
      <bandwidth>
        <inbound average='50000' peak='50000'/>
        <outbound average='50000' peak='50000'/>
      </bandwidth>
      <target dev='vnet10'/>
      <model type='virtio'/>
      <link state='up'/>
      <alias name='net0'/>

[root@ref-trl-11266-k-Mol8-kiran-chavala-kvm1 ~]# virsh domiflist 5
 Interface   Type     Source        Model    MAC
----------------------------------------------------------------
 vnet10      bridge   breth1-1808   virtio   02:01:00:cc:00:01

[root@ref-trl-11266-k-Mol8-kiran-chavala-kvm1 ~]# tc class show dev vnet10
class htb 1:1 root leaf 2: prio 0 rate 400Mbit ceil 400Mbit burst 1600b cburst 1600b

kiranchavala · 2026-03-09T08:14:48Z

@gruckbit Please let us know if you can extend the feature to zone-level setting

Otherwise the pr is ready for merge

github-actions · 2026-04-16T23:31:49Z

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

winterhazel · 2026-05-25T13:40:57Z

@gruckbit could you have a look at Kiran's suggestion in #12567 (comment)?

weizhouapache · 2026-05-26T15:33:19Z

                PromiscuousMode, MacAddressChanges, ForgedTransmits, MacLearning, RollingRestartEnabled,
-                TUNGSTEN_ENABLED, NSX_ENABLED, NETRIS_ENABLED, NETWORK_LB_HAPROXY_MAX_CONN,
-                NETWORK_LB_HAPROXY_IDLE_TIMEOUT};
+                TUNGSTEN_ENABLED, NSX_ENABLED, NETRIS_ENABLED, NETWORK_LB_HAPROXY_MAX_CONN, VmNetworkThrottlingRate};


maybe move after NetworkThrottlingRate

Ok, understood. I'll try to extend this feature to the zone level as required.

weizhouapache · 2026-05-26T15:34:11Z

            "Indicates whether to enable the NSX plugin", false, ConfigKey.Scope.Zone, null);

+    ConfigKey<Integer> VmNetworkThrottlingRate = new ConfigKey<Integer>("Network", Integer.class, "vm.network.throttling.rate", "200",
+            "Default data transfer rate in megabits per second allowed in User vm's default network.", true);


NetworkThrottlingRate is a zone-level configuration, this could be zone-level too

Copilot

Pull request overview

This PR makes the global configuration vm.network.throttling.rate dynamic so Management Server restarts are no longer required for changes to take effect when applying default NIC bandwidth limits for user VMs.

Changes:

Replaces direct _configDao lookups with a ConfigKey-backed value for vm.network.throttling.rate.
Removes VmNetworkThrottlingRate from the legacy Config enum and redefines it as a dynamic ConfigKey under NetworkOrchestrationService.
Registers the new config key via NetworkOrchestrator#getConfigKeys().

Reviewed changes

Copilot reviewed 4 out of 4 changed files in this pull request and generated 1 comment.

File	Description
`server/src/main/java/com/cloud/configuration/ConfigurationManagerImpl.java`	Switches default VM throttling rate retrieval to `ConfigKey.value()` to support dynamic updates.
`server/src/main/java/com/cloud/configuration/Config.java`	Removes the legacy `VmNetworkThrottlingRate` enum entry (migrating responsibility to `ConfigKey`).
`engine/orchestration/src/main/java/org/apache/cloudstack/engine/orchestration/NetworkOrchestrator.java`	Updates config key registration list to include the new `VmNetworkThrottlingRate` (but currently drops an existing key—see comment).
`engine/api/src/main/java/org/apache/cloudstack/engine/orchestration/service/NetworkOrchestrationService.java`	Introduces dynamic `ConfigKey<Integer> VmNetworkThrottlingRate`.

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

        return new ConfigKey<?>[]{NetworkGcWait, NetworkGcInterval, NetworkLockTimeout, DeniedRoutes,
                GuestDomainSuffix, NetworkThrottlingRate, MinVRVersion,
                PromiscuousMode, MacAddressChanges, ForgedTransmits, MacLearning, RollingRestartEnabled,
-                TUNGSTEN_ENABLED, NSX_ENABLED, NETRIS_ENABLED, NETWORK_LB_HAPROXY_MAX_CONN,
-                NETWORK_LB_HAPROXY_IDLE_TIMEOUT};
+                TUNGSTEN_ENABLED, NSX_ENABLED, NETRIS_ENABLED, NETWORK_LB_HAPROXY_MAX_CONN, VmNetworkThrottlingRate};


dynamic vm.network.throttling.rate global configuration

6f28947

boring-cyborg Bot added the component:orchestration label Feb 2, 2026

bernardodemarco added this to the 4.23.0 milestone Feb 2, 2026

bernardodemarco reviewed Feb 2, 2026

View reviewed changes

Comment thread server/src/main/java/com/cloud/configuration/ConfigurationManagerImpl.java Outdated

fix curly brace

22dc645

DaanHoogland approved these changes Feb 3, 2026

View reviewed changes

DaanHoogland added the status:needs-testing label Feb 3, 2026

sureshanaparti approved these changes Feb 3, 2026

View reviewed changes

weizhouapache reviewed Feb 19, 2026

View reviewed changes

kiranchavala self-assigned this Mar 9, 2026

kiranchavala approved these changes Mar 9, 2026

View reviewed changes

kiranchavala removed the status:needs-testing label Mar 9, 2026

DaanHoogland added the status:waiting-for-author label Mar 9, 2026

GaOrtiga approved these changes Apr 16, 2026

View reviewed changes

github-actions Bot added the status:has-conflicts label Apr 16, 2026

Merge branch 'main' into make-vm-throttling-config

2b58028

weizhouapache reviewed May 26, 2026

View reviewed changes

github-actions Bot removed the status:has-conflicts label May 26, 2026

DaanHoogland requested a review from Copilot May 27, 2026 12:46

Copilot started reviewing on behalf of DaanHoogland May 27, 2026 12:46 View session

Copilot AI reviewed May 27, 2026

View reviewed changes

Merge branch 'main' into make-vm-throttling-config

b6e626c

Conversation

gruckbit commented Feb 2, 2026

Description

Types of changes

Feature/Enhancement Scale or Bug Severity

Feature/Enhancement Scale

Screenshots (if appropriate):

How Has This Been Tested?

Uh oh!

boring-cyborg Bot commented Feb 2, 2026

Uh oh!

bernardodemarco commented Feb 2, 2026

Uh oh!

blueorangutan commented Feb 2, 2026

Uh oh!

Uh oh!

codecov Bot commented Feb 2, 2026 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Codecov Report

Uh oh!

blueorangutan commented Feb 2, 2026

Uh oh!

DaanHoogland left a comment

Choose a reason for hiding this comment

Uh oh!

sureshanaparti left a comment

Choose a reason for hiding this comment

Uh oh!

DaanHoogland commented Feb 3, 2026

Uh oh!

DaanHoogland commented Feb 3, 2026

Uh oh!

blueorangutan commented Feb 3, 2026

Uh oh!

blueorangutan commented Feb 4, 2026

Uh oh!

gruckbit commented Feb 6, 2026

Uh oh!

weizhouapache Feb 19, 2026

Choose a reason for hiding this comment

Uh oh!

gruckbit Feb 26, 2026

Choose a reason for hiding this comment

Uh oh!

kiranchavala left a comment

Choose a reason for hiding this comment

Uh oh!

kiranchavala commented Mar 9, 2026

Uh oh!

github-actions Bot commented Apr 16, 2026

Uh oh!

winterhazel commented May 25, 2026

Uh oh!

weizhouapache May 26, 2026

Choose a reason for hiding this comment

Uh oh!

gruckbit May 27, 2026

Choose a reason for hiding this comment

Uh oh!

weizhouapache May 26, 2026

Choose a reason for hiding this comment

Uh oh!

Copilot AI left a comment

Choose a reason for hiding this comment

Pull request overview

Reviewed changes

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

10 participants

codecov Bot commented Feb 2, 2026 •

edited

Loading