chore(README.md): add inventory table with the list of images and supported architectures #2520
Conversation
github-actions
bot
added
the
review-requested
WalkthroughAdds an “Image Inventory List” section with two tables (Workbench and Runtime) indicating per-architecture support and container URLs, plus a legend for status icons. Inserts this inventory block twice in README.md. Also adds a “For AI Agents” subsection linking to an Agents Guide. No code or API changes. Changes
Estimated code review effort🎯 2 (Simple) | ⏱️ ~8 minutes Pre-merge checks and finishing touches❌ Failed checks (1 warning)
✅ Passed checks (2 passed)
✨ Finishing touches
🧪 Generate unit tests
Tip 👮 Agentic pre-merge checks are now available in preview!Pro plan users can now enable pre-merge checks in their settings to enforce checklists before merging PRs.
Please see the documentation for more information. Example: reviews:
pre_merge_checks:
custom_checks:
- name: "Undocumented Breaking Changes"
mode: "warning"
instructions: |
Pass/fail criteria: All breaking changes to public APIs, CLI flags, environment variables, configuration keys, database schemas, or HTTP/GraphQL endpoints must be documented in the "Breaking Change" section of the PR description and in CHANGELOG.md. Exclude purely internal or private changes (e.g., code not exported from package entry points or explicitly marked as internal).Please share your feedback with us on this Discord post. Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out. Comment |
![coderabbitai[bot]](https://avatars.githubusercontent.com/in/347564?s=60&v=4){kind=small}
There was a problem hiding this comment.
Actionable comments posted: 0
🧹 Nitpick comments (6)
README.md (6)
183-185: Add provenance: last-updated note and source-of-truth pointer.This static table will drift. Add a “Last updated: YYYY‑MM‑DD” note and link to the source-of-truth manifests (runtime/workbench JSON or build matrix), or mark the section as auto‑generated with regeneration instructions.
186-201: Normalize status symbols; avoid “/?” variants.Cells like “
⚠️ /?” and “⏰/?” are ambiguous. Keep to the legend’s four states only: ✅,⚠️ , ⏰, ❌. If unknown, prefer⚠️ with a footnote.
193-197: CUDA/RHEL minor versions could become stale.“UBI9/RHEL9.6” in OS may age quickly. Consider “UBI9/RHEL9 (tested on 9.6)” or footnote the tested minor to reduce churn.
212-216: Fix markdownlint MD004: use dashes for unordered list.Switch asterisks to dashes to satisfy the linter.
Apply this diff:
-* ✅ supported -* ⚠️ under development -* ⏰ planned in the future -* ❌ not supported by vendor +- ✅ supported +- ⚠️ under development +- ⏰ planned in the future +- ❌ not supported by vendor
186-204: Unify column headers across tables.Workbench uses “OS”; Runtime uses “UBI”. Pick one (“OS”) and keep consistent ordering.
Also applies to: 206-209
186-201: Replace per-image quay.io links in README with quay.io/repository/opendatahub/workbench-images (prefer image@sha256 for immutability).Manifests/kustomize in the repo reference workbench-images; the README table currently links to per-image repos (e.g., quay.io/repository/opendatahub/odh-workbench-…), replace the Container column with the workbench-images tag pattern or immutable digests.
Location: README.md (table around lines 186–201).
📜 Review details
Configuration used: Path: .coderabbit.yaml
Review profile: CHILL
Plan: Pro
📒 Files selected for processing (1)
README.md(1 hunks)
🧰 Additional context used
🧠 Learnings (3)
📚 Learning: 2025-09-12T08:39:17.540Z
Learnt from: jiridanek
PR: opendatahub-io/notebooks#2432
File: jupyter/datascience/ubi9-python-3.12/pylock.toml:534-536
Timestamp: 2025-09-12T08:39:17.540Z
Learning: In the opendatahub-io/notebooks project, not all container images are s390x enabled yet. Images without platform markers (like `marker = "platform_machine != 's390x'"`) simply haven't been patched for s390x support yet, indicating a phased rollout approach for s390x enablement across different notebook images.
Applied to files:
README.md
📚 Learning: 2025-07-29T15:56:20.036Z
Learnt from: jiridanek
PR: opendatahub-io/notebooks#1519
File: jupyter/pytorch+llmcompressor/ubi9-python-3.11/runtime-images/llmcompressor-pytorch-ubi9-py311.json:2-9
Timestamp: 2025-07-29T15:56:20.036Z
Learning: Current practice for runtime-images JSON files in opendatahub-io/notebooks: All runtime image configurations use SHA256 digest pinning (format: `sha256:<digest>`) instead of mutable tags for immutability, use `quay.io/opendatahub/workbench-images` registry, include `schema_name: "runtime-image"` field, and follow consistent structure as seen in existing files like datascience-ubi9-py311.json, pytorch-ubi9-py311.json, etc.
Applied to files:
README.md
📚 Learning: 2025-07-04T10:41:13.061Z
Learnt from: grdryn
PR: opendatahub-io/notebooks#1320
File: rstudio/rhel9-python-3.11/Dockerfile.cuda:34-35
Timestamp: 2025-07-04T10:41:13.061Z
Learning: In the opendatahub-io/notebooks repository, when adapting NVIDIA CUDA Dockerfiles, the project intentionally maintains consistency with upstream NVIDIA patterns even when it might involve potential risks like empty variable expansions in package installation commands. This is considered acceptable because the containers only run on RHEL 9 with known yum/dnf behavior, and upstream consistency is prioritized over defensive coding practices.
Applied to files:
README.md
🪛 markdownlint-cli2 (0.17.2)
README.md
212-212: Unordered list style
Expected: dash; Actual: asterisk
(MD004, ul-style)
213-213: Unordered list style
Expected: dash; Actual: asterisk
(MD004, ul-style)
214-214: Unordered list style
Expected: dash; Actual: asterisk
(MD004, ul-style)
215-215: Unordered list style
Expected: dash; Actual: asterisk
(MD004, ul-style)
⏰ Context from checks skipped due to timeout of 90000ms. You can increase the timeout in your CodeRabbit configuration to a maximum of 15 minutes (900000ms). (1)
- GitHub Check: code-static-analysis
🔇 Additional comments (2)
README.md (2)
186-201: Architecture status likely over-claimed; verify s390x/ppc64le/aarch64 columns.Several rows mark s390x as fully supported (✅). In this repo, s390x enablement is still rolling out and gated per image. Please cross-check before publishing.
To audit quickly from the repo:
If uncertain, downgrade to
⚠️ (under development) or ⏰ (planned) until verified.
202-211: Confirm runtime table: repo links and arch support
- Links in README.md (Runtime table) point to per-image repos (quay.io/repository/opendatahub/odh-pipeline-runtime-…). Use the canonical workbench-images repo for published images or confirm the intent and update links.
- Verify architecture columns (aarch64 / ppc64le / s390x / x86_64) with the same scripts used for the Workbench table and align the Runtime rows (replace ⏰/? with accurate ✅/❌).
Location: README.md lines 202–211.
|
Hey @Shafi-Hussain and @Nash-123 👋 |
jiridanek
changed the title
|
[APPROVALNOTIFIER] This PR is APPROVED This pull-request has been approved by: jiridanek The full list of commands accepted by this bot can be found here. The pull request process is described here
Needs approval from an approver in each of these files:
Approvers can indicate their approval by writing |
|
@atheo89: The following test failed, say
Full PR test history. Your PR dashboard. 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. I understand the commands that are listed here. |
|
/hold Revision aad9f19 was retested 3 times: holding |
Added inventory table with the list of images
Description
How Has This Been Tested?
Self checklist (all need to be checked):
make test(gmakeon macOS) before asking for reviewDockerfile.konfluxfiles should be done inodh/notebooksand automatically synced torhds/notebooks. For Konflux-specific changes, modifyDockerfile.konfluxfiles directly inrhds/notebooksas these require special attention in the downstream repository and flow to the upcoming RHOAI release.Merge criteria:
Summary by CodeRabbit