Skip to content

RHAI-ENG-305-installation-update-for-odh - added RAG - Llamstack comp… #896

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.

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

Open
wants to merge 1 commit into
base: main
Choose a base branch
from

Conversation

chtyler
Copy link
Contributor

@chtyler chtyler commented Aug 6, 2025

…onent to odh install/upgrade docs

Description

Updated the ODH installation/upgrade docs with information installingon the Llama Stack Operator for RAG-based functionality.

The component Operator table was updated with the RAG component. Instructions are already available below the table on how to active each component. Also added a prerequisite that you need a GPU-enabled instance to use rag/llama stack.

How Has This Been Tested?

Merge criteria:

  • The commits are squashed in a cohesive manner and have meaningful messages.
  • Testing instructions have been added in the PR body (for PRs involving changes that are not immediately obvious).
  • The developer has manually tested the changes and verified that the changes work

Summary by CodeRabbit

  • Documentation
    • Updated installation guide to include the new RAG component.
    • Added GPU-enabled infrastructure as a prerequisite for using the RAG component.
    • Listed required operators for the RAG (Llama Stack) component in the documentation.

Copy link

coderabbitai bot commented Aug 6, 2025

Walkthrough

The installation documentation for Open Data Hub was updated to mention the new RAG (Llama Stack) component. It now specifies that GPU-enabled infrastructure is required for RAG and lists the necessary operators in the components table, including their sources and requirements.

Changes

Cohort / File(s) Change Summary
ODH Install Docs – RAG Component Addition
modules/installing-odh-components.adoc
Added RAG (Llama Stack) to the components table, specified GPU prerequisites, and listed required operators.

Estimated code review effort

🎯 1 (Trivial) | ⏱️ ~2 minutes

Possibly related PRs

Suggested reviewers

  • jgarciao
  • bredamc

Note

⚡️ Unit Test Generation is now available in beta!

Learn more here, or try it out under "Finishing Touches" below.

✨ Finishing Touches
🧪 Generate unit tests
  • Create PR with unit tests
  • Post copyable unit tests in a comment

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.

❤️ Share
🪧 Tips

Chat

There are 3 ways to chat with CodeRabbit:

  • Review comments: Directly reply to a review comment made by CodeRabbit. Example:
    • I pushed a fix in commit <commit_id>, please review it.
    • Explain this complex logic.
    • Open a follow-up GitHub issue for this discussion.
  • Files and specific lines of code (under the "Files changed" tab): Tag @coderabbitai in a new review comment at the desired location with your query. Examples:
    • @coderabbitai explain this code block.
  • PR comments: Tag @coderabbitai in a new PR comment to ask questions about the PR branch. For the best results, please provide a very specific query, as very limited context is provided in this mode. Examples:
    • @coderabbitai gather interesting stats about this repository and render them as a table. Additionally, render a pie chart showing the language distribution in the codebase.
    • @coderabbitai read src/utils.ts and explain its main purpose.
    • @coderabbitai read the files in the src/scheduler package and generate a class diagram using mermaid and a README in the markdown format.

Support

Need help? Create a ticket on our support page for assistance with any issues or questions.

CodeRabbit Commands (Invoked using PR comments)

  • @coderabbitai pause to pause the reviews on a PR.
  • @coderabbitai resume to resume the paused reviews.
  • @coderabbitai review to trigger an incremental review. This is useful when automatic reviews are disabled for the repository.
  • @coderabbitai full review to do a full review from scratch and review all the files again.
  • @coderabbitai summary to regenerate the summary of the PR.
  • @coderabbitai generate docstrings to generate docstrings for this PR.
  • @coderabbitai generate sequence diagram to generate a sequence diagram of the changes in this PR.
  • @coderabbitai generate unit tests to generate unit tests for this PR.
  • @coderabbitai resolve resolve all the CodeRabbit review comments.
  • @coderabbitai configuration to show the current CodeRabbit configuration for the repository.
  • @coderabbitai help to get help.

Other keywords and placeholders

  • Add @coderabbitai ignore anywhere in the PR description to prevent this PR from being reviewed.
  • Add @coderabbitai summary to generate the high-level summary at a specific location in the PR description.
  • Add @coderabbitai anywhere in the PR title to generate the title automatically.

Documentation and Community

  • Visit our Documentation for detailed information on how to use CodeRabbit.
  • Join our Discord Community to get help, request features, and share feedback.
  • Follow us on X/Twitter for updates and announcements.

Copy link

@coderabbitai coderabbitai bot left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Actionable comments posted: 0

🧹 Nitpick comments (1)
modules/installing-odh-components.adoc (1)

