-
Task
-
Resolution: Done
-
Major
-
None
-
None
-
None
Task
Current 1.9 docs has a community plugins migration + bundle plugins tables that are missing a plugin version column.
This will cause confusion (and support tickets) for a number of reasons. The docs has a number of notes/tips:
* Navigating the overlays repo and looking up the tags is not idealReplace <tag> with the version tag corresponding to your
product-short
version. For the latest tags, see the link:[https://github.com/redhat-developer/rhdh-plugin-export-overlays[rhdh-plugin-export-overlays] repository|https://github.com/redhat-developer/rhdh-plugin-export-overlays[rhdh-plugin-export-overlays]%20repository].
* We need to tell users how to find this digestTo ensure environment stability, use a SHA256 digest instead of a version tag.
* The instructions do not inform users they need to install skopeo or jq.=== Finding available tags
To list available image tags for a plugin, run the following command:
- Using skopeo (filter for bs_ tags only, excluding pr_ and next__ tags)
skopeo list-tags docker://ghcr.io/redhat-developer/rhdh-plugin-export-overlays/<plugin-name> | jq -r '.Tags[]' | grep '^bs_'
- <plugin-name> is also incorrect. The name is actually comprised of the namespace+plugin name. Users can look it up on the existing table, they shouldn't have to figure this out
- The results of the "skopeo list-tags" command will generate a list of "bs" prefixed tags. The users will not know which one is compatible with RHDH 1.9. We also have a known issue where vNext code can leak into the Z streams (see https://issues.redhat.com/browse/RHIDP-12348)
bs_1.42.5__0.2.0 bs_1.42.5__1.0.1 bs_1.42.5__2.0.1 bs_1.45.3__2.0.1 bs_1.45.3__2.2.0 bs_1.45.3__2.3.0 bs_1.45.3__2.3.1 bs_1.45.3__2.3.2 bs_1.45.3__2.3.3 bs_1.45.3__2.3.4 bs_1.45.3__2.3.5
Fix:
- We should be able to improve the instructions by adding a "Plugin Version" column to these tables. This should help with Z stream updates if the plugin does get a version bump, it'll be updated in the metadata and then re-generated in the docs so the tables will hopefully stay up to date
- We can assume <tag> is of the form "bs_1.45.3__" + "<plugin version>" (need to confirm). If this assumption holds true, the users can then construct a URL and run skopeo to determine the sha256 digest. e.g.
skopeo inspect docker://ghcr.io/redhat-developer/rhdh-plugin-export-overlays/roadiehq-scaffolder-backend-module-http-request:bs_1.45.3__5.5.1 | jq '.Digest' "sha256:d299073100d458302ce5b358c2239993eb3e33aa7137ab2a3679c8e54be13ad3"
which matches what's in the overlays repo
Background
Dependencies and Blockers
QE impacted work
Documentation impacted work
Acceptance Criteria