Skip to content

doc: add doc best-practice/deploy-mooncake-store-with-rbg#391

Open
diw-zw wants to merge 2 commits into
sgl-project:mainfrom
diw-zw:0710-doc-10
Open

doc: add doc best-practice/deploy-mooncake-store-with-rbg#391
diw-zw wants to merge 2 commits into
sgl-project:mainfrom
diw-zw:0710-doc-10

Conversation

@diw-zw

@diw-zw diw-zw commented Jul 10, 2026

Copy link
Copy Markdown
Collaborator

No description provided.

@gemini-code-assist

Copy link
Copy Markdown

Warning

You have reached your daily quota limit. Please wait up to 24 hours and I will start processing your requests again!

@cheyang

cheyang commented Jul 13, 2026

Copy link
Copy Markdown
Collaborator

/copilot review

@cheyang

cheyang commented Jul 13, 2026

Copy link
Copy Markdown
Collaborator

@gemini-code-assist /review

@gemini-code-assist

Copy link
Copy Markdown

Warning

You have reached your daily quota limit. Please wait up to 24 hours and I will start processing your requests again!

@cheyang

cheyang commented Jul 13, 2026

Copy link
Copy Markdown
Collaborator

Review: doc: add doc best-practice/deploy-mooncake-store-with-rbg

Overall this is a well-structured documentation set covering Mooncake Store deployment with RBG. However, the markdown-check CI is currently failing with 16 lint errors that need to be resolved before merge.

Blocking Issues

  1. MD024 (duplicate headings) -- Both guide docs reuse identical heading text ("Expected Behavior", "Verification") across multiple operation sections. Qualify each heading with its parent section context to make them unique.

  2. MD051 (invalid link fragments) -- The "Related Documentation" sections in both concept docs use (#filename.md) syntax instead of (filename.md). The # prefix makes markdownlint interpret these as in-page anchors.

Non-blocking Issues

  1. Broken cross-reference -- The guide docs link to ../10. 通过 RBG 部署 Mooncake Store 实现 KV Cache 复用.md which does not exist. The concept doc lives at ./10-deploy-mooncake-store-with-rbg.md.

  2. Inconsistent replica count -- Guide Operation 1 states "3 replicas x 10 GB = 30 GB" but the YAML has replicas: 1 and MOONCAKE_GLOBAL_SEGMENT_SIZE: "100gb", matching the verification output of 100 GB.

Please fix the CI failures and the broken link, then this should be good to go.


```bash
# Check all Pod statuses
kubectl get pods -l rbg.workloads.x-k8s.io/group-name=mooncake-service -o wide

Copy link
Copy Markdown
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This text says "Total L3 cache capacity = 3 replicas x 10 GB = 30 GB", but the YAML above specifies replicas: 1 and MOONCAKE_GLOBAL_SEGMENT_SIZE: "100gb". The verification output below also confirms a 100 GB pool. Please reconcile this -- either update the YAML to 3 replicas/10gb, or update this text to match the actual 1-replica/100gb configuration.

@@ -0,0 +1,431 @@
# Operations Guide: Deploying Mooncake Store with RBG for KV Cache Reuse

> Corresponding concept document: [10. Deploying Mooncake Store with RBG for KV Cache Reuse](../10.%20通过%20RBG%20部署%20Mooncake%20Store%20实现%20KV%20Cache%20复用.md)

Copy link
Copy Markdown
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This cross-reference links to ../10. 通过 RBG 部署 Mooncake Store 实现 KV Cache 复用.md which does not correspond to any file in the repository. The concept document appears to be at ./10-deploy-mooncake-store-with-rbg.md (same directory). Please update this link. Same issue in the ZH guide.

@cheyang

cheyang commented Jul 13, 2026

Copy link
Copy Markdown
Collaborator

/copilot review

@cheyang

cheyang commented Jul 13, 2026

Copy link
Copy Markdown
Collaborator

@gemini-code-assist /review

@gemini-code-assist

Copy link
Copy Markdown

Warning

You have reached your daily quota limit. Please wait up to 24 hours and I will start processing your requests again!

@@ -0,0 +1,431 @@
# Operations Guide: Deploying Mooncake Store with RBG for KV Cache Reuse

> Corresponding concept document: [10. Deploying Mooncake Store with RBG for KV Cache Reuse](../10.%20通过%20RBG%20部署%20Mooncake%20Store%20实现%20KV%20Cache%20复用.md)

Copy link
Copy Markdown
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

The cross-reference ../10.%20通过%20RBG%20部署%20Mooncake%20Store%20实现%20KV%20Cache%20复用.md does not match the actual concept doc filename 10-deploy-mooncake-store-with-rbg.md. Since both files are in the same en/ directory, this should be ./10-deploy-mooncake-store-with-rbg.md.

- sh
- -c
- "ulimit -l unlimited && python -m mooncake.mooncake_store_service --port 52859"
ports:

Copy link
Copy Markdown
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Item 4 states "Total L3 cache capacity = 3 replicas x 10 GB = 30 GB" but the YAML above deploys replicas: 1 with MOONCAKE_GLOBAL_SEGMENT_SIZE: "100gb". The actual verification output correctly shows 100.00 GB. Consider updating this line to match the actual deployment config.

spec:
containers:
- name: engine
image: lmsysorg/sglang:v0.5.5

Copy link
Copy Markdown
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

The inference service snippet uses lmsysorg/sglang:v0.5.5 while the Mooncake Store YAML and the prerequisites note both reference v0.5.9. Consider aligning to a single version for clarity.

@cheyang

cheyang commented Jul 14, 2026

Copy link
Copy Markdown
Collaborator

Reading this from a user's perspective, several things will trip people up:

Two things that will likely break kubectl apply:

  1. YAML anchors: the manifests use image: &image lmsysorg/sglang:v0.5.9 and image: *image inside a cat <<'EOF' | kubectl apply -f - heredoc. Anchors are resolved by the YAML parser, and the client-side handling in kubectl for streamed heredocs is inconsistent — some versions serialize the resolved value, some pass the raw ref. Safer to inline the image value everywhere so users don't hit a "field required" error.
  2. The Operation 4 port-forward uses 8000:8000, but Operation 3 already set up a port-forward on 8000. A user running the guide top-to-bottom will hit "address already in use".

The Summary table promises operations that don't exist:

The Summary section lists "Benchmark" and "Lossless Update" as operations, but there are no corresponding step-by-step sections in the doc. Users will scroll looking for these and be confused. Either add the operations or remove them from the summary.

Data doesn't match the config:

In the concept doc's "Expected Behavior": "Total L3 cache capacity = 3 replicas × 10 GB = 30 GB". But the actual YAML has replicas: 1 for the store and MOONCAKE_GLOBAL_SEGMENT_SIZE=100gb. The numbers should either match the manifests, or the manifests need to be updated to match the narrative.

Hardware assumption:

All examples assume RDMA (rdma/hca: "1", MOONCAKE_PROTOCOL=rdma, hostNetwork: true, privileged: true). Most users evaluating this will start on a plain TCP cluster. Please add a complete TCP-mode variant (or at least one full working manifest) so users without RDMA infrastructure can try it.

Minor:

  • The reference at the top of the guide points to ../10. 通过 RBG 部署 Mooncake Store 实现 KV Cache 复用.md — Chinese characters and spaces in file paths are fragile across doc renderers. The actual file appears to be 10-deploy-mooncake-store-with-rbg.md.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants