Support for custom SSH port for KVM hosts using the configuration#12571

Draft

sureshanaparti wants to merge 2 commits intoapache:4.20 from

Draft

Support for custom SSH port for KVM hosts using the configuration #12571
sureshanaparti wants to merge 2 commits intoapache:4.20 from
shapeblue:kvm-custom-ssh-port-support

Conversation


 Support for custom SSH port for KVM hosts using the configuration 'kv...

9692e29

...m.host.discovery.ssh.port'
- Use the custom SSH port for KVM host discovery to connect to the Host during Add Host command
- and any other operations on host using SSH

@boring-cyborg boring-cyborg bot added component:agent component:backup component:kvm component:orchestration labels

Feb 3, 2026

@sureshanaparti sureshanaparti added this to the 4.20.3 milestone

Feb 3, 2026

@sureshanaparti sureshanaparti requested review from DaanHoogland and nvazquez

February 3, 2026 09:54

@sureshanaparti

Copy link

Contributor Author

sureshanaparti commented Feb 3, 2026

@blueorangutan package

@blueorangutan

Copy link

blueorangutan commented Feb 3, 2026

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

@sureshanaparti sureshanaparti requested a review from abh1sar

February 3, 2026 09:59

@codecov

Copy link

codecov bot commented Feb 3, 2026 •

edited

Loading

Codecov Report

❌ Patch coverage is 33.33333% with 4 lines in your changes missing coverage. Please review.
✅ Project coverage is 16.26%. Comparing base (ce42ce5) to head (2e49b0c).
⚠️ Report is 1 commits behind head on 4.20.

Files with missing lines	Patch %	Lines
...che/cloudstack/backup/NetworkerBackupProvider.java	0.00%	2 Missing ⚠️
...rvisor/kvm/discoverer/LibvirtServerDiscoverer.java	0.00%	1 Missing ⚠️
...rc/main/java/com/cloud/utils/ssh/SSHCmdHelper.java	0.00%	1 Missing ⚠️

Additional details and impacted files

@@ Coverage Diff @@
## 4.20 #12571 +/- ##
=========================================
 Coverage 16.26% 16.26% 
 Complexity 13428 13428 
=========================================
 Files 5660 5660 
 Lines 499959 499964 +5 
 Branches 60707 60708 +1 
=========================================
+ Hits 81326 81331 +5 
+ Misses 409560 409559 -1 
- Partials 9073 9074 +1

