Enforce distinct hostnames network #10212

vishesh92 · 2025-01-20T10:03:55Z

Description

This PR adds check to ensure we check for unique hostname for other networks in the VPC as well.

This PR also adds another global setting vm.distinct.hostname.scope which sets the scope of resources for which the VMs should have a unique hostname. Default value is network.

Details

This pull request includes several changes to enhance the network domain search functionality and improve the configuration management for VM hostname uniqueness. The most important changes include adding new methods for network domain searches, updating the search builder initialization, and modifying the hostname uniqueness check logic.

Enhancements to network domain search functionality:

engine/schema/src/main/java/com/cloud/network/dao/NetworkDao.java: Added new methods listByNetworkDomains, listByNetworkDomainsAndAccountIds, and listByNetworkDomainsAndDomainIds to the NetworkDao interface.
engine/schema/src/main/java/com/cloud/network/dao/NetworkDaoImpl.java: Added NetworkDomainSearch to the NetworkDaoImpl class and initialized it in the init method. Implemented the new methods for network domain searches. [1] [2] [3]

Improvements to VM hostname uniqueness check:

server/src/main/java/com/cloud/vm/UserVmManager.java: Introduced a new configuration key VmDistinctHostNameScope to manage the scope of hostname uniqueness checks.
server/src/main/java/com/cloud/vm/UserVmManagerImpl.java: Updated the logic for checking hostname uniqueness to use the new network domain search methods and the VmDistinctHostNameScope configuration. [1] [2]

Mock implementation updates:

server/src/test/java/com/cloud/vpc/dao/MockNetworkDaoImpl.java: Added mock implementations for the new network domain search methods.

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?

vishesh92 · 2025-01-20T10:04:14Z

@blueorangutan package

blueorangutan · 2025-01-20T10:06:03Z

@vishesh92 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 · 2025-01-20T10:51:49Z

Codecov Report

Attention: Patch coverage is 1.25000% with 79 lines in your changes missing coverage. Please review.

Project coverage is 15.85%. Comparing base (9967bb3) to head (91344bf).
Report is 6 commits behind head on 4.19.

Files with missing lines	Patch %	Lines
.../src/main/java/com/cloud/vm/UserVmManagerImpl.java	0.00%	57 Missing ⚠️
...ain/java/com/cloud/network/dao/NetworkDaoImpl.java	0.00%	22 Missing ⚠️

Additional details and impacted files

@@             Coverage Diff              @@
##               4.19   #10212      +/-   ##
============================================
+ Coverage     15.13%   15.85%   +0.72%     
- Complexity    11274    11279       +5     
============================================
  Files          5408     5042     -366     
  Lines        473974   444507   -29467     
  Branches      57813    52651    -5162     
============================================
- Hits          71730    70474    -1256     
+ Misses       394227   366156   -28071     
+ Partials       8017     7877     -140

Flag	Coverage Δ
uitests	`?`
unittests	`15.85% <1.25%> (-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.

blueorangutan · 2025-01-20T11:15:16Z

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

vishesh92 · 2025-01-20T12:28:21Z

@blueorangutan package

blueorangutan · 2025-01-20T12:30:03Z

@vishesh92 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-01-20T13:30:10Z

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

vishesh92 · 2025-01-21T10:45:36Z

@blueorangutan package

blueorangutan · 2025-01-21T10:46:04Z

@vishesh92 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-01-21T12:05:43Z

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

vishesh92 · 2025-01-21T12:42:09Z

@blueorangutan test

blueorangutan · 2025-01-21T12:44:03Z

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

blueorangutan · 2025-01-22T01:46:39Z

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

Test	Result	Time (s)	Test File
test_01_secure_vm_migration	`Error`	134.42	test_vm_life_cycle.py
test_01_secure_vm_migration	`Error`	134.42	test_vm_life_cycle.py
test_10_attachAndDetach_iso	`Error`	12.63	test_vm_life_cycle.py

DaanHoogland

clgtm

Pearl1594 · 2025-02-10T03:34:09Z

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

+            "Scope of resources to check while checking if the hostname is unique. Possible values are global, domain, subdomain, account, network.",
+            true, ConfigKey.Scope.Global, null, "VM distinct hostname scope", null, null, null, ConfigKey.Kind.Select,
+            "global,domain,subdomain,account,network");
+


Could you please help me understand what's the purpose of this global setting, if VM names have to be unique within a network domain?

So, the network domain can be same for networks in different domain, account, etc. If a user a launches a VM with the same name in these networks, there can be conflict. This global setting allows the user to set scope for what all networks we need to check when creating a vm.

DaanHoogland · 2025-03-05T18:05:35Z

@blueorangutan package

blueorangutan · 2025-03-05T18:06:04Z

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

blueorangutan · 2025-03-05T19:07:16Z

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

DaanHoogland · 2025-03-06T11:56:05Z

@blueorangutan test

blueorangutan · 2025-03-06T11:58:06Z

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

blueorangutan · 2025-03-07T01:07:31Z

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

Test	Result	Time (s)	Test File

Check for unique hostnames for all networks in the vpc

91a2ffe

vishesh92 linked an issue Jan 20, 2025 that may be closed by this pull request

Option to restrict duplicate instance names in same network domain, VPC etc #9775

Open

Add global setting vm.distinct.hostname.scope

8888b27

vishesh92 force-pushed the enforce-distinct-hostnames-network branch from befd5a5 to 8888b27 Compare January 20, 2025 12:27

vishesh92 marked this pull request as ready for review January 21, 2025 06:26

vishesh92 added the status:needs-review label Jan 21, 2025

DaanHoogland added this to the 4.19.2 milestone Jan 21, 2025

vishesh92 force-pushed the enforce-distinct-hostnames-network branch from d7336c1 to c9855aa Compare January 21, 2025 10:39

boring-cyborg bot added component:networking component:vpc labels Jan 21, 2025

vishesh92 force-pushed the enforce-distinct-hostnames-network branch 2 times, most recently from fbd4153 to 5aa2b60 Compare January 21, 2025 10:43

fixup

91344bf

vishesh92 force-pushed the enforce-distinct-hostnames-network branch from 5aa2b60 to 91344bf Compare January 21, 2025 10:44

apache deleted a comment from blueorangutan Jan 21, 2025

DaanHoogland approved these changes Jan 22, 2025

View reviewed changes

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

DaanHoogland requested a review from Pearl1594 January 30, 2025 08:59

DaanHoogland assigned Pearl1594 Jan 31, 2025

Pearl1594 reviewed Feb 10, 2025

View reviewed changes

DaanHoogland modified the milestones: 4.19.2, 4.19.3 Feb 11, 2025

Pearl1594 added this to ACS 4.20.1 Mar 17, 2025

Pearl1594 moved this to In Progress in ACS 4.20.1 Mar 17, 2025

DaanHoogland force-pushed the 4.19 branch from 8ef8b46 to 857ccb0 Compare May 27, 2025 14:20

sureshanaparti modified the milestones: 4.19.3, 4.19.4 Jun 5, 2025

Enforce distinct hostnames network #10212

Are you sure you want to change the base?

Enforce distinct hostnames network #10212

Uh oh!

Conversation

vishesh92 commented Jan 20, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

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!

vishesh92 commented Jan 20, 2025

Uh oh!

blueorangutan commented Jan 20, 2025

Uh oh!

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

Uh oh!

Codecov Report

Uh oh!

blueorangutan commented Jan 20, 2025

Uh oh!

vishesh92 commented Jan 20, 2025

Uh oh!

blueorangutan commented Jan 20, 2025

Uh oh!

blueorangutan commented Jan 20, 2025

Uh oh!

vishesh92 commented Jan 21, 2025

Uh oh!

blueorangutan commented Jan 21, 2025

Uh oh!

blueorangutan commented Jan 21, 2025

Uh oh!

vishesh92 commented Jan 21, 2025

Uh oh!

blueorangutan commented Jan 21, 2025

Uh oh!

blueorangutan commented Jan 22, 2025

Uh oh!

DaanHoogland left a comment

Choose a reason for hiding this comment

Uh oh!

Pearl1594 Feb 10, 2025

Choose a reason for hiding this comment

Uh oh!

vishesh92 Feb 10, 2025

Choose a reason for hiding this comment

Uh oh!

DaanHoogland commented Mar 5, 2025

Uh oh!

blueorangutan commented Mar 5, 2025

Uh oh!

blueorangutan commented Mar 5, 2025

Uh oh!

DaanHoogland commented Mar 6, 2025

Uh oh!

blueorangutan commented Mar 6, 2025

Uh oh!

blueorangutan commented Mar 7, 2025

Uh oh!

Uh oh!

vishesh92 commented Jan 20, 2025 •

edited

Loading

codecov bot commented Jan 20, 2025 •

edited

Loading