Skip to content

Commit 6bd36a8

Browse files
rm3lFortune-Ndlovu
andcommitted
docs: Update docs accordingly
Co-authored-by: Fortune Ndlovu <[email protected]>
1 parent dadb1b8 commit 6bd36a8

File tree

1 file changed

+10
-1
lines changed

1 file changed

+10
-1
lines changed

docs/dynamic-plugins.md

Lines changed: 10 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -47,9 +47,18 @@ TODO: Dynamic plugins can be configured to use container registries for authenti
4747
4848
The operator supports loading default plugin configurations from an OCI container image (catalog index). For general information about how the catalog index works, see [Using a Catalog Index Image for Default Plugin Configurations](https://github.com/redhat-developer/rhdh/blob/main/docs/dynamic-plugins/installing-plugins.md#using-a-catalog-index-image-for-default-plugin-configurations).
4949
50-
By default, the `rhdh` profile of operator [injects](../config/profile/rhdh/patches/deployment-patch.yaml#L31-L32) the `CATALOG_INDEX_IMAGE` environment variable in the RHDH `install-dynamic-plugins` init containers.
50+
By default, the `rhdh` profile of operator [injects](../config/profile/rhdh/patches/deployment-patch.yaml#L31-L32) the `CATALOG_INDEX_IMAGE` environment variable in the RHDH `install-dynamic-plugins` init container.
5151
To use a different catalog index image, such as a newer version or a mirrored image, use the `extraEnvs` field in your Backstage CR. See [examples/catalog-index.yaml](../examples/catalog-index.yaml) for a complete example.
5252

53+
### Extensions Catalog Entities
54+
55+
Starting from version 1.9, the `rhdh` profile of the operator instructs the RHDH `install-dynamic-plugins` init container to extract catalog entities from the catalog index image to a new `/extensions` volume mount by default.
56+
This allows the extensions backend providers to automatically discover plugin metadata for display in the RHDH Extensions UI.
57+
58+
The extraction directory can be configured via the `CATALOG_ENTITIES_EXTRACT_DIR` environment variable in the `install-dynamic-plugins` init container.
59+
60+
More details in [Catalog Entities Extraction](https://github.com/redhat-developer/rhdh/blob/main/docs/dynamic-plugins/installing-plugins.md#catalog-entities-extraction).
61+
5362
## Dynamic plugins dependency management
5463

5564
### Overview

0 commit comments

Comments
 (0)