extension/proxmox: add console access for instances #11601

shwstppr · 2025-09-09T13:43:59Z

Description

This PR introduces console access support for instances deployed using Orchestrator Extensions, available via either VNC or a direct URL.

CloudStack queries the extension using the getconsole action.
For VNC-based access, the extension must return host/port/ticket details. CloudStack then forwards these to the Console Proxy VM (CPVM) in the instance’s zone. It is assumed that the CPVM can reach the specified host and port.
For direct URL access, the extension returns a console URL with the protocol set to direct, url, or link. The URL is then provided directly to the user.
The built-in Proxmox Orchestrator Extension now supports console access via VNC. The extension calls the Proxmox API to fetch console details and returns them in the required format.

Documentation PR: apache/cloudstack-documentation#560

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):

proxmox-console.mp4

How Has This Been Tested?

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

Add console access support for the instances deployed using inbuilt Proxmox Orchestrator extension. Underlying CloudStack queries Proxmox API for console and then passes the ticket and host to the CPVM for the zone. During the flow it is assumed CPVM will be able to access the instance (Proxmox) host. Signed-off-by: Abhishek Kumar <[email protected]>

shwstppr · 2025-09-09T13:47:33Z

@blueorangutan package

blueorangutan · 2025-09-09T13:48:04Z

@shwstppr 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-09-09T13:52:31Z

Codecov Report

❌ Patch coverage is 66.25000% with 135 lines in your changes missing coverage. Please review.
✅ Project coverage is 17.46%. Comparing base (0526ec0) to head (19814b0).
⚠️ Report is 13 commits behind head on main.

Files with missing lines	Patch %	Lines
...com/cloud/agent/api/GetExternalConsoleCommand.java	0.00%	21 Missing ⚠️
.../com/cloud/consoleproxy/vnc/network/NioSocket.java	0.00%	16 Missing ⚠️
.../com/cloud/agent/api/GetExternalConsoleAnswer.java	48.27%	15 Missing ⚠️
...udstack/consoleproxy/ConsoleAccessManagerImpl.java	92.81%	9 Missing and 4 partials ⚠️
...al/provisioner/ExternalPathPayloadProvisioner.java	82.85%	7 Missing and 5 partials ⚠️
...om/cloud/consoleproxy/ConsoleProxyClientParam.java	0.00%	9 Missing ⚠️
...in/java/com/cloud/servlet/ConsoleProxyServlet.java	0.00%	8 Missing ⚠️
...om/cloud/consoleproxy/ConsoleProxyNoVncClient.java	0.00%	8 Missing ⚠️
...hypervisor/external/resource/ExternalResource.java	0.00%	7 Missing ⚠️
...work/extensions/manager/ExtensionsManagerImpl.java	75.00%	2 Missing and 4 partials ⚠️
... and 7 more

Additional details and impacted files

@@             Coverage Diff              @@
##               main   #11601      +/-   ##
============================================
+ Coverage     17.39%   17.46%   +0.07%     
- Complexity    15285    15366      +81     
============================================
  Files          5889     5893       +4     
  Lines        526183   526581     +398     
  Branches      64242    64289      +47     
============================================
+ Hits          91542    91980     +438     
+ Misses       424297   424236      -61     
- Partials      10344    10365      +21

Flag	Coverage Δ
uitests	`3.61% <ø> (-0.01%)`	⬇️
unittests	`18.52% <66.25%> (+0.07%)`	⬆️

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 · 2025-09-09T15:18:35Z

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

Signed-off-by: Abhishek Kumar <[email protected]>

Copilot

Pull Request Overview

Add console access support for instances deployed using the inbuilt Proxmox Orchestrator extension. CloudStack queries the Proxmox API for console credentials and passes them to the CPVM for the zone.

Enables console access for External hypervisor instances by removing restriction
Implements console command handling for External/Proxmox instances
Adds proper authentication bypass for External hypervisors

Reviewed Changes

Copilot reviewed 20 out of 20 changed files in this pull request and generated 7 comments.

Show a summary per file

