Skip to content

Conversation

@biswapanda
Copy link
Contributor

@biswapanda biswapanda commented Aug 22, 2025

Overview:

  • fix deploy yaml: add required backendFramework
  • fix messages to match with README doc

nvbug: https://nvbugspro.nvidia.com/bug/5471412
closes: DYN-926

Summary by CodeRabbit

  • New Features

    • Deployment now supports selecting vLLM as the backend framework.
  • Chores

    • Simplified the Hello World example’s startup and readiness behavior for smoother launches.
    • Standardized the example client’s request payload to produce consistent streaming output.

@biswapanda biswapanda force-pushed the bis/dyn-926-hello-world-example-is-crash-looping branch from 2dabc02 to b09fc30 Compare August 22, 2025 02:15
@biswapanda
Copy link
Contributor Author

/ok to test b09fc30

@coderabbitai
Copy link
Contributor

coderabbitai bot commented Aug 22, 2025

Walkthrough

The client request payload in examples/runtime/hello_world/client.py was changed from an index-based string to a fixed string. The deployment YAML adds spec.backendFramework: vllm, adjusts HelloWorldWorker readinessProbe to a no-op command, and removes log piping from the container args.

Changes

Cohort / File(s) Summary of Changes
Client request payload
examples/runtime/hello_world/client.py
Replaced dynamic f-string payload using idx with fixed string "world,sun,moon,star" in client.generate; loop, streaming, backoff, and error handling unchanged.
Deployment spec and probes
examples/runtime/hello_world/deploy/hello_world.yaml
Added spec.backendFramework: vllm. Changed HelloWorldWorker readinessProbe exec to exit 0 (bypass check). Updated container args to run python3 hello_world.py without log piping to /tmp/hello_world.log.

Estimated code review effort

🎯 3 (Moderate) | ⏱️ ~25 minutes

Possibly related PRs

Poem

A bunny taps the keys—hop, hop, hooray!
The client’s words now fixed, no index in the fray.
A probe that simply nods, “All good!” then away—
Backend whispers: vllm lights the way.
Moon, star, sun—queries at play. 🌙⭐️☀️

Tip

🔌 Remote MCP (Model Context Protocol) integration is now available!

Pro plan users can now connect to remote MCP servers from the Integrations page. Connect with popular remote MCPs such as Notion and Linear to add more context to your reviews and chats.


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.
    • 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.
  • 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 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/Issue comments)

Type @coderabbitai help to get the list of available commands.

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.

Status, Documentation and Community

  • Visit our Status Page to check the current availability of CodeRabbit.
  • 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
Contributor

@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 (2)
examples/runtime/hello_world/deploy/hello_world.yaml (2)

60-68: Readiness probe always returns success; consider tying readiness to actual process health.

Using exit 0 makes the pod "ready" even when the worker hasn’t started correctly, which can mask startup/config issues. If the worker doesn’t expose a health endpoint (typical for a non-serving worker), a lightweight readiness check that the Python process is running is safer.

Apply this diff to make readiness reflect process availability:

-            - "exit 0"
+            - 'ps -ef | grep -q "[p]ython3 hello_world.py" || exit 1'

Note: if your base image lacks ps, use pgrep -f instead, or drop readiness entirely for the worker if it’s not used for traffic gating.


87-87: Log flushing: use unbuffered Python for timely container logs.

Without the previous tee, stdout buffering can delay logs. Running Python unbuffered improves observability.

-            - python3 hello_world.py
+            - python3 -u hello_world.py
📜 Review details

Configuration used: Path: .coderabbit.yaml

Review profile: CHILL

Plan: Pro

💡 Knowledge Base configuration:

  • MCP integration is disabled by default for public repositories
  • Jira integration is disabled by default for public repositories
  • Linear integration is disabled by default for public repositories

You can enable these sources in your CodeRabbit configuration.

📥 Commits

Reviewing files that changed from the base of the PR and between 7076990 and b09fc30.

📒 Files selected for processing (2)
  • examples/runtime/hello_world/client.py (1 hunks)
  • examples/runtime/hello_world/deploy/hello_world.yaml (3 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 - dynamo
🔇 Additional comments (2)
examples/runtime/hello_world/deploy/hello_world.yaml (1)

9-9: CRD enum “vllm” is valid
Verified that both the GraphDeployment and ComponentDeployment CRDs (operator and Helm charts) list “vllm” exactly as a permitted enum value for backendFramework. No casing or enum mismatches remain—this change can be approved.

examples/runtime/hello_world/client.py (1)

43-43: Static prompt matches README — OK.

Change aligns with the docs and is fine. Keeping idx for error context is still useful even if it’s not in the prompt.

@biswapanda biswapanda enabled auto-merge (squash) August 22, 2025 02:54
@grahamking
Copy link
Contributor

grahamking commented Aug 22, 2025

@biswapanda Could you update the title? I'm not sure what "hello world yaml and messages" means.

The title of the PR becomes the commit message, so it should be something we can read in 3 months and understand what's in the commit.

@biswapanda biswapanda changed the title fix: hello world yaml and messages fix: hello world example deployment liveness probe and match message responses with readme Aug 22, 2025
@biswapanda
Copy link
Contributor Author

@biswapanda Could you update the title? I'm not sure what "hello world yaml and messages" means.

The title of the PR becomes the commit message, so it should be something we can read in 3 months and understand what's in the commit.

fixed the deployment

@biswapanda biswapanda changed the title fix: hello world example deployment liveness probe and match message responses with readme fix: hello world deployment liveness probe and match message responses with readme Aug 22, 2025
@biswapanda biswapanda merged commit dc56d6c into main Aug 22, 2025
13 of 14 checks passed
@biswapanda biswapanda deleted the bis/dyn-926-hello-world-example-is-crash-looping branch August 22, 2025 23:47
biswapanda added a commit that referenced this pull request Aug 23, 2025
hhzhang16 pushed a commit that referenced this pull request Aug 27, 2025
nv-anants pushed a commit that referenced this pull request Aug 28, 2025
jasonqinzhou pushed a commit that referenced this pull request Aug 30, 2025
KrishnanPrash pushed a commit that referenced this pull request Sep 2, 2025
nnshah1 pushed a commit that referenced this pull request Sep 8, 2025
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Projects

None yet

Development

Successfully merging this pull request may close these issues.

5 participants