Skip to content

Commit db15721

Browse files
authored
extensions: edit, refactor for consistency (#545)
1 parent 8b19b59 commit db15721

File tree

2 files changed

+11
-4
lines changed

2 files changed

+11
-4
lines changed

source/adminguide/extensions.rst

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -72,14 +72,14 @@ An Orchestrator extension enables CloudStack to delegate VM orchestration to an
7272

7373
- 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.
7474

75-
- 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.
75+
- 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.
7676

7777
**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.
7878

7979
|extension.png|
8080

8181

82-
CloudStack provides sample built-in orchestrator extensions for demonstration and testing purposes.
82+
CloudStack provides sample in-built orchestrator extensions for demonstration and testing purposes.
8383

8484
.. note::
8585
- When a CloudStack host linked to an orchestrator extension is placed into Maintenance mode, all running instances on the host will be stopped.

source/adminguide/extensions/builtin_extensions.rst renamed to source/adminguide/extensions/inbuilt_extensions.rst

Lines changed: 9 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -13,10 +13,10 @@
1313
specific language governing permissions and limitations
1414
under the License.
1515
16-
Built-in Orchestator Extensions
16+
In-built Orchestator Extensions
1717
===============================
1818

19-
CloudStack provides sample built-in orchestrator extensions for Proxmox and Hyper-V. These extensions are intended for demonstration and testing purposes.
19+
CloudStack provides sample in-built orchestrator extensions for Proxmox and Hyper-V. These extensions are intended for demonstration and testing purposes.
2020
The extension files are located at `/usr/share/cloudstack-management/extensions/Promox` and `/usr/share/cloudstack-management/extensions/HyperV` respectively.
2121
The Proxmox extension is written in shell script, while the Hyper-V extension is written in python.
2222
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:
8787

8888
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.
8989

90+
* **url**: IP address/URL for Proxmox API access, e.g., `https://<PROXMOX_URL>:8006`.
91+
* **user**: User name for Proxmox API access
92+
* **token**: API token for Proxmox
93+
* **secret**: API secret for Proxmox
94+
* **node**: Hostname of the Proxmox nodes
95+
* **network_bridge**: Name of the network bridge to use for VM networking
96+
9097
|proxmox-add-host.png|
9198

9299
**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.

0 commit comments

Comments
 (0)