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 2be19047 Some typos and polish changes (#553)
2be19047 is described below
commit 2be19047bee68a3513e4e677ef46de005b9cd47f
Author: Abhisar Sinha <63767682+abh1...@users.noreply.github.com>
AuthorDate: Fri Aug 29 11:11:44 2025 +0530
Some typos and polish changes (#553)
---
source/_static/images/built-in-extensions.png | Bin 121934 -> 134959 bytes
.../adminguide/extensions/inbuilt_extensions.rst | 114 +++++++++++++--------
2 files changed, 72 insertions(+), 42 deletions(-)
diff --git a/source/_static/images/built-in-extensions.png
b/source/_static/images/built-in-extensions.png
index 960c3946..664cefa8 100644
Binary files a/source/_static/images/built-in-extensions.png and
b/source/_static/images/built-in-extensions.png differ
diff --git a/source/adminguide/extensions/inbuilt_extensions.rst
b/source/adminguide/extensions/inbuilt_extensions.rst
index fd4ae3cb..94dabacb 100644
--- a/source/adminguide/extensions/inbuilt_extensions.rst
+++ b/source/adminguide/extensions/inbuilt_extensions.rst
@@ -16,22 +16,22 @@
In-built Orchestrator Extensions
================================
-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.
-After installing or upgrading Cloudstack, these extensions will show up as
disabled on the Extensions page in the UI.
+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/Proxmox` 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.
+After installing or upgrading CloudStack, in-built Extensions will show up in
the Extensions section in UI.
|built-in-extensions.png|
-**Note**: These extension may undergo changes with different CloudStack
releases and backwards compatibility is not guaranteed.
+**Note**: These Extensions may undergo changes with future CloudStack releases
and backwards compatibility is not guaranteed.
Proxmox
^^^^^^^^
-The Proxmox Cloudstack extension is written in shell script and communicates
with a Proxmox cluster using the `Proxmox VE API`_ over HTTPS.
+The Proxmox CloudStack Extension is written in shell script and communicates
with the Proxmox Cluster using the `Proxmox VE API`_ over HTTPS.
-Before using the Proxmox extension, ensure that the Proxmox datacenter is
configured correctly and accessible to CloudStack.
+Before using the Proxmox Extension, ensure that the Proxmox Datacenter is
configured correctly and accessible to CloudStack.
Get the API Token-Secret from Proxmox
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
@@ -76,16 +76,23 @@ It should return a JSON response similar to this:
Adding Proxmox to CloudStack
~~~~~~~~~~~~~~~~~~~~~~~~~~~~
-To set up the Proxmox extension, follow these steps in CloudStack:
+To set up the Proxmox Extension, follow these steps in CloudStack:
-#. **Enable Extension.** Enable the extension by clicking the `Enable` button
on the `Extensions` page in the UI.
-#. **Create Cluster**. Create a Cluster with hypervisor type `External` and
extension type `Proxmox`.
+#. **Enable Extension**
+
+ Enable the Extension by clicking the `Enable` button on the `Extensions`
page in the UI.
+
+#. **Create Cluster**
+
+ Create a Cluster with Hypervisor type `External` and Extension type
`Proxmox`.
|proxmox-add-cluster.png|
-#. **Add Host.** Add a host to the newly created cluster with the following
details:
+#. **Add Host**
+
+ Add a Host to the newly created Cluster with the following details:
- 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.
+ 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
@@ -96,9 +103,11 @@ To set up the Proxmox extension, follow these steps in
CloudStack:
|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.
+ **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.
-#. **Create Template.** A Template in CloudStack can map to either a
`Template` or an `ISO` in Proxmox.
+#. **Create Template**
+
+ A Template in CloudStack can map to either a `Template` or an `ISO` in
Proxmox.
Provide a dummy `url` and template name. Select `External` as the
hypervisor and `Proxmox` as the extension. Under `External Details`, specify:
* **template_type**: `template` or `iso`
@@ -106,20 +115,26 @@ To set up the Proxmox extension, follow these steps in
CloudStack:
|proxmox-add-template.png|
- * **iso_path**: full path to the ISO in Proxmox (if `template_type` is
`iso`)
+ * **iso_path**: Full path to the ISO in Proxmox (if `template_type` is
`iso`)
|proxmox-add-iso.png|
Note: Templates and ISOs should be stored on shared storage when using
multiple Proxmox nodes. Or copy the template/iso to each host's local storage
at the same location.
-#. **Deploy Instance.** Deploy an instance using the template created above.
Optionally, provide the detail `vm_name` to specify the name of the VM in
Proxmox.
- Otherwise, the CloudStack instance's internal name is used. The VM Id in
Proxmox is mapped to the CloudStack instance and stored as a detail in
CloudStack DB.
- The instance will be provisioned on a randomly selected Proxmox host. The
VM will be configured with the MAC address and VLAN ID as defined in CloudStack.
+#. **Deploy Instance**
+
+ Deploy an Instance using the Template created above. Optionally, provide
the detail `vm_name` to specify the name of the VM in Proxmox.
+ Otherwise, the CloudStack Instance's internal name is used. The VM Id in
Proxmox is mapped to the CloudStack Instance and stored as a detail in
CloudStack DB.
+ The Instance will be provisioned on a randomly selected Proxmox host. The
VM will be configured with the MAC address and VLAN ID as defined in CloudStack.
|proxmox-deploy-instance.png|
-#. **Lifecycle Operations.** Operations **Start**, **Stop**, **Reboot**, and
**Delete** can be performed on the instance from CloudStack.
+#. **Lifecycle Operations**
+
+ Operations **Start**, **Stop**, **Reboot**, and **Delete** can be performed
on the Instance from CloudStack.
+
+#. **Custom Actions**
-#. **Custom Actions.** Custom actions **Create Snapshot**, **Restore
Snapshot**, and **Delete Snapshot** are also supported for instances.
+ Custom actions **Create Snapshot**, **Restore Snapshot**, and **Delete
Snapshot** are also supported for Instances.
.. _proxmox-networking:
Configuring Networking
@@ -127,24 +142,24 @@ Configuring Networking
Proxmox nodes and CloudStack hypervisor hosts must be connected via a VLAN
trunked network. On each Proxmox node,
a bridge interface should be created and connected to the network interface
that carries the VLAN-tagged traffic.
-This bridge must be specified under Configuration Details (`network_bridge`)
when registering the Proxmox node as a host in CloudStack.
+This bridge must be specified under Configuration Details (`network_bridge`)
when registering the Proxmox node as a Host in CloudStack.
-When a VM is deployed, CloudStack includes the assigned MAC address and VLAN
ID in the extension payload.
+When a VM is deployed, CloudStack includes the assigned MAC address and VLAN
ID in the Extension payload.
The VM created on the Proxmox node is configured with this MAC and connected
to the corresponding VLAN via the specified bridge.
Upon boot, the VM broadcasts a VLAN-tagged DHCP request, which reaches the
CloudStack Virtual Router (VR) handling that VLAN.
The VR responds with the appropriate IP address as configured in CloudStack.
Once the VM receives the lease, it becomes fully integrated into the
CloudStack-managed network.
-Users can then manage the Hyper-V VM like any other CloudStack guest instance.
Users can apply egress policies,
-firewall rules, port forwarding, and other networking features seamlessly
through the CloudStack UI or API.
+Users can then manage the Hyper-V VM like any other CloudStack guest Instance.
Users can apply Egress Policies,
+Firewall Rules, Port Forwarding, and other networking features seamlessly
through the CloudStack UI or API.
Hyper-V
^^^^^^
-The Hyper-V CloudStack extension is a Python-based script that communicates
with the Hyper-V host using WinRM (Windows Remote Management) over HTTPS,
+The Hyper-V CloudStack Extension is a Python-based script that communicates
with the Hyper-V host using WinRM (Windows Remote Management) over HTTPS,
using NTLM authentication for secure remote execution of PowerShell commands
that manage the full lifecycle of virtual machines.
-Each Hyper-V host maps to a CloudStack host. Before using the Hyper-V
extension, ensure that the Hyper-V host is accessible to the CloudStack
Management Server via WinRM over HTTPS.
+Each Hyper-V host maps to a CloudStack Host. Before using the Hyper-V
Extension, ensure that the Hyper-V host is accessible to the CloudStack
Management Server via WinRM over HTTPS.
Configuring WinRM over HTTPS
~~~~~~~~~~~~~~~~~~~~~~~~~~~~
@@ -187,55 +202,70 @@ Apart from the `url`, `username` and `password`, the
following details are requi
Adding Hyper-V to CloudStack
~~~~~~~~~~~~~~~~~~~~~~~~~~~~
-#. **Enable extension.** Enable the extension by clicking the `Enable` button
on the `Extensions` page in the UI.
-#. **Create Cluster**. Create a Cluster with hypervisor type `External` and
extension type `HyperV`.
+#. **Enable Extension**
+
+ Enable the Extension by clicking the `Enable` button on the `Extensions`
page in the UI.
+
+#. **Create Cluster**
+
+ Create a Cluster with Hypervisor type `External` and Extension type
`HyperV`.
|hyperv-add-cluster.png|
-#. **Add Host.** Add a host to the newly created cluster with the following
details:
+#. **Add Host**
+
+ Add a Host to the newly created Cluster with the following details:
|hyperv-add-host.png|
**Note**: Add the detail **verify_tls_certificate** set to **false** to
skip TLS certificate verification for self-signed certificates.
-#. **Create Template.** A Template in CloudStack can map to either a
`Template` or an `ISO` in Hyper-V.
- Provide a dummy `url` and template name. Select `External` as the
hypervisor and `HyperV` as the extension. Under `External Details`, specify:
+#. **Create Template**
+
+ A Template in CloudStack can map to either a `Template` or an `ISO` in
Hyper-V.
+ Provide a dummy `url` and Template name. Select `External` as the
hypervisor and `HyperV` as the Extension. Under `External Details`, specify:
* **template_type**: `template` or `iso`
* **generation**: VM generation (1 or 2)
- * **template_path**: Full path to the template .vhdx file in Proxmox (if
`template_type` is `template`)
+ * **template_path**: Full path to the template .vhdx file (if
`template_type` is `template`)
|hyperv-add-template.png|
- * **iso_path**: full path to the ISO in HyperV (if `template_type` is `iso`)
+ * **iso_path**: Full path to the ISO in HyperV (if `template_type` is `iso`)
* **vhd_size_gb**: Size of the VHD disk to create (in GB) (if
`template_type` is `iso`)
|hyperv-add-iso.png|
Note: Templates and ISOs should be stored on shared storage when using
multiple HyperV nodes. Or copy the template/iso to each host's local storage at
the same location.
-#. **Deploy Instance.** Deploy an instance using the template created above.
The instance will be provisioned on a randomly selected Hyper-V host.
+#. **Deploy Instance**
+
+ Deploy an Instance using the template created above. The Instance will be
provisioned on a randomly selected Hyper-V host.
The VM will be configured with the MAC address and VLAN ID as defined in
CloudStack.
- The VM in Hyper-V is created with the name `'CloudStack instance's internal
name' + '-' + 'CloudStack instance's UUID'` to keep it unique.
+ The VM in Hyper-V is created with the name `'CloudStack Instance's internal
name' + '-' + 'CloudStack Instance's UUID'` to keep it unique.
+
+#. **Lifecycle Operations**
+
+ Operations **Start**, **Stop**, **Reboot**, and **Delete** can be performed
on the Instance from CloudStack.
-#. **Lifecycle Operations.** Operations **Start**, **Stop**, **Reboot**, and
**Delete** can be performed on the instance from CloudStack.
+#. **Custom Actions**
-#. **Custom Actions.** Custom actions **Suspend**, **Resume**, **Create
Snapshot**, **Restore Snapshot**, and **Delete Snapshot** are also supported
for instances.
+ Custom actions **Suspend**, **Resume**, **Create Snapshot**, **Restore
Snapshot**, and **Delete Snapshot** are also supported for Instances.
Configuring Networking
~~~~~~~~~~~~~~~~~~~~~~
-Hyper-V hosts and CloudStack hypervisor hosts must be connected via a VLAN
trunked network.
+Hyper-V hosts and CloudStack hypervisor Hosts must be connected via a VLAN
trunked network.
On each Hyper-V host, an external virtual switch should be created and bound
to the physical network interface that carries VLAN-tagged traffic.
This switch must be specified in the Configuration Details (network_bridge)
when adding the Hyper-V host to CloudStack.
-When a VM is deployed, CloudStack includes the assigned MAC address and VLAN
ID in the extension payload.
+When a VM is deployed, CloudStack includes the assigned MAC address and VLAN
ID in the Extension payload.
The VM is then created on the Hyper-V host with this MAC address and attached
to the specified external switch with the corresponding VLAN configured.
Upon boot, the VM sends a VLAN-tagged DHCP request, which reaches the
CloudStack Virtual Router (VR) responsible for that VLAN.
The VR responds with the correct IP address as configured in CloudStack. Once
the VM receives the lease, it becomes fully integrated into the
CloudStack-managed network.
-Users can then manage the Hyper-V VM like any other CloudStack guest instance.
Users can apply egress policies,
-firewall rules, port forwarding, and other networking features seamlessly
through the CloudStack UI or API.
+Users can then manage the Hyper-V VM like any other CloudStack guest Instance.
Users can apply Egress Policies,
+Firewall Rules, Port Forwarding, and other networking features seamlessly
through the CloudStack UI or API.
.. _Proxmox VE API: https://pve.proxmox.com/pve-docs/api-viewer/index.html
