From 63e705981017a9c22677e637abf62ff77a890f55 Mon Sep 17 00:00:00 2001 From: Abhishek Kumar Date: Fri, 22 Aug 2025 10:00:37 +0530 Subject: [PATCH 1/5] extensions: edit, refactor for consistency Signed-off-by: Abhishek Kumar --- source/adminguide/extensions.rst | 4 ++-- ...{builtin_extensions.rst => inbuilt_extensions.rst} | 11 +++++++++-- 2 files changed, 11 insertions(+), 4 deletions(-) rename source/adminguide/extensions/{builtin_extensions.rst => inbuilt_extensions.rst} (96%) diff --git a/source/adminguide/extensions.rst b/source/adminguide/extensions.rst index 3f5732490d..bd62bd7759 100644 --- a/source/adminguide/extensions.rst +++ b/source/adminguide/extensions.rst @@ -72,14 +72,14 @@ An Orchestrator extension enables CloudStack to delegate VM orchestration to an - Instance Preparation: Orchestrator extensions can optionally perform a preparation step during instance deployment. This step is executed before the instance is started on the external system. It allows the extension to update certain instance details in CloudStack. CloudStack sends a structured JSON containing the instance configuration, and the extension can respond with the values it wishes to modify. Currently, only a limited set of fields can be updated: the instance’s VNC password, MAC address, details, and the IPv4/IPv6 addresses of its NICs. - - Networking: If networking is setup properly on the external system (See :ref:`built-in extensions networking ` for more details.), the Virtual Router in CloudStack can connect to the external VMs and provide DHCP, DNS, and routing services. + - Networking: If networking is setup properly on the external system (See :ref:`inbuilt extensions networking ` for more details.), the Virtual Router in CloudStack can connect to the external VMs and provide DHCP, DNS, and routing services. **Note**: User data and ssh-key injection from within CloudStack is not supported for the external VMs in this release. The External systems should handle user-data and ssh-key injections natively using other mechanisms. |extension.png| -CloudStack provides sample built-in orchestrator extensions for demonstration and testing purposes. +CloudStack provides sample inbuilt orchestrator extensions for demonstration and testing purposes. .. note:: - When a CloudStack host linked to an orchestrator extension is placed into Maintenance mode, all running instances on the host will be stopped. diff --git a/source/adminguide/extensions/builtin_extensions.rst b/source/adminguide/extensions/inbuilt_extensions.rst similarity index 96% rename from source/adminguide/extensions/builtin_extensions.rst rename to source/adminguide/extensions/inbuilt_extensions.rst index 17c17317e1..004e728bf2 100644 --- a/source/adminguide/extensions/builtin_extensions.rst +++ b/source/adminguide/extensions/inbuilt_extensions.rst @@ -13,10 +13,10 @@ specific language governing permissions and limitations under the License. -Built-in Orchestator Extensions +Inbuilt Orchestator Extensions =============================== -CloudStack provides sample built-in orchestrator extensions for Proxmox and Hyper-V. These extensions are intended for demonstration and testing purposes. +CloudStack provides sample Inbuilt orchestrator extensions for Proxmox and Hyper-V. These extensions are intended for demonstration and testing purposes. The extension files are located at `/usr/share/cloudstack-management/extensions/Promox` and `/usr/share/cloudstack-management/extensions/HyperV` respectively. 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. @@ -78,6 +78,13 @@ To set up the Proxmox extension, follow these steps in CloudStack: If the Proxmox nodes use a shared API endpoint or credentials, the `url`, `user`, `token`, and `secret` can be set in the Extension's `Configuration Details` instead of per host. However, `node` and `network_bridge` must still be specified individually for each host. + * **url**: IP address/URL for Proxmox API access, e.g., `https://:8006`. + * **user**: User name for Proxmox API access + * **token**: API token for Proxmox + * **secret**: API secret for Proxmox + * **node**: Hostname of the Proxmox nodes + * **network_bridge**: Name of the network bridge to use for VM networking + |proxmox-add-host.png| **Note**: If the TLS certificate cannot be verified when cloudstack connects to the Proxmox node, add the detail **verify_tls_certificate** and set it to **false** to skip certificate verification. From 574ed0daba624011cbcff8692f664e9b958dfa99 Mon Sep 17 00:00:00 2001 From: Rohit Yadav Date: Thu, 28 Aug 2025 13:22:54 +0530 Subject: [PATCH 2/5] 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 004e728bf2..1cbef551e1 100644 --- a/source/adminguide/extensions/inbuilt_extensions.rst +++ b/source/adminguide/extensions/inbuilt_extensions.rst @@ -16,7 +16,7 @@ Inbuilt Orchestator Extensions =============================== -CloudStack provides sample Inbuilt orchestrator extensions for Proxmox and Hyper-V. These extensions are intended for demonstration and testing purposes. +CloudStack provides sample in-built orchestrator extensions for Proxmox and Hyper-V. These extensions are intended for demonstration and testing purposes. The extension files are located at `/usr/share/cloudstack-management/extensions/Promox` and `/usr/share/cloudstack-management/extensions/HyperV` respectively. 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. From 957210826d2b34fff43778c10b399ca2954153ab Mon Sep 17 00:00:00 2001 From: Rohit Yadav Date: Thu, 28 Aug 2025 13:23:23 +0530 Subject: [PATCH 3/5] 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 1cbef551e1..f94d6c5b9f 100644 --- a/source/adminguide/extensions/inbuilt_extensions.rst +++ b/source/adminguide/extensions/inbuilt_extensions.rst @@ -13,7 +13,7 @@ specific language governing permissions and limitations under the License. -Inbuilt Orchestator Extensions +In-built Orchestator Extensions =============================== CloudStack provides sample in-built orchestrator extensions for Proxmox and Hyper-V. These extensions are intended for demonstration and testing purposes. From ea6b5b8b37f5885aa7be6744a58000351f7ba692 Mon Sep 17 00:00:00 2001 From: Rohit Yadav Date: Thu, 28 Aug 2025 13:23:36 +0530 Subject: [PATCH 4/5] Update source/adminguide/extensions.rst --- 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 bd62bd7759..3364531e36 100644 --- a/source/adminguide/extensions.rst +++ b/source/adminguide/extensions.rst @@ -79,7 +79,7 @@ An Orchestrator extension enables CloudStack to delegate VM orchestration to an |extension.png| -CloudStack provides sample inbuilt orchestrator extensions for demonstration and testing purposes. +CloudStack provides sample in-built orchestrator extensions for demonstration and testing purposes. .. note:: - When a CloudStack host linked to an orchestrator extension is placed into Maintenance mode, all running instances on the host will be stopped. From f1b1b76106f9f33544d70dfb00b3fccde2beb06a Mon Sep 17 00:00:00 2001 From: Rohit Yadav Date: Thu, 28 Aug 2025 13:23:49 +0530 Subject: [PATCH 5/5] Update source/adminguide/extensions.rst --- 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 3364531e36..aabe4e6d45 100644 --- a/source/adminguide/extensions.rst +++ b/source/adminguide/extensions.rst @@ -72,7 +72,7 @@ An Orchestrator extension enables CloudStack to delegate VM orchestration to an - Instance Preparation: Orchestrator extensions can optionally perform a preparation step during instance deployment. This step is executed before the instance is started on the external system. It allows the extension to update certain instance details in CloudStack. CloudStack sends a structured JSON containing the instance configuration, and the extension can respond with the values it wishes to modify. Currently, only a limited set of fields can be updated: the instance’s VNC password, MAC address, details, and the IPv4/IPv6 addresses of its NICs. - - Networking: If networking is setup properly on the external system (See :ref:`inbuilt extensions networking ` for more details.), the Virtual Router in CloudStack can connect to the external VMs and provide DHCP, DNS, and routing services. + - Networking: If networking is setup properly on the external system (See :ref:`in-built extensions networking ` for more details.), the Virtual Router in CloudStack can connect to the external VMs and provide DHCP, DNS, and routing services. **Note**: User data and ssh-key injection from within CloudStack is not supported for the external VMs in this release. The External systems should handle user-data and ssh-key injections natively using other mechanisms.