Added documentation for MaaS Extension #561
Open
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
|
@blueorangutan docbuild |
|
@harikrishna-patnala a Jenkins job has been kicked to build the document. I'll keep you posted as I make progress. |
14 tasks
|
QA-Doc build preview: https://qa.cloudstack.cloud/builds/docs-build/pr/561. (QA-JID 424) |
abh1sar
reviewed
Sep 15, 2025
| @@ -79,7 +79,7 @@ An Orchestrator extension enables CloudStack to delegate VM orchestration to an | |||
| |extension.png| | |||
|
|
|||
|
|
|||
| CloudStack provides in-built Orchestrator Extensions for Proxmox and Hyper-V which work with Proxmox and Hyper-V environments out of the box. | |||
| CloudStack provides in-built Orchestrator Extensions for Proxmox, Hyper-V, MaaS which work with Proxmox, Hyper-V and MaaS environments out of the box. | |||
There was a problem hiding this comment.
Maybe reword to "CloudStack provides in-build Orchestrator Extensions for Proxmox, Hyper-V and MaaS which work with their respective environments out of the box.
| CloudStack provides in-built Orchestrator Extensions for Proxmox, Hyper-V and MaaS. These extensions work with Proxmox, Hyper-V and MaaS environments out of the box, and can also serve as reference implementations for anyone looking to develop new custom extensions. | ||
| The Extension files are located at `/usr/share/cloudstack-management/extensions/Proxmox`, `/usr/share/cloudstack-management/extensions/HyperV` and `/usr/share/cloudstack-management/extensions/MaaS` respectively. | ||
| The Proxmox Extension is written in shell script, while the Hyper-V and MaaS Extensions are written in python. | ||
| All of these Extensions support some custom actions in addition to the standard VM actions like deploy, start, stop, reboot, status and delete. |
There was a problem hiding this comment.
MaaS doesn't have any custom actions, right?
Can modify this to "Proxmox and Hyper-V Extensions support some custom actions ..."
| The Proxmox Extension is written in shell script, while the Hyper-V Extension is written in python. | ||
| Both of these Extensions support some custom actions in addition to the standard VM actions like deploy, start, stop, reboot, status and delete. | ||
| CloudStack provides in-built Orchestrator Extensions for Proxmox, Hyper-V and MaaS. These extensions work with Proxmox, Hyper-V and MaaS environments out of the box, and can also serve as reference implementations for anyone looking to develop new custom extensions. | ||
| The Extension files are located at `/usr/share/cloudstack-management/extensions/Proxmox`, `/usr/share/cloudstack-management/extensions/HyperV` and `/usr/share/cloudstack-management/extensions/MaaS` respectively. |
There was a problem hiding this comment.
Suggested change
| The Extension files are located at `/usr/share/cloudstack-management/extensions/Proxmox`, `/usr/share/cloudstack-management/extensions/HyperV` and `/usr/share/cloudstack-management/extensions/MaaS` respectively. | |
| The Extension files are located in `/usr/share/cloudstack-management/extensions/`, under the subdirectories `Proxmox`, `HyperV`, and `MaaS`. |
| MaaS | ||
| ^^^^^^^^ | ||
|
|
||
| The MaaS CloudStack Extension is written in python script and communicates with the Canonical MaaS `https://canonical.com/maas`_ using the MaaS APIs `https://canonical.com/maas/docs/api`_. |
There was a problem hiding this comment.
I am not sure, but the doesn't look right here. Also check if the links display is better with the suggestion.
Suggested change
| The MaaS CloudStack Extension is written in python script and communicates with the Canonical MaaS `https://canonical.com/maas`_ using the MaaS APIs `https://canonical.com/maas/docs/api`_. | |
| The MaaS CloudStack Extension is written in python script and communicates with `Canonical MaaS <https://canonical.com/maas`_ using the `MaaS APIs <https://canonical.com/maas/docs/api>`_. |
Please make the change to Proxmox API link as well on line #32
The Proxmox CloudStack Extension is written in shell script and communicates with the Proxmox Cluster using the `Proxmox VE API <https://pve.proxmox.com/wiki/Proxmox_VE_API>`_ over HTTPS."
|
|
||
| If not already set up, create a new API Key in the MaaS UI by navigating to left column under `admin > API keys`. | ||
|
|
||
| Existing `MAAS consumer` token can used or a new API key can be generated by clicking `Generate MAAS API Key` button |
There was a problem hiding this comment.
Suggested change
| Existing `MAAS consumer` token can used or a new API key can be generated by clicking `Generate MAAS API Key` button | |
| Existing `MAAS consumer` token can be used or a new API key can be generated by clicking the `Generate MAAS API Key` button |
|
|
||
| #. **Deploy Instance** | ||
|
|
||
| Deploy an Instance using the Template created above. Optionally, provide the detail `vm_name` to specify the name of the VM in MaaS. |
There was a problem hiding this comment.
Please check if we should call it VM or some generic term like system or machine
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
This add content in relation to the PR apache/cloudstack#11613
📚 Documentation preview 📚: https://cloudstack-documentation--561.org.readthedocs.build/en/561/