Skip to content

docs(k8s): clarify Dynamo/Grove/KAI ownership and deployment modes#6888

Draft
athreesh wants to merge 2 commits intomainfrom
docs/grove-admin-flow-clarity
Draft

docs(k8s): clarify Dynamo/Grove/KAI ownership and deployment modes#6888
athreesh wants to merge 2 commits intomainfrom
docs/grove-admin-flow-clarity

Conversation

@athreesh
Copy link
Contributor

@athreesh athreesh commented Mar 4, 2026

Summary

  • Clarify the responsibility split in the Kubernetes installation guide between cluster admin, Dynamo operator, and app user.
  • Add a single deployment mode matrix for Grove/KAI showing:
    • bundled dev/POC
    • external production prerequisites
    • forced LWS path.
  • Document common misconfigurations (e.g., missing Grove API, no orchestrator for multinode, missing KAI queue).
  • Update the multinode guide to reference the responsibility split and spell out that app users author DGD, while operators create Grove resources.
  • Adjust Grove docs to say KAI is recommended, not strictly required.

Why

This makes the ownership and deployment contract explicit and removes ambiguity about when Grove and KAI are installed by Dynamo versus pre-provisioned by cluster administrators.

Summary by CodeRabbit

  • Documentation
    • Clarified that Grove can operate independently of KAI Scheduler, with KAI Scheduler recommended for advanced features at scale.
    • Added responsibility matrix documentation detailing roles for cluster admins, application users, and operators.
    • Enhanced deployment guidance with clarifications on orchestrator selection and installation paths.

@copy-pr-bot
Copy link

copy-pr-bot bot commented Mar 4, 2026

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.

@github-actions github-actions bot added docs documentation Improvements or additions to documentation labels Mar 4, 2026
@coderabbitai
Copy link
Contributor

coderabbitai bot commented Mar 4, 2026

Walkthrough

Documentation enhancements across three Kubernetes deployment guides clarifying responsibility splits between cluster admins, users, and operators; updating Grove/KAI Scheduler dependency requirements; and adding detailed role definitions for Dynamo deployments. No code logic modifications.

Changes

Cohort / File(s) Summary
Kubernetes Documentation Updates
docs/kubernetes/deployment/multinode-deployment.md, docs/kubernetes/grove.md, docs/kubernetes/installation-guide.md
Added clarifications on responsibility splits between cluster admins, application users, and operators. Updated Grove documentation to indicate KAI Scheduler is optional (recommended for advanced features, not required). Added new "Responsibility Split" section detailing ownership roles, deployment modes, and common misconfiguration scenarios.

Estimated code review effort

🎯 1 (Trivial) | ⏱️ ~5 minutes

Poem

🐰 A rabbit hops through docs with glee,
Clarifying who owns what, you see!
Admins and users, each with their part,
Grove runs solo—what a smart start!
No code was changed, just wisdom to share, 🌿

🚥 Pre-merge checks | ✅ 3
✅ Passed checks (3 passed)
Check name Status Explanation
Title check ✅ Passed The title accurately summarizes the main changes: clarifying Dynamo/Grove/KAI ownership and deployment modes across Kubernetes documentation.
Docstring Coverage ✅ Passed No functions found in the changed files to evaluate docstring coverage. Skipping docstring coverage check.
Description check ✅ Passed The pull request description provides a clear summary of changes, detailed rationale, and aligns well with the template structure covering overview and purpose.

✏️ Tip: You can configure your own custom pre-merge checks in the settings.

Tip

Try Coding Plans. Let us write the prompt for your AI agent so you can ship faster (with fewer bugs).
Share your feedback on Discord.


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

Comment @coderabbitai help to get the list of available commands and usage tips.

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.

Caution

Some comments are outside the diff and can’t be posted inline due to platform limitations.

⚠️ Outside diff range comments (1)
docs/kubernetes/grove.md (1)

94-104: ⚠️ Potential issue | 🟡 Minor

Use the canonical Grove repository links in this section.

In the same changed section (Line 98 and Line 102), Grove links still point to github.com/NVIDIA/grove. Please switch them to https://github.com/ai-dynamo/grove to avoid directing users to a non-canonical source.

Suggested doc fix
-For installation instructions, see the [Grove Installation Guide](https://github.com/NVIDIA/grove/blob/main/docs/installation.md).
+For installation instructions, see the [Grove Installation Guide](https://github.com/ai-dynamo/grove/blob/main/docs/installation.md).

-For the latest updates on Grove, refer to the [official project on GitHub](https://github.com/NVIDIA/grove).
+For the latest updates on Grove, refer to the [official project on GitHub](https://github.com/ai-dynamo/grove).

Based on learnings: The canonical Grove repository URL is https://github.com/ai-dynamo/grove, not https://github.com/NVIDIA/grove.

🤖 Prompt for AI Agents
Verify each finding against the current code and only fix it if needed.

In `@docs/kubernetes/grove.md` around lines 94 - 104, Replace the non-canonical
Grove repository URLs in the markdown section: update any occurrences of
"https://github.com/NVIDIA/grove" (seen in the link targets in the lines
referencing the Grove Installation Guide and the "official project on GitHub")
to the canonical "https://github.com/ai-dynamo/grove"; ensure both link targets
are changed so the Installation Guide and project link point to ai-dynamo/grove.
🤖 Prompt for all review comments with AI agents
Verify each finding against the current code and only fix it if needed.

Outside diff comments:
In `@docs/kubernetes/grove.md`:
- Around line 94-104: Replace the non-canonical Grove repository URLs in the
markdown section: update any occurrences of "https://github.com/NVIDIA/grove"
(seen in the link targets in the lines referencing the Grove Installation Guide
and the "official project on GitHub") to the canonical
"https://github.com/ai-dynamo/grove"; ensure both link targets are changed so
the Installation Guide and project link point to ai-dynamo/grove.

ℹ️ Review info
⚙️ Run configuration

Configuration used: Path: .coderabbit.yaml

Review profile: CHILL

Plan: Pro

Run ID: 384b403e-5b16-4451-81d7-1738e5f99761

📥 Commits

Reviewing files that changed from the base of the PR and between 19e8a16 and 072ed6c.

📒 Files selected for processing (3)
  • docs/kubernetes/deployment/multinode-deployment.md
  • docs/kubernetes/grove.md
  • docs/kubernetes/installation-guide.md

@athreesh athreesh marked this pull request as draft March 4, 2026 20:06
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

docs documentation Improvements or additions to documentation size/M

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant