Allow updating of Load Balancer source CIDR list by CodeBleu · Pull Request #11568 · apache/cloudstack · GitHub

Switching base to main from 4.19 , SEE #10968 for Comment history

Description

This PR will allow the updating of a loadbalancer rules CIDR list via the API.
* Should fix #9313

I have tested this code in 4.19, 4.20, and main branches via simulator and all works

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

BLOCKER
Critical
Major
Minor
Trivial

Screenshots (if appropriate):

Before, the Source CIDR list was blank (Simulator env)

(localcloud) :penguin: > list loadbalancerrules
{
  "count": 1,
  "loadbalancerrule": [
    {
      "account": "admin",
      "algorithm": "roundrobin",
      "cidrlist": "",
      "domain": "ROOT",
      "domainid": "5b6a2947-416b-11f0-9a39-564a8191c23c",
      "domainpath": "/",
      "fordisplay": true,
      "id": "0d8e3cb9-767b-45f3-834d-3f9ce85df901",
      "name": "newlbtest",
      "networkid": "5bb3ecfb-cde3-4821-8822-0c4c8a8e9559",
      "privateport": "3306",
      "protocol": "tcp",
      "publicip": "192.168.2.10",
      "publicipid": "9b2638d7-7330-49c7-9d6e-5b5777f6ca16",
      "publicport": "3306",
      "state": "Add",
      "tags": [],
      "zoneid": "7cb86a09-676e-4f00-ad39-012f0eb2e69d",
      "zonename": "Sandbox-simulator"
    }
  ]
}
(localcloud) :penguin: > update loadbalancerrule id="0d8e3cb9-767b-45f3-834d-3f9ce85df901" cidrlist="1.2.3.4/32"
{
  "loadbalancer": {
    "account": "admin",
    "algorithm": "roundrobin",
    "cidrlist": "1.2.3.4/32",
    "domain": "ROOT",
    "domainid": "5b6a2947-416b-11f0-9a39-564a8191c23c",
    "domainpath": "/",
    "fordisplay": true,
    "id": "0d8e3cb9-767b-45f3-834d-3f9ce85df901",
    "name": "newlbtest",
    "networkid": "5bb3ecfb-cde3-4821-8822-0c4c8a8e9559",
    "privateport": "3306",
    "protocol": "tcp",
    "publicip": "192.168.2.10",
    "publicipid": "9b2638d7-7330-49c7-9d6e-5b5777f6ca16",
    "publicport": "3306",
    "state": "Add",
    "tags": [],
    "zoneid": "7cb86a09-676e-4f00-ad39-012f0eb2e69d",
    "zonename": "Sandbox-simulator"
  }
}
(localcloud) :penguin: > update loadbalancerrule id="0d8e3cb9-767b-45f3-834d-3f9ce85df901" cidrlist=
{
  "loadbalancer": {
    "account": "admin",
    "algorithm": "roundrobin",
    "cidrlist": "",
    "domain": "ROOT",
    "domainid": "5b6a2947-416b-11f0-9a39-564a8191c23c",
    "domainpath": "/",
    "fordisplay": true,
    "id": "0d8e3cb9-767b-45f3-834d-3f9ce85df901",
    "name": "newlbtest",
    "networkid": "5bb3ecfb-cde3-4821-8822-0c4c8a8e9559",
    "privateport": "3306",
    "protocol": "tcp",
    "publicip": "192.168.2.10",
    "publicipid": "9b2638d7-7330-49c7-9d6e-5b5777f6ca16",
    "publicport": "3306",
    "state": "Add",
    "tags": [],
    "zoneid": "7cb86a09-676e-4f00-ad39-012f0eb2e69d",
    "zonename": "Sandbox-simulator"
  }
}

Tested on actual test environment and below is where you can see when it was restricted it didn't connect to mysql, but when opened up and CIDR set to 0.0.0.0/0 it worked. I tested with specific Public IP in CIDR as well (x.x.0.118/32) and this works and you can see in the virtual router for haproxy it set the ACL.

Restricted with wrong IP in source CIDR of LB

⮡ $ mysql -h x.x.x.110 -u root -p
Enter password:
ERROR 2013 (HY000): Lost connection to MySQL server at 'reading initial communication packet', system error: 104

With correct source CIDR or 0.0.0.0/0

$ mysql -h x.x.x.110 -u root -p
Enter password:
Welcome to the MySQL monitor.  Commands end with ; or \g.
Your MySQL connection id is 4730216
Server version: 8.0.33 MySQL Community Server - GPL

Copyright (c) 2000, 2024, Oracle and/or its affiliates.

Oracle is a registered trademark of Oracle Corporation and/or its
affiliates. Other names may be trademarks of their respective
owners.

Type 'help;' or '\h' for help. Type '\c' to clear the current input statement.

mysql> quit
Bye

How Has This Been Tested?

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

Ran multiple tests with Cloudmonkey against simulator and actual test environment. See above for testing info

Codecov Report

