Skip to content

chore: add EXTRA_CATALOG_INDEX_IMAGES env var support [RHIDP-12936] #215

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
rm3l merged 1 commit into from
May 18, 2026
Merged

chore: add EXTRA_CATALOG_INDEX_IMAGES env var support [RHIDP-12936] #215

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
6 changes: 6 additions & 0 deletions default.env
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -15,6 +15,12 @@ BASE_URL=http://localhost:7007
# Requires RHDH 1.9+ to be handled.
CATALOG_INDEX_IMAGE=quay.io/rhdh/plugin-catalog-index:1.10

# Extra catalog index images (comma-separated).
# Plugins from these images appear in the Extensions UI but are not installed by default.
# Supports both plain refs and named refs: name=<image_ref>,<image_ref>
# Requires RHDH 1.10+ to be handled.
#EXTRA_CATALOG_INDEX_IMAGES=community=quay.io/rhdh/plugin-catalog-index:1.10

# Path in the install-dynamic-plugins container where the extensions catalog entities should be extracted to, from the catalog index image
# Requires RHDH 1.9+ to be handled
CATALOG_ENTITIES_EXTRACT_DIR=/extensions
Expand Down
2 changes: 2 additions & 0 deletions docs/rhdh-local-guide/configuration.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -55,6 +55,8 @@ echo "LOG_LEVEL=debug" >> .env
Common variables to customize:

- `RHDH_IMAGE`: RHDH container image version
- `CATALOG_INDEX_IMAGE`: Primary plugin catalog index image
- `EXTRA_CATALOG_INDEX_IMAGES`: Additional catalog index images (comma-separated). See the [catalog index docs](dynamic-plugins-management.md#extra-catalog-index-images) for details
- `LOG_LEVEL`: RHDH application log level
- GitHub authentication variables (see the [GitHub auth guide](github-auth.md))

Expand Down
19 changes: 19 additions & 0 deletions docs/rhdh-local-guide/dynamic-plugins-management.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -96,6 +96,25 @@ The default value of the `CATALOG_INDEX_IMAGE` environment variable is defined i
CATALOG_INDEX_IMAGE=my-registry.example.com/org/my-rhdh-plugin-catalog-index:1.2-3
```

### Extra catalog index images

Starting in 1.10, you can configure additional catalog index images alongside the primary one using the `EXTRA_CATALOG_INDEX_IMAGES` environment variable. Plugins from these extra images appear in the Extensions UI but are not installed by default (they do not contribute `dynamic-plugins.default.yaml` files).

Set `EXTRA_CATALOG_INDEX_IMAGES` in your `.env` file as a comma-separated list of image references. You can optionally prefix each reference with a name for cleaner extraction directory names:

```bash
# Plain image references (directory names are auto-derived from the image ref)
EXTRA_CATALOG_INDEX_IMAGES=quay.io/my-org/my-catalog-index:1.0

# Named references (recommended — produces cleaner directory names like /extensions/extra/community/)
EXTRA_CATALOG_INDEX_IMAGES=community=quay.io/rhdh/plugin-catalog-index:1.10

# Multiple images
EXTRA_CATALOG_INDEX_IMAGES=community=quay.io/rhdh/plugin-catalog-index:1.10,partner=quay.io/my-org/partner-catalog:2.0
```

Extra catalog entities are extracted under `<CATALOG_ENTITIES_EXTRACT_DIR>/extra/<name>/`, keeping them separate from the primary catalog index.

### Configuration Structure

Your override file must start with:
Expand Down