Skip to content

Commit dc1776b

Browse files
committed
docs: Update docs accordingly
1 parent bce72c5 commit dc1776b

File tree

1 file changed

+16
-1
lines changed

1 file changed

+16
-1
lines changed

docs/dynamic-plugins/installing-plugins.md

Lines changed: 16 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -46,6 +46,7 @@ When the `CATALOG_INDEX_IMAGE` environment variable is set, the `install-dynamic
4646
2. Look for a `dynamic-plugins.default.yaml` file within the image
4747
3. Use this file as the primary source for default plugin configurations
4848
4. Replace the embedded `dynamic-plugins.default.yaml` if it's present in the `includes` list
49+
5. Extract catalog entities from `catalog-entities/marketplace` directory (if present in the index image) to a configurable location
4950

5051
### Configuring the Catalog Index Image
5152

@@ -57,7 +58,10 @@ The configuration method depends on your deployment approach:
5758

5859
### Catalog Index Image Structure
5960

60-
The catalog index OCI image should contain a `dynamic-plugins.default.yaml` file at the root level with the same structure as the embedded default configuration file:
61+
The catalog index OCI image should contain the following at the root level:
62+
63+
- A `dynamic-plugins.default.yaml` file with the same structure as the embedded default configuration file
64+
- Optionally, a `catalog-entities/marketplace` directory containing extension catalog entity definitions
6165

6266
```yaml
6367
# Contents of dynamic-plugins.default.yaml in the OCI image
@@ -70,6 +74,17 @@ plugins:
7074
disabled: true
7175
```
7276

77+
### Catalog Entities Extraction
78+
79+
When the `CATALOG_INDEX_IMAGE` is set and the index image contains a `catalog-entities/marketplace` directory, the [`install-dynamic-plugins.py`](../../docker/install-dynamic-plugins.py) will automatically extract these catalog entities to a configurable location.
80+
81+
The extraction destination is governed by the `CATALOG_ENTITIES_EXTRACT_DIR` environment variable:
82+
83+
- If `CATALOG_ENTITIES_EXTRACT_DIR` is set, entities are extracted to `<CATALOG_ENTITIES_EXTRACT_DIR>/catalog-entities`
84+
- If not set, it defaults to `<dynamic-plugins-root>/marketplace/catalog-entities`
85+
86+
**Note:** If the catalog index image does not contain the `catalog-entities/marketplace` directory, a warning will be printed but the extraction of `dynamic-plugins.default.yaml` will still succeed.
87+
7388
## Installing External Dynamic Plugins
7489

7590
RHDH supports external dynamic plugins, which are plugins not included in the core RHDH distribution. These plugins can be installed or uninstalled without rebuilding the RHDH application; only a restart is required to apply the changes.

0 commit comments

Comments
 (0)