extensions: instance console access#560
Conversation
Related: apache/cloudstack#11601 Signed-off-by: Abhishek Kumar <abhishek.mrt22@gmail.com>
|
@blueorangutan docbuild |
|
@nvazquez a Jenkins job has been kicked to build the document. I'll keep you posted as I make progress. |
|
QA-Doc build preview: https://qa.cloudstack.cloud/builds/docs-build/pr/560. (QA-JID 422) |
|
@blueorangutan docbuild |
|
@shwstppr a Jenkins job has been kicked to build the document. I'll keep you posted as I make progress. |
|
QA-Doc build preview: https://qa.cloudstack.cloud/builds/docs-build/pr/560. (QA-JID 423) |
shwstppr
changed the title
|
@blueorangutan docbuild |
|
@shwstppr a Jenkins job has been kicked to build the document. I'll keep you posted as I make progress. |
|
QA-Doc build preview: https://qa.cloudstack.cloud/builds/docs-build/pr/560. (QA-JID 428) |
Signed-off-by: Abhishek Kumar <abhishek.mrt22@gmail.com>
| 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. |
There was a problem hiding this comment.
What's the difference between the three direct URL based console access? How is link, direct, url different ? This is confusing as in the beginning of the section, it says there are only two types of console access provided.
| Console Access for Instances with Orchestrator Extensions | ||
| ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ | ||
|
|
||
| Orchestrator extensions can provide console access for instances either through **VNC** or a **direct URL**. |
There was a problem hiding this comment.
Here we state that console access can only be VNC or direct/external URL based?
Also the word direct is confusing, probably you want to say it's an external URL (or just URL) ?
|
@blueorangutan docbuild |
|
@shwstppr a Jenkins job has been kicked to build the document. I'll keep you posted as I make progress. |
|
QA-Doc build preview: https://qa.cloudstack.cloud/builds/docs-build/pr/560. (QA-JID 439) |
|
@blueorangutan docbuild |
|
@shwstppr a Jenkins job has been kicked to build the document. I'll keep you posted as I make progress. |
|
QA-Doc build preview: https://qa.cloudstack.cloud/builds/docs-build/pr/560. (QA-JID 441) |
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`. 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.
Also, adds changes to send caller details to the extension payload.
```
# cat /var/lib/cloudstack/management/extensions/Proxmox/02b650f6-bb98-49cb-8cac-82b7a78f43a2.json | jq
{
"caller": {
"roleid": "6b86674b-7e61-11f0-ba77-1e00c8000158",
"rolename": "Root Admin",
"name": "admin",
"roletype": "Admin",
"id": "93567ed9-7e61-11f0-ba77-1e00c8000158",
"type": "ADMIN"
},
"virtualmachineid": "126f4562-1f0f-4313-875e-6150cabeb72f",
...
```
Documentation PR: apache/cloudstack-documentation#560
---------
Signed-off-by: Abhishek Kumar <abhishek.mrt22@gmail.com>
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`. 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.
Also, adds changes to send caller details to the extension payload.
```
{
"caller": {
"roleid": "6b86674b-7e61-11f0-ba77-1e00c8000158",
"rolename": "Root Admin",
"name": "admin",
"roletype": "Admin",
"id": "93567ed9-7e61-11f0-ba77-1e00c8000158",
"type": "ADMIN"
},
"virtualmachineid": "126f4562-1f0f-4313-875e-6150cabeb72f",
...
```
Documentation PR: apache/cloudstack-documentation#560
---------
Signed-off-by: Abhishek Kumar <abhishek.mrt22@gmail.com>
7 participants
Related: apache/cloudstack#11601
📚 Documentation preview 📚: https://cloudstack-documentation--560.org.readthedocs.build/en/560/