From f095fb3e3f3d82247481899c1658d44fab78bf6c Mon Sep 17 00:00:00 2001 From: Abhishek Kumar Date: Thu, 11 Sep 2025 10:54:41 +0530 Subject: [PATCH 01/13] extensions: vnc console access Related: https://github.com/apache/cloudstack/pull/11601 Signed-off-by: Abhishek Kumar --- source/adminguide/extensions.rst | 4 ++- source/adminguide/extensions/developer.rst | 26 ++++++++++++++++++-- source/adminguide/extensions/limitations.rst | 4 +-- 3 files changed, 29 insertions(+), 5 deletions(-) diff --git a/source/adminguide/extensions.rst b/source/adminguide/extensions.rst index 071d6c688a..2a1c226337 100644 --- a/source/adminguide/extensions.rst +++ b/source/adminguide/extensions.rst @@ -64,7 +64,9 @@ An Orchestrator extension enables CloudStack to delegate VM orchestration to an - Hosts: Multiple hosts can be added to such clusters, ideally pointing to different physical or external hosts. - - Instance Lifecycle Support: Extensions can handle basic VM actions like prepare, deploy, start, stop, reboot, status and delete. + - Instance Lifecycle Support: Orchestrator extensions can handle basic VM actions like prepare, deploy, start, stop, reboot, status and delete. + + - Console Access: Instances can be accessed via VNC consoles. CloudStack retrieves console details from extensions using the ``getconsole`` action, and forwards them to the Console Proxy VM (CPVM) to provide users with console access. Currently, the built-in Proxmox extension supports console access for instances. - Configuration Details: Key-value configuration details can be specified at different levels - extension, cluster mapping, host, template, service offering, instance. diff --git a/source/adminguide/extensions/developer.rst b/source/adminguide/extensions/developer.rst index 492c846cae..0d8caed789 100644 --- a/source/adminguide/extensions/developer.rst +++ b/source/adminguide/extensions/developer.rst @@ -120,7 +120,29 @@ Action Lifecycle 1. A CloudStack action (e.g., deploy VM) triggers a corresponding extension action. 2. CloudStack invokes the extension’s executable with appropriate parameters. 3. The extension processes the input and responds within the timeout. -4. CloudStack continues orchestration based on the result. +4. CloudStack continues action workflow based on the result. + +Console Access for Instances with Orchestrator Extensions +^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ + +Orchestrator extensions can provide console access for instances via VNC. +To enable this, the extension must implement the ``getconsole`` action and return output in the following JSON format: + +.. code-block:: json + + { + ... + "console": { + "host": "pve-node1.internal", + "port": "5901", + "password": "PVEVNC:6329C6AA::ZPcs5MT....d9", + "protocol": "vnc" + } + } + +The returned details are forwarded to the Console Proxy VM (CPVM) running in the same zone as the instance. +It is required that the specified **host** and **port** are reachable from the CPVM. + Custom Actions ^^^^^^^^^^^^^^ @@ -183,4 +205,4 @@ For a clearer understanding of how to implement an extension, developers can ref It serves as a template with minimal required action handlers, making it a useful starting point for building new extensions. -Additionally, CloudStack includes built-in extensions for Proxmox and Hyper-V that demonstrate how to implement extensions in different languages - Bash and Python. +Additionally, CloudStack includes in-built extensions for Proxmox and Hyper-V that demonstrate how to implement extensions in different languages - Bash and Python. diff --git a/source/adminguide/extensions/limitations.rst b/source/adminguide/extensions/limitations.rst index a0b74d3481..5db3adaeac 100644 --- a/source/adminguide/extensions/limitations.rst +++ b/source/adminguide/extensions/limitations.rst @@ -24,8 +24,6 @@ by adding custom actions in the scripts written for the built-in extensions. **Some general features/actions not supported at the framework level:** - - Console access to the external Instances. - - Data volumes. - User Data and Metadata services. @@ -40,6 +38,8 @@ by adding custom actions in the scripts written for the built-in extensions. - Add Nics to Instance post deployment. + - Console access to the in-built Hyper-V orchestrator Instances. + **Actions which can be implemented using Custom Actions in built-in extensions:** - Reinstall Instance. From 7eb478f61d818233e7b0ffb8b457bc0939d82023 Mon Sep 17 00:00:00 2001 From: Abhishek Kumar Date: Thu, 11 Sep 2025 16:28:04 +0530 Subject: [PATCH 02/13] update Signed-off-by: Abhishek Kumar --- source/adminguide/extensions.rst | 2 +- source/adminguide/extensions/developer.rst | 23 ++++++++++++++++---- source/adminguide/extensions/limitations.rst | 2 +- 3 files changed, 21 insertions(+), 6 deletions(-) diff --git a/source/adminguide/extensions.rst b/source/adminguide/extensions.rst index 2a1c226337..65900bf072 100644 --- a/source/adminguide/extensions.rst +++ b/source/adminguide/extensions.rst @@ -66,7 +66,7 @@ An Orchestrator extension enables CloudStack to delegate VM orchestration to an - Instance Lifecycle Support: Orchestrator extensions can handle basic VM actions like prepare, deploy, start, stop, reboot, status and delete. - - Console Access: Instances can be accessed via VNC consoles. CloudStack retrieves console details from extensions using the ``getconsole`` action, and forwards them to the Console Proxy VM (CPVM) to provide users with console access. Currently, the built-in Proxmox extension supports console access for instances. + - Console Access: Instances can be accessed either via VNC consoles or through a direct URL, depending on the capabilities of the orchestrator extension. CloudStack retrieves console details from extensions using the ``getconsole`` action and either forwards them to the Console Proxy VM (CPVM) (for VNC access) or provides the direct console URL to the user. Out of the box, only the built-in Proxmox extension supports console access for instances. - Configuration Details: Key-value configuration details can be specified at different levels - extension, cluster mapping, host, template, service offering, instance. diff --git a/source/adminguide/extensions/developer.rst b/source/adminguide/extensions/developer.rst index 0d8caed789..e50da7c9ef 100644 --- a/source/adminguide/extensions/developer.rst +++ b/source/adminguide/extensions/developer.rst @@ -125,12 +125,15 @@ Action Lifecycle Console Access for Instances with Orchestrator Extensions ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ -Orchestrator extensions can provide console access for instances via VNC. -To enable this, the extension must implement the ``getconsole`` action and return output in the following JSON format: +Orchestrator extensions can provide console access for instances either through **VNC** or a **direct URL**. +To enable this, the extension must implement the ``getconsole`` action and return output in one of the following JSON formats: + +VNC-based console: .. code-block:: json { + "status": "success", ... "console": { "host": "pve-node1.internal", @@ -140,8 +143,20 @@ To enable this, the extension must implement the ``getconsole`` action and retur } } -The returned details are forwarded to the Console Proxy VM (CPVM) running in the same zone as the instance. -It is required that the specified **host** and **port** are reachable from the CPVM. +For VNC-based access, the returned details are forwarded to the Console Proxy VM (CPVM) in the same zone as the instance. The specified **host** and **port** must be reachable from the CPVM. + +Direct URL-based console: + +.. code-block:: json + + { + "status": "success", + ... + "console": { + "url": "CONSOLE_URL", + "protocol": "direct" + } + } Custom Actions diff --git a/source/adminguide/extensions/limitations.rst b/source/adminguide/extensions/limitations.rst index 5db3adaeac..b9c974aa87 100644 --- a/source/adminguide/extensions/limitations.rst +++ b/source/adminguide/extensions/limitations.rst @@ -38,7 +38,7 @@ by adding custom actions in the scripts written for the built-in extensions. - Add Nics to Instance post deployment. - - Console access to the in-built Hyper-V orchestrator Instances. + - Console access for instances using the built-in Hyper-V orchestrator is not available out of the box. **Actions which can be implemented using Custom Actions in built-in extensions:** From ed0f1192685e96290bbe2d138d8767fb891047dc Mon Sep 17 00:00:00 2001 From: Abhishek Kumar Date: Thu, 11 Sep 2025 16:56:24 +0530 Subject: [PATCH 03/13] add note Signed-off-by: Abhishek Kumar --- source/adminguide/extensions/developer.rst | 4 ++++ 1 file changed, 4 insertions(+) diff --git a/source/adminguide/extensions/developer.rst b/source/adminguide/extensions/developer.rst index e50da7c9ef..d137a0ed70 100644 --- a/source/adminguide/extensions/developer.rst +++ b/source/adminguide/extensions/developer.rst @@ -159,6 +159,10 @@ Direct URL-based console: } +.. note:: + For direct URL–based console access, CloudStack does not report the acquired or client IP address. + In this mode, security and access control must be handled by the server providing the console. + Custom Actions ^^^^^^^^^^^^^^ From 19124f3a45a36ab0cbc9feac01dfcd5706d24ba7 Mon Sep 17 00:00:00 2001 From: Abhishek Kumar Date: Fri, 12 Sep 2025 09:58:57 +0530 Subject: [PATCH 04/13] review Signed-off-by: Abhishek Kumar --- source/adminguide/extensions.rst | 2 +- source/adminguide/extensions/inbuilt_extensions.rst | 4 ++++ source/adminguide/extensions/limitations.rst | 2 -- 3 files changed, 5 insertions(+), 3 deletions(-) diff --git a/source/adminguide/extensions.rst b/source/adminguide/extensions.rst index 65900bf072..49f843caec 100644 --- a/source/adminguide/extensions.rst +++ b/source/adminguide/extensions.rst @@ -66,7 +66,7 @@ An Orchestrator extension enables CloudStack to delegate VM orchestration to an - Instance Lifecycle Support: Orchestrator extensions can handle basic VM actions like prepare, deploy, start, stop, reboot, status and delete. - - Console Access: Instances can be accessed either via VNC consoles or through a direct URL, depending on the capabilities of the orchestrator extension. CloudStack retrieves console details from extensions using the ``getconsole`` action and either forwards them to the Console Proxy VM (CPVM) (for VNC access) or provides the direct console URL to the user. Out of the box, only the built-in Proxmox extension supports console access for instances. + - Console Access: Instances can be accessed either via VNC consoles or through a direct URL, depending on the capabilities of the orchestrator extension. CloudStack retrieves console details from extensions using the ``getconsole`` action and either forwards them to the Console Proxy VM (CPVM) (for VNC access) or provides the direct console URL to the user. Since 4.22.0, out-of-the-box console access support is available for instances deployed using the in-built Proxmox extension. See :ref:`Console Access for Instances with Orchestrator Extensions `for details on adding console access support in developed extensions. - Configuration Details: Key-value configuration details can be specified at different levels - extension, cluster mapping, host, template, service offering, instance. diff --git a/source/adminguide/extensions/inbuilt_extensions.rst b/source/adminguide/extensions/inbuilt_extensions.rst index 758941fce6..6b9da9010a 100644 --- a/source/adminguide/extensions/inbuilt_extensions.rst +++ b/source/adminguide/extensions/inbuilt_extensions.rst @@ -33,6 +33,8 @@ The Proxmox CloudStack Extension is written in shell script and communicates wit Before using the Proxmox Extension, ensure that the Proxmox Datacenter is configured correctly and accessible to CloudStack. +Since 4.22.0, console access support is available for instances deployed using the in-built Proxmox extension via VNC and console proxy VM. + Get the API Token-Secret from Proxmox ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ @@ -161,6 +163,8 @@ using NTLM authentication for secure remote execution of PowerShell commands tha Each Hyper-V host maps to a CloudStack Host. Before using the Hyper-V Extension, ensure that the Hyper-V host is accessible to the CloudStack Management Server via WinRM over HTTPS. +Console access for instances using the Hyper-V extension is not available out of the box. + Configuring WinRM over HTTPS ~~~~~~~~~~~~~~~~~~~~~~~~~~~~ diff --git a/source/adminguide/extensions/limitations.rst b/source/adminguide/extensions/limitations.rst index b9c974aa87..d043565b79 100644 --- a/source/adminguide/extensions/limitations.rst +++ b/source/adminguide/extensions/limitations.rst @@ -38,8 +38,6 @@ by adding custom actions in the scripts written for the built-in extensions. - Add Nics to Instance post deployment. - - Console access for instances using the built-in Hyper-V orchestrator is not available out of the box. - **Actions which can be implemented using Custom Actions in built-in extensions:** - Reinstall Instance. From 56997a559a7abd3d0bac5f4f9429423f1ff21770 Mon Sep 17 00:00:00 2001 From: Abhishek Kumar Date: Sun, 14 Sep 2025 08:58:57 +0530 Subject: [PATCH 05/13] Update source/adminguide/extensions/inbuilt_extensions.rst --- source/adminguide/extensions/inbuilt_extensions.rst | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/source/adminguide/extensions/inbuilt_extensions.rst b/source/adminguide/extensions/inbuilt_extensions.rst index 6b9da9010a..2c82c02b00 100644 --- a/source/adminguide/extensions/inbuilt_extensions.rst +++ b/source/adminguide/extensions/inbuilt_extensions.rst @@ -163,7 +163,7 @@ using NTLM authentication for secure remote execution of PowerShell commands tha Each Hyper-V host maps to a CloudStack Host. Before using the Hyper-V Extension, ensure that the Hyper-V host is accessible to the CloudStack Management Server via WinRM over HTTPS. -Console access for instances using the Hyper-V extension is not available out of the box. +Console access for instances deployed using the Hyper-V extension is not available out of the box. Configuring WinRM over HTTPS ~~~~~~~~~~~~~~~~~~~~~~~~~~~~ From 1fd5cec8425e61389ae528c5c76758b2b2471703 Mon Sep 17 00:00:00 2001 From: Abhishek Kumar Date: Wed, 17 Sep 2025 16:35:58 +0530 Subject: [PATCH 06/13] changes Signed-off-by: Abhishek Kumar --- source/adminguide/extensions/developer.rst | 2 ++ source/adminguide/extensions/inbuilt_extensions.rst | 2 +- 2 files changed, 3 insertions(+), 1 deletion(-) diff --git a/source/adminguide/extensions/developer.rst b/source/adminguide/extensions/developer.rst index d137a0ed70..225fa40158 100644 --- a/source/adminguide/extensions/developer.rst +++ b/source/adminguide/extensions/developer.rst @@ -163,6 +163,8 @@ Direct URL-based console: For direct URL–based console access, CloudStack does not report the acquired or client IP address. In this mode, security and access control must be handled by the server providing the console. + Protocol value for direct URL–based console access can be any of the following value - link, direct, url. + Custom Actions ^^^^^^^^^^^^^^ diff --git a/source/adminguide/extensions/inbuilt_extensions.rst b/source/adminguide/extensions/inbuilt_extensions.rst index 2c82c02b00..9c4f173bf4 100644 --- a/source/adminguide/extensions/inbuilt_extensions.rst +++ b/source/adminguide/extensions/inbuilt_extensions.rst @@ -33,7 +33,7 @@ The Proxmox CloudStack Extension is written in shell script and communicates wit Before using the Proxmox Extension, ensure that the Proxmox Datacenter is configured correctly and accessible to CloudStack. -Since 4.22.0, console access support is available for instances deployed using the in-built Proxmox extension via VNC and console proxy VM. +Since 4.22.0, console access support is available for instances deployed using the in-built Proxmox extension via VNC and console proxy VM. Only one console session will successfully connect at a time per instance. Get the API Token-Secret from Proxmox ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ From 6ce89d15e28b497648936eb466d90b5d345face5 Mon Sep 17 00:00:00 2001 From: Abhishek Kumar Date: Thu, 18 Sep 2025 16:10:05 +0530 Subject: [PATCH 07/13] fix Signed-off-by: Abhishek Kumar --- source/adminguide/extensions/developer.rst | 3 +++ source/adminguide/extensions/inbuilt_extensions.rst | 2 +- 2 files changed, 4 insertions(+), 1 deletion(-) diff --git a/source/adminguide/extensions/developer.rst b/source/adminguide/extensions/developer.rst index 225fa40158..9fbd36155a 100644 --- a/source/adminguide/extensions/developer.rst +++ b/source/adminguide/extensions/developer.rst @@ -139,10 +139,13 @@ VNC-based console: "host": "pve-node1.internal", "port": "5901", "password": "PVEVNC:6329C6AA::ZPcs5MT....d9", + "passwordonetimeuseonly": true "protocol": "vnc" } } +``passwordonetimeuseonly`` is optional. It can be set to ``true`` if the system returns a one-time-use VNC ticket. + For VNC-based access, the returned details are forwarded to the Console Proxy VM (CPVM) in the same zone as the instance. The specified **host** and **port** must be reachable from the CPVM. Direct URL-based console: diff --git a/source/adminguide/extensions/inbuilt_extensions.rst b/source/adminguide/extensions/inbuilt_extensions.rst index 9c4f173bf4..2c82c02b00 100644 --- a/source/adminguide/extensions/inbuilt_extensions.rst +++ b/source/adminguide/extensions/inbuilt_extensions.rst @@ -33,7 +33,7 @@ The Proxmox CloudStack Extension is written in shell script and communicates wit Before using the Proxmox Extension, ensure that the Proxmox Datacenter is configured correctly and accessible to CloudStack. -Since 4.22.0, console access support is available for instances deployed using the in-built Proxmox extension via VNC and console proxy VM. Only one console session will successfully connect at a time per instance. +Since 4.22.0, console access support is available for instances deployed using the in-built Proxmox extension via VNC and console proxy VM. Get the API Token-Secret from Proxmox ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ From e7785a38710aea1bbf96fda3ac186f1c58590d30 Mon Sep 17 00:00:00 2001 From: Abhishek Kumar Date: Fri, 19 Sep 2025 10:27:30 +0530 Subject: [PATCH 08/13] note on proxmox connnection Signed-off-by: Abhishek Kumar --- source/adminguide/extensions/inbuilt_extensions.rst | 1 + 1 file changed, 1 insertion(+) diff --git a/source/adminguide/extensions/inbuilt_extensions.rst b/source/adminguide/extensions/inbuilt_extensions.rst index 2c82c02b00..d115bd70e8 100644 --- a/source/adminguide/extensions/inbuilt_extensions.rst +++ b/source/adminguide/extensions/inbuilt_extensions.rst @@ -34,6 +34,7 @@ The Proxmox CloudStack Extension is written in shell script and communicates wit Before using the Proxmox Extension, ensure that the Proxmox Datacenter is configured correctly and accessible to CloudStack. Since 4.22.0, console access support is available for instances deployed using the in-built Proxmox extension via VNC and console proxy VM. +Proxmox VNC connections are short-lived (about 10 seconds) for the initial connection. A console endpoint created using the ``createConsoleEndpoint`` API may not remain valid if accessed later. It is recommended to use the CloudStack UI to access the console. Get the API Token-Secret from Proxmox ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ From 4ac647608b8e0762b012898a843e694f74a6b6db Mon Sep 17 00:00:00 2001 From: Abhishek Kumar Date: Fri, 19 Sep 2025 12:36:29 +0530 Subject: [PATCH 09/13] clarity Signed-off-by: Abhishek Kumar --- source/adminguide/extensions/inbuilt_extensions.rst | 8 +++++++- 1 file changed, 7 insertions(+), 1 deletion(-) diff --git a/source/adminguide/extensions/inbuilt_extensions.rst b/source/adminguide/extensions/inbuilt_extensions.rst index d115bd70e8..34df6507f3 100644 --- a/source/adminguide/extensions/inbuilt_extensions.rst +++ b/source/adminguide/extensions/inbuilt_extensions.rst @@ -34,7 +34,13 @@ The Proxmox CloudStack Extension is written in shell script and communicates wit Before using the Proxmox Extension, ensure that the Proxmox Datacenter is configured correctly and accessible to CloudStack. Since 4.22.0, console access support is available for instances deployed using the in-built Proxmox extension via VNC and console proxy VM. -Proxmox VNC connections are short-lived (about 10 seconds) for the initial connection. A console endpoint created using the ``createConsoleEndpoint`` API may not remain valid if accessed later. It is recommended to use the CloudStack UI to access the console. + +.. note:: + Proxmox VNC connections have a short initial connection timeout (about 10 seconds), + even when accessing the console from the CloudStack UI. If the noVNC interface takes + longer to load, or if there is a delay between creating the console endpoint and + opening it, the connection may fail on the first attempt. In such cases, users can + simply retry to establish the console session. Get the API Token-Secret from Proxmox ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ From 74ee97875e3f8e3cdb4dfdc1f8f8b665626f2a2d Mon Sep 17 00:00:00 2001 From: Abhishek Kumar Date: Thu, 25 Sep 2025 12:26:45 +0530 Subject: [PATCH 10/13] fix Signed-off-by: Abhishek Kumar --- source/adminguide/extensions.rst | 2 +- source/adminguide/extensions/developer.rst | 2 +- 2 files changed, 2 insertions(+), 2 deletions(-) diff --git a/source/adminguide/extensions.rst b/source/adminguide/extensions.rst index 49f843caec..f42d12367a 100644 --- a/source/adminguide/extensions.rst +++ b/source/adminguide/extensions.rst @@ -64,7 +64,7 @@ An Orchestrator extension enables CloudStack to delegate VM orchestration to an - Hosts: Multiple hosts can be added to such clusters, ideally pointing to different physical or external hosts. - - Instance Lifecycle Support: Orchestrator extensions can handle basic VM actions like prepare, deploy, start, stop, reboot, status and delete. + - Instance Lifecycle Supported: Orchestrator extensions can handle basic VM actions like prepare, deploy, start, stop, reboot, status and delete. - Console Access: Instances can be accessed either via VNC consoles or through a direct URL, depending on the capabilities of the orchestrator extension. CloudStack retrieves console details from extensions using the ``getconsole`` action and either forwards them to the Console Proxy VM (CPVM) (for VNC access) or provides the direct console URL to the user. Since 4.22.0, out-of-the-box console access support is available for instances deployed using the in-built Proxmox extension. See :ref:`Console Access for Instances with Orchestrator Extensions `for details on adding console access support in developed extensions. diff --git a/source/adminguide/extensions/developer.rst b/source/adminguide/extensions/developer.rst index 9fbd36155a..72dc16a58e 100644 --- a/source/adminguide/extensions/developer.rst +++ b/source/adminguide/extensions/developer.rst @@ -166,7 +166,7 @@ Direct URL-based console: For direct URL–based console access, CloudStack does not report the acquired or client IP address. In this mode, security and access control must be handled by the server providing the console. - Protocol value for direct URL–based console access can be any of the following value - link, direct, url. + Protocol value of ``direct`` can be used for direct URL–based console access. Custom Actions ^^^^^^^^^^^^^^ From 2e801631c81463ee63430a400e406852398ad21c Mon Sep 17 00:00:00 2001 From: Abhishek Kumar Date: Thu, 25 Sep 2025 12:32:55 +0530 Subject: [PATCH 11/13] more changes Signed-off-by: Abhishek Kumar --- source/adminguide/extensions/developer.rst | 6 +++--- 1 file changed, 3 insertions(+), 3 deletions(-) diff --git a/source/adminguide/extensions/developer.rst b/source/adminguide/extensions/developer.rst index 72dc16a58e..7880b8ca40 100644 --- a/source/adminguide/extensions/developer.rst +++ b/source/adminguide/extensions/developer.rst @@ -125,7 +125,7 @@ Action Lifecycle Console Access for Instances with Orchestrator Extensions ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ -Orchestrator extensions can provide console access for instances either through **VNC** or a **direct URL**. +Orchestrator extensions can provide console access for instances either through **VNC** or a **URL**. To enable this, the extension must implement the ``getconsole`` action and return output in one of the following JSON formats: VNC-based console: @@ -163,10 +163,10 @@ Direct URL-based console: .. note:: - For direct URL–based console access, CloudStack does not report the acquired or client IP address. + For URL–based console access, CloudStack does not report the acquired or client IP address. In this mode, security and access control must be handled by the server providing the console. - Protocol value of ``direct`` can be used for direct URL–based console access. + Protocol value of ``direct`` can be used for URL–based console access. Custom Actions ^^^^^^^^^^^^^^ From 36bef4b278c60df4e192b60de10c6d58f4385556 Mon Sep 17 00:00:00 2001 From: Abhishek Kumar Date: Thu, 25 Sep 2025 12:33:55 +0530 Subject: [PATCH 12/13] change Signed-off-by: Abhishek Kumar --- source/adminguide/extensions.rst | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/source/adminguide/extensions.rst b/source/adminguide/extensions.rst index f42d12367a..10fe360eae 100644 --- a/source/adminguide/extensions.rst +++ b/source/adminguide/extensions.rst @@ -66,7 +66,7 @@ An Orchestrator extension enables CloudStack to delegate VM orchestration to an - Instance Lifecycle Supported: Orchestrator extensions can handle basic VM actions like prepare, deploy, start, stop, reboot, status and delete. - - Console Access: Instances can be accessed either via VNC consoles or through a direct URL, depending on the capabilities of the orchestrator extension. CloudStack retrieves console details from extensions using the ``getconsole`` action and either forwards them to the Console Proxy VM (CPVM) (for VNC access) or provides the direct console URL to the user. Since 4.22.0, out-of-the-box console access support is available for instances deployed using the in-built Proxmox extension. See :ref:`Console Access for Instances with Orchestrator Extensions `for details on adding console access support in developed extensions. + - Console Access: Instances can be accessed either via VNC consoles or through a URL, depending on the capabilities of the orchestrator extension. CloudStack retrieves console details from extensions using the ``getconsole`` action and either forwards them to the Console Proxy VM (CPVM) (for VNC access) or provides the external console URL to the user. Since 4.22.0, out-of-the-box console access support is available for instances deployed using the in-built Proxmox extension. See :ref:`Console Access for Instances with Orchestrator Extensions `for details on adding console access support in developed extensions. - Configuration Details: Key-value configuration details can be specified at different levels - extension, cluster mapping, host, template, service offering, instance. From a033fd6f54ec5a38fad89be4bc6d44d208c96458 Mon Sep 17 00:00:00 2001 From: Abhishek Kumar Date: Thu, 25 Sep 2025 16:17:10 +0530 Subject: [PATCH 13/13] more Signed-off-by: Abhishek Kumar --- source/adminguide/extensions/developer.rst | 10 +++++++++- 1 file changed, 9 insertions(+), 1 deletion(-) diff --git a/source/adminguide/extensions/developer.rst b/source/adminguide/extensions/developer.rst index 7880b8ca40..cd9bc976b4 100644 --- a/source/adminguide/extensions/developer.rst +++ b/source/adminguide/extensions/developer.rst @@ -94,7 +94,15 @@ Example: "name": "i-2-100-VM", ... }, - "virtualmachinename": "i-2-100-VM" + "virtualmachinename": "i-2-100-VM", + "caller": { + "roleid": "6b86674b-7e61-11f0-ba77-1e00c8000158", + "rolename": "Root Admin", + "name": "admin", + "roletype": "Admin", + "id": "93567ed9-7e61-11f0-ba77-1e00c8000158", + "type": "ADMIN" + } } The schema varies depending on the resource and action. Use this to perform context-specific logic.