You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: docs/dynamic-plugins/installing-plugins.md
+16-1Lines changed: 16 additions & 1 deletion
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -46,6 +46,7 @@ When the `CATALOG_INDEX_IMAGE` environment variable is set, the `install-dynamic
46
46
2. Look for a `dynamic-plugins.default.yaml` file within the image
47
47
3. Use this file as the primary source for default plugin configurations
48
48
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
49
50
50
51
### Configuring the Catalog Index Image
51
52
@@ -57,7 +58,10 @@ The configuration method depends on your deployment approach:
57
58
58
59
### Catalog Index Image Structure
59
60
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
61
65
62
66
```yaml
63
67
# Contents of dynamic-plugins.default.yaml in the OCI image
@@ -70,6 +74,17 @@ plugins:
70
74
disabled: true
71
75
```
72
76
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
+
73
88
## Installing External Dynamic Plugins
74
89
75
90
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