Skip to content

Conversation

@KrishnanPrash
Copy link
Contributor

@KrishnanPrash KrishnanPrash commented Jul 31, 2025

Overview:

Removing variables that are no longer necessary with tensorrt_llm==1.0.0rc4

Details:

Changes to documentation

Summary by CodeRabbit

  • Documentation
    • Simplified the instructions for enabling KV cache transfer by removing environment variable configuration steps. Now, only the requirement to have ETCD and NATS services running is mentioned.

@copy-pr-bot
Copy link

copy-pr-bot bot commented Jul 31, 2025

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.

@coderabbitai
Copy link
Contributor

coderabbitai bot commented Jul 31, 2025

Walkthrough

The documentation for enabling NIXL in KV cache transfer within disaggregated serving was simplified by removing environment variable configuration instructions. The remaining guidance now only reminds users to ensure ETCD and NATS services are running before starting the service.

Changes

Cohort / File(s) Change Summary
KV Cache Transfer Documentation
components/backends/trtllm/kv-cache-tranfer.md
Removed instructions about setting/unsetting environment variables for NIXL and UCX; retained service prerequisites reminder.

Estimated code review effort

🎯 1 (Trivial) | ⏱️ ~2 minutes

Possibly related PRs

Poem

A nibble here, a nibble there,
Docs made lighter, with gentle care.
No more vars to set or chase,
Just ETCD and NATS in place.
Hop along, the guide is neat—
Simpler docs are quite a treat! 🥕

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
🪧 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.

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)
components/backends/trtllm/kv-cache-tranfer.md (2)

20-20: Filename is misspelled (“tranfer” → “transfer”)

The markdown header is correct, but the file path itself (kv-cache-tranfer.md) contains a typo. Renaming the file avoids broken links and 404s in downstream references.


64-64: Consider promoting the ETCD/NATS prerequisite into a separate prerequisite section

The single-line “Important” note can be missed easily. A short “Prerequisites” subsection (before the numbered steps) would improve readability.

📜 Review details

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

📥 Commits

Reviewing files that changed from the base of the PR and between f10e44c and 3cea1b0.

📒 Files selected for processing (1)
  • components/backends/trtllm/kv-cache-tranfer.md (1 hunks)
🧰 Additional context used
🧠 Learnings (3)
📓 Common learnings
Learnt from: GuanLuo
PR: ai-dynamo/dynamo#1371
File: examples/llm/benchmarks/vllm_multinode_setup.sh:18-25
Timestamp: 2025-06-05T01:46:15.509Z
Learning: In multi-node setups with head/worker architecture, the head node typically doesn't need environment variables pointing to its own services (like NATS_SERVER, ETCD_ENDPOINTS) because local processes can access them via localhost. Only worker nodes need these environment variables to connect to the head node's external IP address.
Learnt from: dmitry-tokarev-nv
PR: ai-dynamo/dynamo#2179
File: docs/support_matrix.md:61-63
Timestamp: 2025-07-30T00:34:35.810Z
Learning: In docs/support_matrix.md, the NIXL version difference between runtime dependencies (0.5.0) and build dependencies (0.4.0) is intentional and expected, not an error that needs to be corrected.
📚 Learning: in docs/support_matrix.md, the nixl version difference between runtime dependencies (0.5.0) and buil...
Learnt from: dmitry-tokarev-nv
PR: ai-dynamo/dynamo#2179
File: docs/support_matrix.md:61-63
Timestamp: 2025-07-30T00:34:35.810Z
Learning: In docs/support_matrix.md, the NIXL version difference between runtime dependencies (0.5.0) and build dependencies (0.4.0) is intentional and expected, not an error that needs to be corrected.

Applied to files:

  • components/backends/trtllm/kv-cache-tranfer.md