File	Description
ui/src/components/view/ActionButton.vue	Removes External hypervisor restriction from console buttons
server/src/main/java/org/apache/cloudstack/consoleproxy/ConsoleAccessManagerImpl.java	Adds console connection details handling for External hypervisors with proper fallback logic
server/src/main/java/com/cloud/servlet/ConsoleProxyServlet.java	Adds authentication bypass for External hypervisor instances
server/src/main/java/com/cloud/consoleproxy/AgentHookBase.java	Adds authentication bypass for External hypervisor instances
server/src/main/java/com/cloud/server/ManagementServerImpl.java	Implements getExternalVmConsole method
extensions/Proxmox/proxmox.sh	Adds getconsole action for Proxmox VNC proxy support
Multiple test files	Comprehensive test coverage for new console functionality
Multiple API/framework files	New command classes and framework integration

_{Tip: Customize your code reviews with copilot-instructions.md. Create the file or learn how to get started.}

server/src/test/java/org/apache/cloudstack/consoleproxy/ConsoleAccessManagerImplTest.java

server/src/main/java/org/apache/cloudstack/consoleproxy/ConsoleAccessManagerImpl.java

Signed-off-by: Abhishek Kumar <[email protected]>

shwstppr · 2025-09-10T10:57:28Z

@blueorangutan package

blueorangutan · 2025-09-10T10:58:04Z

@shwstppr 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-09-10T12:15:24Z

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

nvazquez

Thanks @shwstppr LGTM - left only some minor comments.

It would worth documenting what CloudStack expects from external extensions in order to display the console correctly.

.../src/main/java/org/apache/cloudstack/framework/extensions/manager/ExtensionsManagerImpl.java

...va/org/apache/cloudstack/hypervisor/external/provisioner/ExternalPathPayloadProvisioner.java

Related: apache/cloudstack#11601 Signed-off-by: Abhishek Kumar <[email protected]>

Signed-off-by: Abhishek Kumar <[email protected]>

shwstppr · 2025-09-11T18:16:25Z

@blueorangutan package

blueorangutan · 2025-09-11T18:18:04Z

@shwstppr 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-09-11T19:53:36Z

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

nvazquez · 2025-09-12T01:06:55Z

@blueorangutan test

blueorangutan · 2025-09-12T01:08:04Z

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

blueorangutan · 2025-09-12T01:21:44Z

[SF] Trillian Build Failed (tid-14299)

abh1sar

LGTM

shwstppr · 2025-09-13T07:08:12Z

@blueorangutan test

blueorangutan · 2025-09-13T07:10:04Z

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

blueorangutan · 2025-09-13T23:39:45Z

[SF] Trillian test result (tid-14317)
Environment: kvm-ol8 (x2), zone: Advanced Networking with Mgmt server ol8
Total time taken: 56445 seconds
Marvin logs: https://github.com/blueorangutan/acs-prs/releases/download/trillian/pr11601-t14317-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`	26.86	test_kubernetes_clusters.py

Signed-off-by: Abhishek Kumar <[email protected]>

shwstppr · 2025-09-18T10:35:19Z

@blueorangutan package

blueorangutan · 2025-09-18T10:36:03Z

@shwstppr 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-09-18T12:07:53Z

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

shwstppr · 2025-09-20T10:55:24Z

@blueorangutan test

blueorangutan · 2025-09-20T10:56:04Z

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

blueorangutan · 2025-09-21T03:59:14Z

[SF] Trillian test result (tid-14403)
Environment: kvm-ol8 (x2), zone: Advanced Networking with Mgmt server ol8
Total time taken: 58393 seconds
Marvin logs: https://github.com/blueorangutan/acs-prs/releases/download/trillian/pr11601-t14403-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.94	test_kubernetes_clusters.py

Signed-off-by: Abhishek Kumar <[email protected]>

shwstppr · 2025-09-23T10:31:48Z

@blueorangutan package

blueorangutan · 2025-09-23T10:34:04Z

@shwstppr 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-09-23T11:50:56Z

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

boring-cyborg bot added component:api component:management-server component:UI labels Sep 9, 2025

shwstppr added this to the 4.22.0 milestone Sep 9, 2025

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

harikrishna-patnala moved this to In Progress in Apache CloudStack 4.22.0 Sep 10, 2025

shwstppr added 2 commits September 10, 2025 14:15

match response

c5a727e

Signed-off-by: Abhishek Kumar <[email protected]>

tests and changes

85deee8

Signed-off-by: Abhishek Kumar <[email protected]>

shwstppr requested a review from Copilot September 10, 2025 10:09

