-
Notifications
You must be signed in to change notification settings - Fork 764
docs: Consolidate documentation and fix redundant headings #2518
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
Merged
Merged
Changes from 1 commit
Commits
Show all changes
8 commits
Select commit
Hold shift + click to select a range
359b4ae
docs: Consolidate documentation and fix redundant headings
athreesh 9f35f5d
docs: Complete comprehensive documentation revamp
athreesh b29caf3
docs: Replace Grove and K8s metrics with fixes-docs versions
athreesh 9715969
Addressing Ryan feedback
athreesh ef17024
addressing lychee / pre-commit errors
athreesh 4fd2d01
addressing lychee / pre-commit errors
athreesh 91d1fce
fixing pre-commit
athreesh f613dea
Merge branch 'main' into docs-consolidation-clean
athreesh File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
Next
Next commit
docs: Consolidate documentation and fix redundant headings
This commit consolidates and improves the documentation structure based on tech writer feedback: **New Documentation:** - Added Grove advanced Kubernetes scheduling guide - Added comprehensive K8s metrics setup guide with Prometheus/Grafana **Heading Fixes:** - Fixed redundant headings that would appear redundant in Sphinx breadcrumbs - Changed "Architecture" → "Design" in SLA planner docs - Changed "Core Components" → "Core Services" to avoid repetition - Removed duplicate H1 headings in component docs **Quick Start Disambiguation:** - "Quick Start" → "SGLang Quick Start" in SGLang README - "Quick Start" → "TensorRT-LLM Quick Start" in TensorRT-LLM README - "Quick Start" → "vLLM Quick Start" in vLLM README - "Quick Start" → "KV Router Quick Start" in router docs - "Quick Start" → "Pre-deployment Steps" in Fluid caching guide **Platform Naming:** - Updated references to use consistent "Dynamo Kubernetes Platform" naming 🤖 Generated with [Claude Code](https://claude.ai/code) Co-Authored-By: Claude <[email protected]>
- Loading branch information
There are no files selected for viewing
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
athreesh marked this conversation as resolved.
Show resolved
Hide resolved
|
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,171 @@ | ||
| # Grove: Advanced Kubernetes Scheduling | ||
|
|
||
| Grove is an advanced Kubernetes scheduler and batch workload manager built on top of the Dynamo Kubernetes Platform. It enables sophisticated scheduling policies for multi-node GPU workloads, with special support for large-scale LLM inference deployments. | ||
|
|
||
| ## Overview | ||
|
|
||
| Grove extends Kubernetes' default scheduling capabilities with: | ||
| - **Gang scheduling**: Ensures all pods in a workload start together or not at all | ||
| - **Topology-aware placement**: Optimizes pod placement based on network topology | ||
| - **Resource-aware scheduling**: Makes intelligent decisions based on GPU memory, compute capacity, and network bandwidth | ||
| - **Priority-based queueing**: Manages workload priorities and preemption policies | ||
|
|
||
| ## Key Features | ||
|
|
||
| ### PodGangSet | ||
| PodGangSet is Grove's primary scheduling primitive that groups related pods that must be scheduled together. | ||
|
|
||
| ```yaml | ||
| apiVersion: grove.dynamo.ai/v1 | ||
| kind: PodGangSet | ||
| metadata: | ||
| name: llm-inference-gang | ||
| namespace: default | ||
| spec: | ||
| template: | ||
| spec: | ||
| containers: | ||
| - name: worker | ||
| image: dynamo/worker:latest | ||
| resources: | ||
| requests: | ||
| nvidia.com/gpu: 1 | ||
| replicas: 8 | ||
| minAvailable: 8 # All pods must be schedulable | ||
| scheduling: | ||
| nodeAffinity: | ||
| requiredDuringSchedulingIgnoredDuringExecution: | ||
| nodeSelectorTerms: | ||
| - matchExpressions: | ||
| - key: node-type | ||
| operator: In | ||
| values: ["gpu-compute"] | ||
| ``` | ||
| ### PodClique | ||
| PodClique provides fine-grained control over pod co-location and anti-affinity rules within a gang. | ||
| ```yaml | ||
| apiVersion: grove.dynamo.ai/v1 | ||
| kind: PodClique | ||
| metadata: | ||
| name: prefill-decode-clique | ||
| spec: | ||
| selector: | ||
| matchLabels: | ||
| app: dynamo-worker | ||
| topology: | ||
| # Prefer pods to be co-located on the same rack | ||
| preferredDuringSchedulingIgnoredDuringExecution: | ||
| - weight: 100 | ||
| podAffinityTerm: | ||
| labelSelector: | ||
| matchLabels: | ||
| component: prefill | ||
| topologyKey: topology.kubernetes.io/rack | ||
| ``` | ||
| ## Deployment | ||
| ### Prerequisites | ||
| - Kubernetes cluster with GPU nodes | ||
| - NVIDIA GPU Operator installed | ||
| - Node topology labels configured | ||
| ### Install Grove Scheduler | ||
| ```bash | ||
| # Install Grove CRDs and scheduler | ||
| kubectl apply -f https://github.com/ai-dynamo/grove/releases/latest/download/grove-crds.yaml | ||
| kubectl apply -f https://github.com/ai-dynamo/grove/releases/latest/download/grove-scheduler.yaml | ||
| ``` | ||
|
|
||
| ### Configure Node Topology | ||
|
|
||
| Label your nodes with topology information: | ||
|
|
||
| ```bash | ||
| # Label nodes with rack information | ||
| kubectl label node gpu-node-01 topology.kubernetes.io/rack=rack-1 | ||
| kubectl label node gpu-node-02 topology.kubernetes.io/rack=rack-1 | ||
| kubectl label node gpu-node-03 topology.kubernetes.io/rack=rack-2 | ||
|
|
||
| # Label nodes with GPU types | ||
| kubectl label node gpu-node-01 accelerator=h100 | ||
| kubectl label node gpu-node-02 accelerator=h100 | ||
| kubectl label node gpu-node-03 accelerator=a100 | ||
| ``` | ||
|
|
||
| ## Integration with Dynamo | ||
|
|
||
| Grove integrates seamlessly with Dynamo's disaggregated serving architecture: | ||
|
|
||
| ### Multi-Node Prefill/Decode Scheduling | ||
|
|
||
| ```yaml | ||
| apiVersion: grove.dynamo.ai/v1 | ||
| kind: PodGangSet | ||
| metadata: | ||
| name: dynamo-multinode-serving | ||
| spec: | ||
| template: | ||
| metadata: | ||
| labels: | ||
| app: dynamo-worker | ||
| spec: | ||
| schedulerName: grove-scheduler | ||
| containers: | ||
| - name: dynamo-worker | ||
| image: nvcr.io/nvidia/ai-dynamo/sglang-runtime:latest | ||
| env: | ||
| - name: WORKER_TYPE | ||
| value: "prefill" # or "decode" | ||
| replicas: 16 | ||
| minAvailable: 16 | ||
| scheduling: | ||
| # Ensure all workers can communicate efficiently | ||
| nodeAffinity: | ||
| requiredDuringSchedulingIgnoredDuringExecution: | ||
| nodeSelectorTerms: | ||
| - matchExpressions: | ||
| - key: network-tier | ||
| operator: In | ||
| values: ["high-bandwidth"] | ||
| ``` | ||
| ## Best Practices | ||
| ### Resource Planning | ||
| - Use `minAvailable: replicas` for strict gang scheduling | ||
| - Set appropriate resource requests and limits | ||
| - Consider network bandwidth requirements for multi-node workloads | ||
|
|
||
| ### Topology Awareness | ||
| - Label nodes with rack, zone, and network topology information | ||
| - Use PodClique for fine-grained placement control | ||
| - Test different affinity rules to optimize for your workload | ||
|
|
||
| ### Monitoring | ||
| Grove provides metrics for scheduling decisions: | ||
|
|
||
| ```bash | ||
| # View Grove scheduler metrics | ||
| kubectl port-forward -n grove-system svc/grove-scheduler-metrics 8080:8080 | ||
| curl localhost:8080/metrics | grep grove_ | ||
| ``` | ||
|
|
||
| ## Troubleshooting | ||
|
|
||
| ### Common Issues | ||
|
|
||
| **Pods stuck in Pending state:** | ||
| - Check if sufficient resources are available across required nodes | ||
| - Verify node labels match gang affinity requirements | ||
| - Review Grove scheduler logs: `kubectl logs -n grove-system deployment/grove-scheduler` | ||
|
|
||
| **Gang scheduling not working:** | ||
| - Ensure `schedulerName: grove-scheduler` is set in pod specs | ||
| - Verify PodGangSet controller is running | ||
| - Check for resource conflicts with other scheduled workloads | ||
|
|
||
| For more detailed troubleshooting, see the [Grove Documentation](https://grove.dynamo.ai/docs). | ||
athreesh marked this conversation as resolved.
Outdated
Show resolved
Hide resolved
|
||
Oops, something went wrong.
Oops, something went wrong.
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Uh oh!
There was an error while loading. Please reload this page.