📚 Learning: in multi-node setups with head/worker architecture, the head node typically doesn't need environment...
Learnt from: GuanLuo
PR: ai-dynamo/dynamo#1371
File: examples/llm/benchmarks/vllm_multinode_setup.sh:18-25
Timestamp: 2025-06-05T01:46:15.509Z
Learning: In multi-node setups with head/worker architecture, the head node typically doesn't need environment variables pointing to its own services (like NATS_SERVER, ETCD_ENDPOINTS) because local processes can access them via localhost. Only worker nodes need these environment variables to connect to the head node's external IP address.

Applied to files:

  • components/backends/trtllm/kv-cache-tranfer.md
⏰ 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). (4)
  • GitHub Check: Build and Test - vllm
  • GitHub Check: pre-merge-rust (lib/bindings/python)
  • GitHub Check: pre-merge-rust (.)
  • GitHub Check: pre-merge-rust (lib/runtime/examples)
🔇 Additional comments (2)
components/backends/trtllm/kv-cache-tranfer.md (2)

34-35: Clarify architecture support statement

The note currently says NIXL is “only supported on AMD64 (x86_64)”. Please confirm if this is still accurate for tensorrt-llm==1.0.0rc4; recent releases added experimental ARM builds in other components.


48-53: Confirm --trtllm-use-nixl-kvcache-experimental remains required

The build script still defines and requires this flag—no default behavior has been added:

• container/build.sh (lines 167–171): Parses --trtllm-use-nixl-kvcache-experimental and errors if an argument is provided
• container/build.sh (lines 372–373): Lists it in help text as “Enables NIXL KVCACHE experimental support for TensorRT-LLM”

The documentation is up-to-date; both flags are still needed to enable NIXL support.

@tanmayv25
Copy link
Contributor

@KrishnanPrash You should also remove the variable setting from here: https://github.com/ai-dynamo/dynamo/blob/main/container/Dockerfile.tensorrt_llm#L336-L353
and here:
https://github.com/ai-dynamo/dynamo/blob/main/container/Dockerfile.tensorrt_llm#L504-L507

@KrishnanPrash
Copy link
Contributor Author

Here are the other references to the environment variable in the dynamo repo. Do we need to remove/modify these as well?

  1. components/backends/trtllm/multinode/start_trtllm_worker.sh [Link to Code Snippet]
...
# NOTE: When this script is run directly from srun, the environment variables
# for TRTLLM KV cache are not set. So we need to set them here.
# Related issue: https://github.com/ai-dynamo/dynamo/issues/1743
if [[ -z ${TRTLLM_USE_UCX_KVCACHE} ]] && [[ -z ${TRTLLM_USE_NIXL_KVCACHE} ]]; then
    export TRTLLM_USE_UCX_KVCACHE=1
fi
...
  1. container/Dockerfile.trtllm [Link to Code Snippet]
...
# Create a script that sets the environment variables and source it.
# If TRTLLM_USE_NIXL_KVCACHE_EXPERIMENTAL is set to 1, unset TRTLLM_USE_UCX_KVCACHE
# and set TRTLLM_USE_NIXL_KVCACHE to 1.
RUN echo '#!/bin/bash' > /usr/local/bin/set_trtllm_env.sh && \
    if [ "$TRTLLM_USE_NIXL_KVCACHE_EXPERIMENTAL" = "1" ]; then \
        echo 'unset TRTLLM_USE_UCX_KVCACHE' >> /usr/local/bin/set_trtllm_env.sh; \
        echo 'export TRTLLM_USE_NIXL_KVCACHE=1' >> /usr/local/bin/set_trtllm_env.sh; \
    else \
        echo '# TRTLLM_USE_UCX_KVCACHE should already be set to 1' >> /usr/local/bin/set_trtllm_env.sh; \
    fi && \
    chmod +x /usr/local/bin/set_trtllm_env.sh
...

@KrishnanPrash KrishnanPrash merged commit dbb4caa into main Aug 4, 2025
10 checks passed
@KrishnanPrash KrishnanPrash deleted the kprashanth/trtllm_docs branch August 4, 2025 02:44
jain-ria pushed a commit that referenced this pull request Aug 7, 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.

3 participants