Copilot AI reviewed Sep 10, 2025

View reviewed changes

fix typo

0617ed4

Signed-off-by: Abhishek Kumar <[email protected]>

shwstppr requested review from nvazquez and abh1sar September 10, 2025 11:31

shwstppr added component:extensions component:console-proxy labels Sep 10, 2025

nvazquez approved these changes Sep 11, 2025

View reviewed changes

.../src/main/java/org/apache/cloudstack/framework/extensions/manager/ExtensionsManagerImpl.java Outdated Show resolved Hide resolved

...va/org/apache/cloudstack/hypervisor/external/provisioner/ExternalPathPayloadProvisioner.java Outdated Show resolved Hide resolved

shwstppr added a commit to shapeblue/cloudstack-documentation that referenced this pull request Sep 11, 2025

extensions: vnc console access

f095fb3

Related: apache/cloudstack#11601 Signed-off-by: Abhishek Kumar <[email protected]>

shwstppr mentioned this pull request Sep 11, 2025

extensions: instance console access apache/cloudstack-documentation#560

Open

shwstppr added 2 commits September 11, 2025 11:29

improve log, error

d5c642a

Signed-off-by: Abhishek Kumar <[email protected]>

Merge remote-tracking branch 'apache/main' into proxmox-console

2f6234b

rohityadavcloud requested a review from harikrishna-patnala September 11, 2025 07:32

server,extension: allow returning direct console url

63f5f94

Signed-off-by: Abhishek Kumar <[email protected]>

boring-cyborg bot added the Python Warning... Python code Ahead! label Sep 11, 2025

abh1sar approved these changes Sep 12, 2025

View reviewed changes

shwstppr added 4 commits September 18, 2025 13:34

change for one-time ticket as password

5f95f77

Signed-off-by: Abhishek Kumar <[email protected]>

Merge remote-tracking branch 'apache/main' into proxmox-console

a3846c2

main merge test fix

c3a0d46

Signed-off-by: Abhishek Kumar <[email protected]>

fix on cpvm

f82ee7d

Signed-off-by: Abhishek Kumar <[email protected]>

apache deleted a comment from blueorangutan Sep 18, 2025

shwstppr closed this Sep 20, 2025

github-project-automation bot moved this from In Progress to Done in Apache CloudStack 4.22.0 Sep 20, 2025

shwstppr reopened this Sep 20, 2025

console-proxy: close session if unable to connect to VNC server

19814b0

Signed-off-by: Abhishek Kumar <[email protected]>

extension/proxmox: add console access for instances #11601

Are you sure you want to change the base?

extension/proxmox: add console access for instances #11601

Uh oh!

Conversation

shwstppr commented Sep 9, 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!

shwstppr commented Sep 9, 2025

Uh oh!

blueorangutan commented Sep 9, 2025

Uh oh!

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

Uh oh!

Codecov Report

Uh oh!

blueorangutan commented Sep 9, 2025

Uh oh!

Copilot AI left a comment

Choose a reason for hiding this comment

Pull Request Overview

Reviewed Changes

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

shwstppr commented Sep 10, 2025

Uh oh!

blueorangutan commented Sep 10, 2025

Uh oh!

blueorangutan commented Sep 10, 2025

Uh oh!

nvazquez left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

shwstppr commented Sep 11, 2025

Uh oh!

blueorangutan commented Sep 11, 2025

Uh oh!

blueorangutan commented Sep 11, 2025

Uh oh!

nvazquez commented Sep 12, 2025

Uh oh!

blueorangutan commented Sep 12, 2025

Uh oh!

blueorangutan commented Sep 12, 2025

Uh oh!

abh1sar left a comment

Choose a reason for hiding this comment

Uh oh!

shwstppr commented Sep 13, 2025

Uh oh!

blueorangutan commented Sep 13, 2025

Uh oh!

blueorangutan commented Sep 13, 2025

Uh oh!

shwstppr commented Sep 18, 2025

Uh oh!

blueorangutan commented Sep 18, 2025

Uh oh!

blueorangutan commented Sep 18, 2025

Uh oh!

shwstppr commented Sep 20, 2025

Uh oh!

blueorangutan commented Sep 20, 2025

Uh oh!

shwstppr commented Sep 9, 2025 •

edited

Loading

codecov bot commented Sep 9, 2025 •

edited

Loading