Flag	Coverage Δ
uitests	`4.16% <ø> (ø)`
unittests	`17.12% <33.33%> (+<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.

@sureshanaparti sureshanaparti added the status:needs-testing label

Feb 3, 2026

@RosiKyu RosiKyu self-assigned this

Feb 3, 2026

@blueorangutan

Copy link

blueorangutan commented Feb 3, 2026

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

@sureshanaparti

Copy link

Contributor Author

sureshanaparti commented Feb 3, 2026

@blueorangutan test

@blueorangutan

Copy link

blueorangutan commented Feb 3, 2026

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

winterhazel

winterhazel reviewed

Feb 3, 2026

View reviewed changes

engine/components-api/src/main/java/com/cloud/agent/AgentManager.java

"This timeout overrides the wait global config. This holds a comma separated key value pairs containing timeout (in seconds) for specific commands. " +

"For example: DhcpEntryCommand=600, SavePasswordCommand=300, VmDataCommand=300", false);

ConfigKey<Integer> KVMHostDiscoverySshPort = new ConfigKey<>(ConfigKey.CATEGORY_ADVANCED, Integer.class,

Copy link

Member

@winterhazel winterhazel Feb 3, 2026 •

edited

Loading

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Wouldn't it be better to have this as a parameter on host addition/edit to allow configuring it on a host-level?

Copy link

Contributor

@DaanHoogland DaanHoogland Feb 3, 2026

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I think we can, but do we really want to allow to use a different ssh port for all hosts within a cluster? seems a bit overkill.

Copy link

Member

@winterhazel winterhazel Feb 4, 2026

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I don't see a problem allowing it. Maybe a single host needs to use a different port for SSH connection.

Copy link

Contributor

@DaanHoogland DaanHoogland Feb 4, 2026

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

ok, a bit of an edge case, only applicable to smaller installations I’d guess (in my ignorance). You are not asking to remove a higher level setting are you? just to add a per host parameter..

Copy link

Contributor Author

@sureshanaparti sureshanaparti Feb 4, 2026

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

the config is applicable for the kvm hosts on the entire cloudstack installation, mainly for large deployments where the custom port is used for all the hosts. it doesn't provide flexibility to set few hosts on one port, and few hosts on the other. it's always better to have all these hosts accessible on the same port. a new host parameter (that can be updated through add or update host call) can provide flexibility, but it's mostly NULL/empty (when not defined or default port is used) and is not applicable for VMware hosts.

Copy link

Contributor

@weizhouapache weizhouapache Feb 4, 2026

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

@nvazquez
I think it is fine to hardcode the default SSH port as 22, which is allocated by IANA
if user want to use a custom port, pass it as part of host url (host:port), it is more flexible

Copy link

Contributor

@DaanHoogland DaanHoogland Feb 5, 2026

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Guys, we have a customer asking ffor a per cluster configuration, So I propose the following;
if not part of the host field (i.e. localhost:22) check the host detail, else check the cluster setting, else 22.

makes sense everybody?

Copy link

Contributor

@nvazquez nvazquez Feb 5, 2026

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

LGTM @DaanHoogland - setting being global as it is now should also work

Copy link

Member

@winterhazel winterhazel Feb 5, 2026 •

edited

Loading

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

@DaanHoogland I suggest having either just host configuration stored on URL field -> cluster setting -> 22, or host configuration stored on host_detail -> cluster setting -> 22, depending on whichever is easier to implement without breaking compatibility.

Storing this configuration at two places for host-level seems unnecessary, and might just make it confusing.

Copy link

Contributor

@DaanHoogland DaanHoogland Feb 5, 2026

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

right, simplifying to:
if not part of the host field (i.e. localhost:22), check the cluster setting, else 22.

@blueorangutan

Copy link

blueorangutan commented Feb 4, 2026

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

Test	Result	Time (s)	Test File

sureshanaparti

sureshanaparti commented

Feb 4, 2026

View reviewed changes

engine/components-api/src/main/java/com/cloud/agent/AgentManager.java Outdated Show resolved Hide resolved

@sureshanaparti


 Update engine/components-api/src/main/java/com/cloud/agent/AgentManag...

2e49b0c

...er.java

DaanHoogland

DaanHoogland approved these changes

Feb 4, 2026

View reviewed changes

Copy link

Contributor

@DaanHoogland DaanHoogland left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

clgtm

@nvazquez nvazquez removed the status:needs-testing label

Feb 4, 2026

@RosiKyu RosiKyu removed their assignment

Feb 5, 2026

@nvazquez nvazquez marked this pull request as draft

February 5, 2026 14:19

Labels

component:agent component:backup component:kvm component:orchestration

7 participants

@sureshanaparti @blueorangutan @DaanHoogland @nvazquez @winterhazel @weizhouapache @RosiKyu

Conversation

@sureshanaparti sureshanaparti commented Feb 3, 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!

sureshanaparti commented Feb 3, 2026

Uh oh!

blueorangutan commented Feb 3, 2026

Uh oh!

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

Uh oh!

Codecov Report

Uh oh!

blueorangutan commented Feb 3, 2026

Uh oh!

sureshanaparti commented Feb 3, 2026

Uh oh!

blueorangutan commented Feb 3, 2026

Uh oh!

@winterhazel winterhazel Feb 3, 2026 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Choose a reason for hiding this comment

Uh oh!

@DaanHoogland DaanHoogland Feb 3, 2026

Choose a reason for hiding this comment

Uh oh!

@winterhazel winterhazel Feb 4, 2026

Choose a reason for hiding this comment

Uh oh!

@DaanHoogland DaanHoogland Feb 4, 2026

Choose a reason for hiding this comment

Uh oh!

@sureshanaparti sureshanaparti Feb 4, 2026

Choose a reason for hiding this comment

Uh oh!

@weizhouapache weizhouapache Feb 4, 2026

Choose a reason for hiding this comment

Uh oh!

@DaanHoogland DaanHoogland Feb 5, 2026

Choose a reason for hiding this comment

Uh oh!

@nvazquez nvazquez Feb 5, 2026

Choose a reason for hiding this comment

Uh oh!

@winterhazel winterhazel Feb 5, 2026 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Choose a reason for hiding this comment

Uh oh!

@DaanHoogland DaanHoogland Feb 5, 2026

Choose a reason for hiding this comment

Uh oh!

blueorangutan commented Feb 4, 2026

Uh oh!

Uh oh!

@DaanHoogland DaanHoogland left a comment

Choose a reason for hiding this comment

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

7 participants

codecov bot commented Feb 3, 2026 •

edited

Loading

@winterhazel winterhazel Feb 3, 2026 •

edited

Loading

@winterhazel winterhazel Feb 5, 2026 •

edited

Loading