Skip to content

Commit d5ac817

Browse files
Fortune-Ndlovurm3l
andauthored
feat: Implement catalog index support in RHDH-Local
Co-authored-by: Armel Soro <asoro@redhat.com>
1 parent 49886e5 commit d5ac817

2 files changed

Lines changed: 16 additions & 0 deletions

File tree

default.env

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -11,6 +11,10 @@ BASE_URL=http://localhost:7007
1111
# to use bleeding edge :next images or commercially supported images, see README.md for details
1212
# RHDH_IMAGE=quay.io/rhdh-community/rhdh:1.8
1313

14+
# Default plugin catalog index image
15+
# Requires RHDH 1.9+ to be handled.
16+
CATALOG_INDEX_IMAGE=quay.io/rhdh/plugin-catalog-index:1.9
17+
1418
# GitHub auth (you need to uncomment github auth section in configs/app-config.local.yaml to enable this)
1519
#AUTH_GITHUB_CLIENT_ID=
1620
#AUTH_GITHUB_CLIENT_SECRET=

docs/rhdh-local-guide/dynamic-plugins-management.md

Lines changed: 12 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -82,6 +82,18 @@ Plugin configuration is managed through `configs/dynamic-plugins/dynamic-plugins
8282

8383
Refer to the [official RHDH documentation](https://docs.redhat.com/en/documentation/red_hat_developer_hub/1.7/html/introduction_to_plugins/con-rhdh-plugins) for more details about dynamic plugins.
8484

85+
## Catalog Index Configuration
86+
87+
Starting in 1.9, RHDH supports loading default plugin configurations from an OCI container image called the **catalog index**. This feature allows you to use centralized plugin configurations that can be updated independently of the RHDH container image. 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).
88+
89+
### Default Configuration
90+
91+
The default value of the `CATALOG_INDEX_IMAGE` environment variable is defined in `default.env`. When `[docker|podman] compose up` runs, the `env_file` directive in `compose.yaml` injects this variable into the `install-dynamic-plugins` container. The container's `install-dynamic-plugins.py` script detects the environment variable and uses `skopeo` to download the OCI image. To use a different catalog index version or a mirrored image, [override it in your local `.env` file](./configuration.md#environment-variables):
92+
93+
```bash
94+
CATALOG_INDEX_IMAGE=my-registry.example.com/org/my-rhdh-plugin-catalog-index:1.2-3
95+
```
96+
8597
### Configuration Structure
8698

8799
Your override file must start with:

0 commit comments

Comments
 (0)