fix: add instruction to deploy model with inference gateway

[biswapanda]

Overview:

• update dynamo inference gateway doc to point at examples
• rebased on latest main to get changes from docs: Dyn 591 #2247
• add instruction to deploy using custom images

closes:
linear: DEP-297
nvbug

Cherypick into release branch: #2260

Summary by CodeRabbit

• Documentation
  • Updated instructions to clearly separate the model deployment and helm chart installation steps, providing explicit guidance and sample commands for deploying the model before installing the inference gateway.

[coderabbitai]

Walkthrough

The documentation for the inference gateway deployment process was updated. The previously combined step for installing the model and helm chart was split into two separate steps: one for deploying the model and another for installing the helm chart. Explicit instructions and sample commands for model deployment were added.

Changes

Cohort / File(s)	Change Summary
Inference Gateway Deployment Documentation deploy/inference-gateway/README.md	Clarified and separated the deployment steps by splitting model deployment and helm chart installation into distinct steps, adding explicit instructions and sample commands for model deployment.

Estimated code review effort

🎯 1 (Trivial) | ⏱️ ~2 minutes

Possibly related PRs

• feat: gaie helm chart based example #2168: Adds a comprehensive example README and resources for deploying the inference gateway with Dynamo and GAIE helm charts, directly modifying the same README and deployment instructions.

Poem

A hop, a skip, a doc refined,
Steps split apart, now clearly aligned.
Deploy your model, then helm with glee—
Instructions as crisp as a carrot can be.
With every command, a bunny’s delight,
Clearer deployments, morning to night! 🥕

Note

⚡️ Unit Test Generation is now available in beta!

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

---

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

• X
• Mastodon
• Reddit
• LinkedIn

🪧 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.
  • @coderabbitai modularize this function.
• 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.
  • @coderabbitai help me debug CodeRabbit configuration file.

Support

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

Note: Be mindful of the bot's finite context window. It's strongly recommended to break down tasks such as reading entire modules into smaller chunks. For a focused discussion, use review comments to chat about specific files and their changes, instead of using the PR comments.

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 sequence diagram to generate a sequence diagram of the changes in 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.

[coderabbitai]

Actionable comments posted: 0

🧹 Nitpick comments (1)

deploy/inference-gateway/README.md (1)

77-81: Minor wording & formatting tweaks

1. Capitalise the sentence starter and fix the code-block caption:

-sample commands to deploy model:
+Sample command to deploy the model:

2. Consider adding a reminder that agg.yaml must point to the correct image/weights bucket if users customised it.

Purely editorial; feel free to ignore.

📜 Review details

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

📥 Commits

Reviewing files that changed from the base of the PR and between c86052c and 395944a.

📒 Files selected for processing (1)

• deploy/inference-gateway/README.md (1 hunks)

⏰ 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: Build and Test - vllm

🔇 Additional comments (1)

deploy/inference-gateway/README.md (1)

73-83: No duplicate InferenceModel – step 3’s agg.yaml doesn’t define that CRD

I inspected the vLLM aggregate manifest and the Helm chart:

• components/backends/vllm/deploy/agg.yaml contains no kind: InferenceModel.
• The only InferenceModel resource lives in
  deploy/inference-gateway/helm/dynamo-gaie/templates/inference-model.yaml.

Since step 3 does not create an InferenceModel, there’s no conflict when you install the Helm chart in step 4. You can ignore the suggestion to pass --set inferenceModel.enabled=false.

Likely an incorrect or invalid review comment.

[copy-pr-bot]

This pull request requires additional validation before any workflows can run on NVIDIA's runners.

Pull request vetters can view their responsibilities here.

Contributors can view more details about this message here.

[biswapanda]

@ishandhanani @athreesh please take another look.
i've addressed your comments

• updated components/backends/<backend>/deploy/README.md files

[biswapanda]

rebased on top of main (8f24c02)