Skip to content

Commit 7864e6b

Browse files
committed
fix
Signed-off-by: Abhishek Kumar <[email protected]>
1 parent a099564 commit 7864e6b

File tree

3 files changed

+11
-12
lines changed

3 files changed

+11
-12
lines changed

source/adminguide/extensions.rst

Lines changed: 4 additions & 4 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,14 +44,14 @@ 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

source/adminguide/extensions/custom_actions.rst

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -15,7 +15,7 @@
1515
1616
1717
Custom Actions
18-
~~~~~~~~~~~~~~
18+
--------------
1919

2020
In addition to standard instance operations, extensions support custom actions. These can be configured via UI in the extension details view or the addCustomAction API. The extension entry-point must implement handlers for these action names and process any provided parameters.
2121

@@ -44,7 +44,7 @@ A single parameter can have the following details:
4444
- **valueoptions**: Options for the value of the parameter. This is allowed only for NUMBER and STRING type.
4545

4646
Running Custom Action
47-
---------------------
47+
~~~~~~~~~~~~~~~~~~~~~
4848

4949
All enabled custom actions can then be triggered for a resource of the type the action is defined for or provided while running, using the **Run Action** view or runCustomAction API.
5050

source/adminguide/extensions/troubleshooting.rst

Lines changed: 5 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -15,10 +15,10 @@
1515
1616
1717
Troubleshooting Extensions
18-
~~~~~~~~~~~~~~~~~~~~~~~~~~
18+
--------------------------
1919

2020
Validate the Extension Entry Point
21-
----------------------------------
21+
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
2222

2323
- Ensure that the entry point path is correctly defined and accessible on all management servers.
2424

@@ -35,7 +35,7 @@ Validate the Extension Entry Point
3535
- The check interval can be configured using the cloudstack.extensions.entrypoint.check.interval property in global.properties. The default is 5 minutes.
3636

3737
Verify Payload Handling
38-
-----------------------
38+
~~~~~~~~~~~~~~~~~~~~~~~
3939

4040
- Ensure the extension binary can correctly read and parse the incoming JSON payload.
4141

@@ -46,7 +46,7 @@ Verify Payload Handling
4646
- Improper parsing of the payload is a common cause of failure—log any parsing errors in your extension binary for debugging.
4747

4848
Refer to Base Extension Scripts
49-
-------------------------------
49+
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
5050

5151
- For guidance on implementing supported actions, refer to the base scripts present for each extension type.
5252

@@ -55,7 +55,7 @@ Refer to Base Extension Scripts
5555
- These scripts provide examples of how to handle standard actions like start, stop, status, etc.
5656

5757
Check Logs for Errors
58-
---------------------
58+
~~~~~~~~~~~~~~~~~~~~~
5959

6060
- If the extension does not respond or returns an error, check the management server logs.
6161

@@ -68,4 +68,3 @@ Check Logs for Errors
6868
3. Output parsing
6969

7070
- Any exceptions or exit code issues.
71-

0 commit comments

Comments
 (0)