❌ Patch coverage is 47.05882% with 9 lines in your changes missing coverage. Please review.
✅ Project coverage is 17.39%. Comparing base (70a4503) to head (1d5a7f6).
⚠️ Report is 18 commits behind head on main.

Files with missing lines	Patch %	Lines
...loud/network/lb/LoadBalancingRulesManagerImpl.java	36.36%	4 Missing and 3 partials ⚠️
...d/user/loadbalancer/UpdateLoadBalancerRuleCmd.java	33.33%	2 Missing ⚠️

Additional details and impacted files

@@            Coverage Diff            @@
##               main   #11568   +/-   ##
=========================================
  Coverage     17.39%   17.39%           
- Complexity    15285    15286    +1     
=========================================
  Files          5888     5888           
  Lines        526130   526142   +12     
  Branches      64232    64234    +2     
=========================================
+ Hits          91542    91546    +4     
- Misses       424255   424259    +4     
- Partials      10333    10337    +4

Flag	Coverage Δ
uitests	3.62% <ø> (ø)
unittests	18.44% <47.05%> (+<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.

code lgtm

@blueorangutan package

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

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

code lgtm.

@blueorangutan package

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

@Pearl1594 @weizhouapache Can I get one of you to manually test this and post results? Once that is complete, I believe I can merge it 😄

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

@blueorangutan test

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

code LGTM

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

Test	Result	Time (s)	Test File

@harikrishna-patnala Would you be able to test this and post results? I believe I'm just needed that from someone and then I can merge.

Unless @weizhouapache the following Trillian test counts?

Smoke tests completed. 146 look OK, 0 have errors, 0 did not run

@harikrishna-patnala Would you be able to test this and post results? I believe I'm just needed that from someone and then I can merge.

Unless @weizhouapache the following Trillian test counts?

Smoke tests completed. 146 look OK, 0 have errors, 0 did not run

@CodeBleu , do you have a friend and/or colleague that can test? We usually trust any viable test report. Shapeblue has some time/people to test but we are usually stuffed with customer work.

Another thing that might help is to write an integration test that shows it works;

it eases the work for other to validate
it shows it works 🤷

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

- Replace manual null-check comparison with Objects.equals for clarity and null safety - Simplify CIDR list rollback to always restore backup value unconditionally - Add JavaDoc for setCidrList method for improved documentation

@blueorangutan package

@DaanHoogland 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 15007

@blueorangutan test

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

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

Test	Result	Time (s)	Test File
test_03_deploy_and_scale_kubernetes_cluster	Failure	1.17	test_kubernetes_clusters.py
test_04_autoscale_kubernetes_cluster	Failure	27.89	test_kubernetes_clusters.py

c still lgtm

@blueorangutan test keepEnv

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

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

Test	Result	Time (s)	Test File
test_03_deploy_and_scale_kubernetes_cluster	Failure	1.20	test_kubernetes_clusters.py
test_04_autoscale_kubernetes_cluster	Failure	29.98	test_kubernetes_clusters.py

manually tested:

> update loadbalancerrule cidrlist=7.5.3.2/32 name=blob id=2095d12e-4921-4454-b6a2-2fb10556bd31 
{
  "loadbalancer": {
    "account": "admin",
    "algorithm": "roundrobin",
    "cidrlist": "7.5.3.2/32",
    "domain": "ROOT",
    "domainid": "2e4aebe1-92db-11f0-9310-1e00fe000184",
    "domainpath": "/",
    "fordisplay": true,
    "id": "2095d12e-4921-4454-b6a2-2fb10556bd31",
    "name": "blob",
    "networkid": "939ad915-aa47-4801-a1d8-94b8de65944f",
    "privateport": "34",
    "protocol": "tcp",
    "publicip": "10.0.57.124",
    "publicipid": "f77d4217-a3b2-4e86-83c5-f1a76a020dd7",
    "publicport": "34",
    "state": "Add",
    "tags": [],
    "zoneid": "460b948c-8de9-406f-be6a-def0433f52b4",
    "zonename": "pr11568-t14354-kvm-ol8"
  }
}

@CodeBleu , I will merge but please consider adding this to the UI as well.

Awesome work, congrats on your first merged pull request!

boring-cyborg Bot added component:api component:networking labels Sep 3, 2025

CodeBleu mentioned this pull request Sep 3, 2025

Allow updating of Load Balancer source CIDR list #10968

Closed

3 of 14 tasks

CodeBleu requested review from DaanHoogland, Pearl1594, vishesh92 and weizhouapache September 3, 2025 13:32

weizhouapache reviewed Sep 3, 2025

View reviewed changes

Comment thread server/src/main/java/com/cloud/network/lb/LoadBalancingRulesManagerImpl.java Resolved

weizhouapache reviewed Sep 3, 2025

View reviewed changes

Comment thread ...main/java/org/apache/cloudstack/api/command/user/loadbalancer/UpdateLoadBalancerRuleCmd.java Resolved

weizhouapache approved these changes Sep 3, 2025

View reviewed changes

Pearl1594 approved these changes Sep 3, 2025

View reviewed changes

Comment thread engine/schema/src/main/java/com/cloud/network/dao/LoadBalancerVO.java Resolved

harikrishna-patnala approved these changes Sep 4, 2025

View reviewed changes

harikrishna-patnala added this to Apache CloudStack 4.22.0 Sep 4, 2025

harikrishna-patnala added this to the 4.22.0 milestone Sep 4, 2025

DaanHoogland added the status:needs-testing label Sep 8, 2025

github-actions Bot added the status:has-conflicts label Sep 11, 2025

CodeBleu added 6 commits September 12, 2025 21:09

Add License text to LoadBalancerVOTest.java file

dd59044

Refactor LB CIDR list comparison & rollback code

3b342da

- Replace manual null-check comparison with Objects.equals for clarity and null safety - Simplify CIDR list rollback to always restore backup value unconditionally - Add JavaDoc for setCidrList method for improved documentation

Added missing Import for java.util.Objects

e359ed8

Removed duplicate import

b901cc9

Added since to api parameter

316036b

Fix typo

1d5a7f6

CodeBleu force-pushed the main_lb_update_cidr branch from 2fabc02 to 1d5a7f6 Compare September 13, 2025 01:14

github-actions Bot removed the status:has-conflicts label Sep 13, 2025

DaanHoogland approved these changes Sep 16, 2025

View reviewed changes

DaanHoogland self-assigned this Sep 16, 2025

DaanHoogland merged commit 273ae03 into apache:main Sep 17, 2025

github-project-automation Bot moved this to Done in Apache CloudStack 4.22.0 Sep 17, 2025

CodeBleu mentioned this pull request Sep 30, 2025

ui: Allow edit source CIDR on load balancer rule #11766

Merged

2 of 14 tasks

CodeBleu deleted the main_lb_update_cidr branch September 30, 2025 17:13

CodeBleu removed the status:needs-testing label Oct 9, 2025

CodeBleu mentioned this pull request Nov 25, 2025

Allow setting of source CIDR for LB rule apache/cloudstack-kubernetes-provider#78

Merged

DaanHoogland removed their assignment Dec 24, 2025

hrak mentioned this pull request Feb 23, 2026

Support source CIDR when exposing services via load balancer IP leaseweb/cloudstack-kubernetes-provider#101

Open

Allow updating of Load Balancer source CIDR list by CodeBleu · Pull Request #11568 · apache/cloudstack · GitHub

Repository navigation

Allow updating of Load Balancer source CIDR list - #11568

Allow updating of Load Balancer source CIDR list#11568DaanHoogland merged 8 commits intoapache:mainapache/cloudstack:mainfrom American-Cloud:main_lb_update_cidrAmerican-Cloud/cloudstack:main_lb_update_cidrCopy head branch name to clipboard

Conversation

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

Uh oh!

Switching base to main from 4.19 , SEE #10968 for Comment history

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!

Uh oh!

Uh oh!

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

Uh oh!

Codecov Report

Uh oh!

weizhouapache left a comment

Choose a reason for hiding this comment

Uh oh!

weizhouapache commented Sep 3, 2025

Uh oh!

blueorangutan commented Sep 3, 2025

Uh oh!

blueorangutan commented Sep 3, 2025

Uh oh!

Pearl1594 left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Pearl1594 commented Sep 3, 2025

Uh oh!

blueorangutan commented Sep 3, 2025

Uh oh!

CodeBleu commented Sep 3, 2025

Uh oh!

blueorangutan commented Sep 3, 2025

Uh oh!

weizhouapache commented Sep 3, 2025

Uh oh!

blueorangutan commented Sep 3, 2025

Uh oh!

harikrishna-patnala left a comment

Choose a reason for hiding this comment

Uh oh!

blueorangutan commented Sep 4, 2025

Uh oh!

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

Uh oh!

Uh oh!

DaanHoogland commented Sep 8, 2025

Uh oh!

github-actions Bot commented Sep 11, 2025

Uh oh!

DaanHoogland commented Sep 15, 2025

Uh oh!

blueorangutan commented Sep 15, 2025

Uh oh!

blueorangutan commented Sep 15, 2025

Uh oh!

DaanHoogland commented Sep 15, 2025

Uh oh!

blueorangutan commented Sep 15, 2025

Uh oh!

blueorangutan commented Sep 16, 2025

Uh oh!

DaanHoogland left a comment

Choose a reason for hiding this comment

Uh oh!

DaanHoogland commented Sep 16, 2025

Uh oh!

blueorangutan commented Sep 16, 2025

Uh oh!

blueorangutan commented Sep 17, 2025

Allow updating of Load Balancer source CIDR list#11568
DaanHoogland merged 8 commits into
apache:mainfrom
American-Cloud:main_lb_update_cidr

CodeBleu commented Sep 3, 2025 •
edited
Loading

codecov Bot commented Sep 3, 2025 •
edited
Loading

CodeBleu commented Sep 5, 2025 •
edited
Loading