Skip to content

Commit 02ed1f3

Browse files
committed
entrypoint -> path
Signed-off-by: Abhishek Kumar <[email protected]>
1 parent 28a41cc commit 02ed1f3

File tree

3 files changed

+14
-14
lines changed

3 files changed

+14
-14
lines changed

source/adminguide/extensions.rst

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -37,18 +37,18 @@ Configuration
3737

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

40-
- Entry Point: A file or script that will be executed during extension operations.
40+
- Path: A path to a file or script that will be executed during extension operations.
4141

4242
- Configuration Details: Key-value properties used by the extension at runtime.
4343

4444
- Resource Mappings: Association between extensions and CloudStack resources such as clusters, etc.
4545

46-
Entry Point
47-
^^^^^^^^^^^
46+
Path and Availabilty
47+
^^^^^^^^^^^^^^^^^^^^
4848

49-
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.
49+
The path for an extension can point to any binary or executable script. If no explicit path is provided, CloudStack uses a default base Bash script. The state of the path is validated across all management servers. In the UI, the Availabilty is displayed as Not Ready if the file is missing, inaccessible, or differs across management servers.
5050

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

5353
Payload
5454
^^^^^^^

source/adminguide/extensions/custom_actions.rst

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -17,7 +17,7 @@
1717
Custom Actions
1818
--------------
1919

20-
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.
20+
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 binary or script must implement handlers for these action names and process any provided parameters.
2121

2222
|add-custom-action.png|
2323

@@ -30,7 +30,7 @@ Success and error messages will be used and returned during action execution. Th
3030
- {{resourceName}} for showing name of the resource
3131

3232
An example usage can be - "Successfully completed {{actionName}} for {{resourceName}} using {{extensionName}}".
33-
Configuration details can be key-value pairs which will be passed to the extension entry-point during action execution.
33+
Configuration details can be key-value pairs which will be passed to the extension during action execution.
3434
Timeout value can be configured to adjust wait time for action completion.
3535

3636
A single parameter can have the following details:

source/adminguide/extensions/troubleshooting.rst

Lines changed: 7 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -17,22 +17,22 @@
1717
Troubleshooting Extensions
1818
--------------------------
1919

20-
Validate the Extension Entry Point
21-
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
20+
Validate the Extension Path
21+
^^^^^^^^^^^^^^^^^^^^^^^^^^^
2222

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

2525
- The script or binary must be executable and have appropriate permissions.
2626

2727
- If the binary differs across management servers, the extension will be marked as Not Ready.
2828

29-
- Entry points are stored at: `/usr/share/cloudstack-management/extensions/<extension_name>`
29+
- Ensure files are stored at: `/usr/share/cloudstack-management/extensions/<extension_name>`
3030

31-
- CloudStack runs a background task at regular intervals to verify entry point readiness. If the entry point is not ready, its state will appear as Not Ready in the UI or API responses.
31+
- CloudStack runs a background task at regular intervals to verify path readiness. If the path is not ready, its state will appear as Not Ready in the UI or API responses.
3232

33-
- Alerts are generated if an entry point is not ready.
33+
- Alerts are generated if the extension path is not ready.
3434

35-
- The check interval can be configured using the cloudstack.extensions.entrypoint.check.interval property in global.properties. The default is 5 minutes.
35+
- The check interval can be configured using the global configuration - `extension.path.state.check.interval`. The default is 5 minutes.
3636

3737
Verify Payload Handling
3838
^^^^^^^^^^^^^^^^^^^^^^^

0 commit comments

Comments
 (0)