docs: Create a guide for writing dynamo deployments CR #1999
Conversation
WalkthroughA new documentation guide, Changes
Sequence Diagram(s)sequenceDiagram
User->>Guide: Reads deployment guide
Guide->>User: Explains architecture patterns
User->>Guide: Selects deployment template
Guide->>User: Shows customization options (YAML, commands, resources)
User->>Kubernetes: Applies customized deployment YAML
Kubernetes->>Dynamo: Deploys model serving components
Possibly related PRs
Poem
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. 🪧 TipsChatThere are 3 ways to chat with CodeRabbit:
SupportNeed 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)
Other keywords and placeholders
Documentation and Community
|
![coderabbitai[bot]](https://avatars.githubusercontent.com/in/347564?s=60&v=4){kind=small}
There was a problem hiding this comment.
Actionable comments posted: 0
🧹 Nitpick comments (4)
docs/guides/dynamo_deploy/create_deployment.md (4)
3-4: Capitalize “Kubernetes” and “YAML” for consistencyThroughout the project documentation we capitalize proper nouns and abbreviations.
- The corresponding yaml files ... create a kubernetes deployment + The corresponding YAML files ... create a Kubernetes deployment
28-36: Minor grammar tweak & pluralize “roles”The sentence reads more naturally in the present tense, and the list that follows describes multiple roles.
-The Frontend serves as a framework-agnostic HTTP entry point and is likely not to need many changes. -It serves the following role: +The Frontend is a framework-agnostic HTTP entry point and usually needs few changes. +It serves the following roles:
31-46: Indent sub-bullets so Markdown renders them as part of the numbered listWithout indentation, Markdown engines will render each line as a new top-level list item rather than details of item 1/2/3.
Example fix for block starting at line 31:
-1. OpenAI-Compatible HTTP Server -Provides `/v1/chat/completions` endpoint -Handles HTTP request/response formatting +1. OpenAI-Compatible HTTP Server + • Provides `/v1/chat/completions` endpoint + • Handles HTTP request/response formatting(Repeat for the other two sections.)
88-90: Fix stray back-tick and unify command spelling (dynamo-run)-Each worker will launch `dynamo-run in=dyn//name out=sglang <model>`command +Each worker launches `dynamo-run in=dyn//name out=sglang <model>` commandAlso ensure the earlier example uses the same
dynamo-runspelling for consistency.
📜 Review details
Configuration used: .coderabbit.yaml
Review profile: CHILL
Plan: Pro
📒 Files selected for processing (1)
docs/guides/dynamo_deploy/create_deployment.md(1 hunks)
🔇 Additional comments (1)
docs/guides/dynamo_deploy/create_deployment.md (1)
65-83: GPU resource key is not standard Kubernetes; clarify or correct
gpu: "1"will not be scheduled by vanilla Kubernetes. Most clusters expose GPUs undernvidia.com/gpu(or another vendor-specific resource name). Ifgpuis a Dynamo-specific abstraction, mention it explicitly; otherwise consider:- gpu: "1" + nvidia.com/gpu: "1" # adjust to your cluster’s GPU resource name
rmccorm4
changed the title
atchernych
force-pushed
the
DYN-722-yaml-readme
branch
from
5806d90 to
9ce4d76
Compare
atchernych
requested review from
a team,
PeaBrane,
ishandhanani,
jthomson04 and
kkranen
as code owners
atchernych
force-pushed
the
DYN-722-yaml-readme
branch
from
c9ec443 to
412d2f7
Compare
Overview:
Create a guide for writing dynamo deployments CR
Details:
Where should the reviewer start?
Related Issues: (use one of the action keywords Closes / Fixes / Resolves / Relates to)
Summary by CodeRabbit