This is an automated email from the ASF dual-hosted git repository.
sureshanaparti pushed a commit to branch main
in repository https://gitbox.apache.org/repos/asf/cloudstack-documentation.git
The following commit(s) were added to refs/heads/main by this push:
new db15721c extensions: edit, refactor for consistency (#545)
db15721c is described below
commit db15721c13a9417e7df3117280afaaec3a21ee29
Author: Abhishek Kumar <[email protected]>
AuthorDate: Thu Aug 28 15:15:46 2025 +0530
extensions: edit, refactor for consistency (#545)
---
source/adminguide/extensions.rst | 4 ++--
.../{builtin_extensions.rst => inbuilt_extensions.rst} | 11 +++++++++--
2 files changed, 11 insertions(+), 4 deletions(-)
diff --git a/source/adminguide/extensions.rst b/source/adminguide/extensions.rst
index 7dbe0242..b9084775 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 pass [...]
- - Networking: If networking is setup properly on the external system (See
:ref:`built-in extensions networking <proxmox-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 <proxmox-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 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.
diff --git a/source/adminguide/extensions/builtin_extensions.rst
b/source/adminguide/extensions/inbuilt_extensions.rst
similarity index 97%
rename from source/adminguide/extensions/builtin_extensions.rst
rename to source/adminguide/extensions/inbuilt_extensions.rst
index d7900255..f8441cdb 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
+In-built 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 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.
@@ -87,6 +87,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://<PROXMOX_URL>: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.
