Skip to content

Commit 7eb478f

Browse files
committed
update
Signed-off-by: Abhishek Kumar <[email protected]>
1 parent f095fb3 commit 7eb478f

File tree

3 files changed

+21
-6
lines changed

3 files changed

+21
-6
lines changed

source/adminguide/extensions.rst

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -66,7 +66,7 @@ An Orchestrator extension enables CloudStack to delegate VM orchestration to an
6666

6767
- Instance Lifecycle Support: Orchestrator extensions can handle basic VM actions like prepare, deploy, start, stop, reboot, status and delete.
6868

69-
- 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.
69+
- 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.
7070

7171
- Configuration Details: Key-value configuration details can be specified at different levels - extension, cluster mapping, host, template, service offering, instance.
7272

source/adminguide/extensions/developer.rst

Lines changed: 19 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -125,12 +125,15 @@ Action Lifecycle
125125
Console Access for Instances with Orchestrator Extensions
126126
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
127127

128-
Orchestrator extensions can provide console access for instances via VNC.
129-
To enable this, the extension must implement the ``getconsole`` action and return output in the following JSON format:
128+
Orchestrator extensions can provide console access for instances either through **VNC** or a **direct URL**.
129+
To enable this, the extension must implement the ``getconsole`` action and return output in one of the following JSON formats:
130+
131+
VNC-based console:
130132

131133
.. code-block:: json
132134
133135
{
136+
"status": "success",
134137
...
135138
"console": {
136139
"host": "pve-node1.internal",
@@ -140,8 +143,20 @@ To enable this, the extension must implement the ``getconsole`` action and retur
140143
}
141144
}
142145
143-
The returned details are forwarded to the Console Proxy VM (CPVM) running in the same zone as the instance.
144-
It is required that the specified **host** and **port** are reachable from the CPVM.
146+
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.
147+
148+
Direct URL-based console:
149+
150+
.. code-block:: json
151+
152+
{
153+
"status": "success",
154+
...
155+
"console": {
156+
"url": "CONSOLE_URL",
157+
"protocol": "direct"
158+
}
159+
}
145160
146161
147162
Custom Actions

source/adminguide/extensions/limitations.rst

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -38,7 +38,7 @@ by adding custom actions in the scripts written for the built-in extensions.
3838

3939
- Add Nics to Instance post deployment.
4040

41-
- Console access to the in-built Hyper-V orchestrator Instances.
41+
- Console access for instances using the built-in Hyper-V orchestrator is not available out of the box.
4242

4343
**Actions which can be implemented using Custom Actions in built-in extensions:**
4444

0 commit comments

Comments
 (0)