Skip to content

fix: pin catalog index tag to 1.10.2 - #271

Merged
rm3l merged 2 commits into
redhat-developer:mainfrom
rm3l:fix/pin_catalog_index_to_1.10.2
Jul 23, 2026
Merged

rm3l merged 2 commits into
redhat-developer:mainfrom
rm3l:fix/pin_catalog_index_to_1.10.2

Conversation

@rm3l

@rm3l rm3l commented Jul 22, 2026

Copy link
Copy Markdown
Member

Description

1.10 seems to be pointing to an unreleased and unstable 1.10.3 tag, and this is causing some issues with RHDH Local.

Which issue(s) does this PR fix or relate to

ref: RHDHBUGS-3455
ref: RHDHBUGS-3492

PR acceptance criteria

  • Tests updated and passing
  • Documentation updated
  • Built-in TechDocs updated if needed. Note that TechDocs changes may need to be reviewed by a Product Manager and/or Architect to ensure content accuracy, clarity, and alignment with user needs.

How to test changes / Special notes to the reviewer

1.10 seems to be pointing to an unreleased and unstable 1.10.3 tag

ref: RHDHBUGS-3455 RHDHBUGS-3492
@rm3l

rm3l commented Jul 22, 2026

Copy link
Copy Markdown
Member Author

/cherry-pick release-1.10

@openshift-cherrypick-robot

Copy link
Copy Markdown
Contributor

@rm3l: once the present PR merges, I will cherry-pick it on top of release-1.10 in a new PR and assign it to you.

Details

In response to this:

/cherry-pick release-1.10

Instructions for interacting with me using PR comments are available here. If you have questions or suggestions related to my behavior, please file an issue against the kubernetes-sigs/prow repository.

@rm3l
rm3l marked this pull request as ready for review July 22, 2026 13:39
@rm3l rm3l changed the title fix: temporarily pin catalog index tag to 1.10.2 fix: pin catalog index tag to 1.10.2 Jul 22, 2026
@rm3l

rm3l commented Jul 22, 2026

Copy link
Copy Markdown
Member Author

/cc @kadel

@openshift-ci
openshift-ci Bot requested a review from kadel July 22, 2026 13:39
@rhdh-qodo-merge

Copy link
Copy Markdown
Contributor

Code Review by Qodo

🐞 Bugs (1) 📘 Rule violations (0) 🔗 Cross-repo conflicts (1) 📜 Skill insights (0)

Context used
✅ Cross-repo context
  Explored: repo: redhat-developer/rhdh (sha: 9cfaf577)
  Not relevant to this PR: redhat-developer/rhdh-plugins

Grey Divider


Remediation recommended

1. Stale :1.10 tag examples 🐞 Bug ⚙ Maintainability
Description
default.env now documents that the floating :1.10 tag is problematic and pins
CATALOG_INDEX_IMAGE to :1.10.2, but the repo still shows EXTRA_CATALOG_INDEX_IMAGES examples
using :1.10. Users copying those examples can still configure the unstable floating tag and run
into the issues this PR is trying to mitigate.
Code

default.env[R16-17]

+# TODO: Pinned due to issues with the floating 1.10 tag - see RHDHBUGS-3455 and RHDHBUGS-3492
+CATALOG_INDEX_IMAGE=quay.io/rhdh/plugin-catalog-index:1.10.2
Relevance

⭐⭐⭐ High

Team often fixes stale/mismatched docs/examples for env vars (accepted updates in PR #216, #149).

PR-#216
PR-#149

ⓘ Recommendations generated based on similar findings in past PRs

Evidence
The PR itself states the floating :1.10 tag is problematic and pins the default image to
:1.10.2, but other in-repo examples still reference :1.10 for extra catalog index images.

default.env[14-24]
docs/rhdh-local-guide/dynamic-plugins-management.md[99-114]

Agent prompt
The issue below was found during a code review. Follow the provided context and guidance below and implement a solution

### Issue description
`default.env` explicitly notes the floating `:1.10` tag is problematic and pins the primary `CATALOG_INDEX_IMAGE` to `:1.10.2`, but examples for configuring extra catalog index images still use `:1.10`. This creates inconsistent guidance and makes it easy for users to reintroduce the unstable tag.

### Issue Context
The PR’s new comment indicates the floating `:1.10` tag is unreliable; examples in `default.env` and `docs/rhdh-local-guide/dynamic-plugins-management.md` still reference `:1.10` for `EXTRA_CATALOG_INDEX_IMAGES`.

### Fix Focus Areas
- default.env[19-24]
- docs/rhdh-local-guide/dynamic-plugins-management.md[105-114]

### Suggested fix
- Replace `quay.io/rhdh/plugin-catalog-index:1.10` in the `EXTRA_CATALOG_INDEX_IMAGES` examples with `quay.io/rhdh/plugin-catalog-index:1.10.2` (or add an explicit warning not to use the floating `:1.10` tag in examples).

ⓘ Copy this prompt and use it to remediate the issue with your preferred AI generation tools


2. Catalog index tag mismatch 🔗 Cross-repo conflict ≡ Correctness
Description
rhdh-local now pins CATALOG_INDEX_IMAGE to 1.10.2 while compose.yaml still defaults
RHDH_IMAGE to the floating :1.10, which can resolve to a different patch version and create an
untested backend↔catalog-index combination. In redhat-developer/rhdh CI/examples, catalog-index
tags are shown being coordinated with the app image tag, so this default skew may cause
plugin/runtime incompatibilities for users.
Code

default.env[R16-17]

+# TODO: Pinned due to issues with the floating 1.10 tag - see RHDHBUGS-3455 and RHDHBUGS-3492
+CATALOG_INDEX_IMAGE=quay.io/rhdh/plugin-catalog-index:1.10.2
Relevance

⭐⭐ Medium

Team values keeping defaults consistent (PR #57), but also prefers floating minor tags in defaults
(PR #205).

PR-#57
PR-#205
PR-#180

ⓘ Recommendations generated based on similar findings in past PRs

Evidence
The PR pins the catalog-index image to a patch tag while the default backend image remains on a
floating minor tag. Upstream rhdh documentation/scripts show examples where the backend tag and
catalog-index tag are selected together (same patch for GA verification, or same minor family for
CI/RC), indicating an expectation of coordination to avoid mismatched combinations.

default.env[14-18]
compose.yaml[24-30]
External repo: redhat-developer/rhdh, .ci/pipelines/trigger-nightly-job.sh [101-110]

Agent prompt
The issue below was found during a code review. Follow the provided context and guidance below and implement a solution

## Issue description
`default.env` pins `CATALOG_INDEX_IMAGE` to `1.10.2`, but `compose.yaml` still defaults `RHDH_IMAGE` to `:1.10` (floating). This can yield a mixed-version runtime (backend at one patch, catalog-index at another), which is contrary to how the upstream `rhdh` repo demonstrates pairing app and catalog-index tags.

## Issue Context
- This repo (rhdh-local) is a runtime harness that pulls published RHDH images and separately pulls a plugin catalog-index image.
- Upstream `redhat-developer/rhdh` examples show coordinated tag usage for the backend image and the catalog-index image.

## Fix Focus Areas
- default.env[14-18]
- compose.yaml[24-30]

ⓘ Copy this prompt and use it to remediate the issue with your preferred AI generation tools


Grey Divider

Qodo Logo

@rhdh-qodo-merge

Copy link
Copy Markdown
Contributor

PR Summary by Qodo

Temporarily pin plugin catalog index image tag to 1.10.2

🐞 Bug fix ⚙️ Configuration changes 🕐 Less than 10 minutes

Grey Divider

AI Description

• Pin the default plugin catalog index image from 1.10 to 1.10.2 to avoid unstable 1.10.3.
• Document the temporary pin with references to RHDHBUGS-3455 and RHDHBUGS-3492.
• Normalize the trailing newline for NOTEBOOKS_QUERY_PROVIDER_ID in default.env.
Diagram

graph TD dev["Maintainer"] --> env["default.env"] --> local["RHDH Local"] --> reg["quay.io/rhdh"] --> img["plugin-catalog-index:1.10.2"]
Loading
High-Level Assessment

The following are alternative approaches to this PR:

1. Pin by image digest (immutable)
  • ➕ Eliminates tag retargeting risk entirely
  • ➕ Provides reproducible local environments across time
  • ➖ Less readable than a semantic tag
  • ➖ Requires updating digest when intentionally upgrading
2. Make the default tag configurable via version file/override layer
  • ➕ Avoids hardcoding a temporary workaround in default.env
  • ➕ Allows consumers to override without diffing env defaults
  • ➖ Adds indirection and more moving parts for a short-term fix
3. Automated preflight validation for catalog index tag
  • ➕ Detects broken/unreleased tags early in CI or startup
  • ➕ Reduces future regressions when floating tags move
  • ➖ More work than warranted for an immediate unblock
  • ➖ May require registry access in CI/startup contexts

Recommendation: Accept this PR as a quick containment fix for a known-bad floating tag. If the instability persists, follow up by pinning to an image digest (preferred) to make the default fully immutable and avoid repeat incidents when tags are repointed.

Files changed (1) +3 / -2

Other (1) +3 / -2
default.envPin CATALOG_INDEX_IMAGE to 1.10.2 and add rationale comment +3/-2

Pin CATALOG_INDEX_IMAGE to 1.10.2 and add rationale comment

• Pins the default plugin catalog index image from the floating 1.10 tag to 1.10.2 and adds a TODO comment referencing the tracked bugs. Also ensures NOTEBOOKS_QUERY_PROVIDER_ID ends with a newline (no functional change).

default.env

@sonarqubecloud

Copy link
Copy Markdown

@rm3l
rm3l merged commit 937edb3 into redhat-developer:main Jul 23, 2026
19 checks passed
@rm3l
rm3l deleted the fix/pin_catalog_index_to_1.10.2 branch July 23, 2026 11:27
@openshift-cherrypick-robot

Copy link
Copy Markdown
Contributor

@rm3l: new pull request created: #273

Details

In response to this:

/cherry-pick release-1.10

Instructions for interacting with me using PR comments are available here. If you have questions or suggestions related to my behavior, please file an issue against the kubernetes-sigs/prow repository.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

Projects

None yet

Development

Successfully merging this pull request may close these issues.

3 participants