Skip to content

Commit 48c6700

Browse files
authored
Update extensions.rst
1 parent 722cf3d commit 48c6700

File tree

1 file changed

+5
-5
lines changed

1 file changed

+5
-5
lines changed

source/adminguide/extensions.rst

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -24,7 +24,7 @@ In the UI, extensions can be managed under *Extensions* menu.
2424
|extensions.png|
2525

2626
Overview
27-
~~~~~~~~
27+
--------
2828

2929
An extension in CloudStack is defined as an external binary (written in any programming language) that implements specific actions CloudStack can invoke. This allows operators to manage resource lifecycle operations outside CloudStack, such as provisioning VMs in third-party systems or triggering external automation pipelines.
3030

@@ -33,7 +33,7 @@ Extensions are managed through the API and UI, with support for configuration, r
3333
|create-extension.png|
3434

3535
Configuration
36-
~~~~~~~~~~~~~
36+
-------------
3737

3838
Administrators can define and manage the following components of an extension:
3939

@@ -44,19 +44,19 @@ Administrators can define and manage the following components of an extension:
4444
- Resource Mappings: Association between extensions and CloudStack resources such as clusters, etc.
4545

4646
Entry Point
47-
~~~~~~~~~~~
47+
-----------
4848

4949
The entry point for an extension can be any binary or executable script. If no explicit entry point is provided, CloudStack uses a default base Bash script. The state of the entry point is validated across all management servers. In the UI, the Entry Point State is displayed as Not Ready if the file is missing, inaccessible, or differs across management servers.
5050

5151
All extension entry point files are stored under a directory named after the extension within `/usr/share/cloudstack-management/extensions`.
5252

5353
Payload
54-
~~~~~~~
54+
-------
5555

5656
CloudStack sends structured JSON payloads to the extension binary during each operation. These payloads are written to .json files stored under `/var/lib/cloudstack/management/extensions`. The extension binary is expected to read the file and return an appropriate result. CloudStack automatically attempts to clean up payload files older than one day.
5757

5858
Orchestrator Extension
59-
----------------------
59+
~~~~~~~~~~~~~~~~~~~~~~
6060

6161
An Orchestrator extension enables CloudStack to delegate VM orchestration to an external system. Key features include:
6262

0 commit comments

Comments
 (0)