15-15: Tighten wording of the GPU prerequisite

The bullet is clear but could be more directive and concise. Consider explicitly stating the requirement (“must include GPU-enabled nodes”) rather than the softer “supports”, and move “for example AWS g4dn.xlarge” inside parentheses for consistency with other bullets.

-* If you want to use the `RAG` component, your infrastructure supports GPU-enabled instance types, for example, `g4dn.xlarge` on AWS.
+* If you want to use the `RAG` component, your cluster must include GPU-enabled nodes (for example AWS `g4dn.xlarge` instances).
📜 Review details

Configuration used: .coderabbit.yaml
Review profile: CHILL
Plan: Pro

📥 Commits

Reviewing files that changed from the base of the PR and between 46e0e7e and b99014b.

📒 Files selected for processing (1)
  • modules/installing-odh-components.adoc (2 hunks)
🧰 Additional context used
🧠 Learnings (3)
📓 Common learnings
Learnt from: jiridanek
PR: opendatahub-io/opendatahub-documentation#888
File: modules/about-workbench-images.adoc:105-105
Timestamp: 2025-07-31T15:09:05.126Z
Learning: In the opendatahub-documentation project, ROCm workbench images come pre-integrated with additional frameworks and dependencies that users can utilize, rather than requiring users to integrate frameworks themselves. When describing these images, the focus should be on the pre-integrated capabilities rather than user integration tasks.
Learnt from: bredamc
PR: opendatahub-io/opendatahub-documentation#860
File: modules/using-llm-as-a-judge-metrics-with-lmeval.adoc:62-65
Timestamp: 2025-07-16T09:10:15.185Z
Learning: In the opendatahub-documentation project, avoid suggesting unnecessary admonition blocks (NOTE, WARNING, IMPORTANT, etc.) for explanatory text that can be effectively communicated inline. The documentation team prefers cleaner, less cluttered documentation with inline text unless the information is critical enough to warrant special formatting emphasis.
📚 Learning: in the opendatahub-documentation project, rocm workbench images come pre-integrated with additional ...
Learnt from: jiridanek
PR: opendatahub-io/opendatahub-documentation#888
File: modules/about-workbench-images.adoc:105-105
Timestamp: 2025-07-31T15:09:05.126Z
Learning: In the opendatahub-documentation project, ROCm workbench images come pre-integrated with additional frameworks and dependencies that users can utilize, rather than requiring users to integrate frameworks themselves. When describing these images, the focus should be on the pre-integrated capabilities rather than user integration tasks.

Applied to files:

  • modules/installing-odh-components.adoc
📚 Learning: in the opendatahub-documentation project, avoid suggesting unnecessary admonition blocks (note, warn...
Learnt from: bredamc
PR: opendatahub-io/opendatahub-documentation#860
File: modules/using-llm-as-a-judge-metrics-with-lmeval.adoc:62-65
Timestamp: 2025-07-16T09:10:15.185Z
Learning: In the opendatahub-documentation project, avoid suggesting unnecessary admonition blocks (NOTE, WARNING, IMPORTANT, etc.) for explanatory text that can be effectively communicated inline. The documentation team prefers cleaner, less cluttered documentation with inline text unless the information is critical enough to warrant special formatting emphasis.

Applied to files:

  • modules/installing-odh-components.adoc
🔇 Additional comments (1)
modules/installing-odh-components.adoc (1)

42-44: Verify catalog column & operator list for the RAG row

  1. The NVIDIA GPU Operator typically resides in the “NVIDIA” (certified) catalog, not the “Red Hat” catalog.
  2. If a row mixes operators from multiple catalogs, split them with commas (e.g. “Red Hat, NVIDIA”) or clarify per-operator catalog per existing doc pattern.
  3. Double-check that Node Feature Discovery Operator is indeed sourced from the Red Hat catalog in the current OCP release.

Please confirm and adjust to avoid misleading users during installation.

@@ -12,6 +12,7 @@ You can use the OpenShift web console to install specific components of Open Dat
ifdef::upstream[]
* If you want to use the `trustyai` component, you must enable user workload monitoring as described in link:{odhdocshome}/monitoring-data-science-models/#configuring-monitoring-for-the-multi-model-serving-platform_monitor[Configuring monitoring for the multi-model serving platform].
endif::[]
* If you want to use the `RAG` component, your infrastructure supports GPU-enabled instance types, for example, `g4dn.xlarge` on AWS.

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I think that it is not what RHAIENG-305 is about. I think we should document that if user wants to use llamastack, he needs to enable llamastackoperator component in "datasciencecluster" custom resource.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants