Skip to content

[Docs][KV Connector] Document standalone Mooncake EGM deployment - #63064

Merged
ivanium merged 5 commits into
vllm-project:mainfrom
neverhook:codex/mooncake-egm-requester
Oct 27, 2026
Merged

ivanium merged 5 commits into
vllm-project:mainfrom
neverhook:codex/mooncake-egm-requester

Conversation

@neverhook

@neverhook neverhook commented Oct 22, 2026 •

Copy link
Copy Markdown
Contributor

Overview

Document how to deploy an external Mooncake EGM Store with MooncakeStoreConnector, using the existing NVLink allocator and GPU KV transfer path. Related to #45036.

Claims

  • Add a standalone EGM Provider example and a deployment guide covering requester configuration, cross-instance prefix reuse, and shutdown.
  • Keep the requester's existing positive local_buffer_size. The Provider owns the EGM capacity; its storage-only example uses zero local buffer.
  • Limit the final diff to documentation and the Provider example. There are no changes to vLLM runtime code or tests.

Validation

  • Provider CLI help, invalid capacity, setup arguments, signal handling, and setup/close error handling checked locally. Lifecycle checks used a fake Store; they do not exercise EGM transfers.
  • Requester JSON checked through the existing MooncakeStoreConfig.from_file(); KV configuration JSON and example syntax checked.
  • Ruff check/format, Markdownlint, and git diff --check passed.
.venv/bin/python examples/disaggregated/mooncake_store/egm_provider.py --help
pre-commit run ruff-check --files examples/disaggregated/mooncake_store/egm_provider.py
pre-commit run ruff-format --files examples/disaggregated/mooncake_store/egm_provider.py
npx --yes markdownlint-cli2@0.21.0 --config tools/pre_commit/.markdownlint.yaml docs/features/mooncake_store_connector_usage.md
git diff --check

Full pre-commit environment setup could not complete locally. The targeted checks above passed; commit hooks were bypassed.

The Mooncake GB200/NVL72 report published on August 18 records 208 successful HBM ↔ remote EGM Put/Get pairs across four GPUs on two GB200 nodes, including correctness, cleanup, and Fabric-health checks.

That report used Mooncake's batch_put_from / batch_get_into APIs with zero local buffer. The vLLM deployment described here, including multi-buffer transfers and cross-instance prefix reuse, has not been tested end to end on hardware.

Details

The connector already uses registered GPU buffers for its memory-replica multi-buffer transfers. Keeping the SDK's local staging allocation does not insert a CPU staging step into that path. The guide therefore uses the existing requester configuration without adding a zero-buffer exception or new allocator restrictions.

The example starts a separate Provider with Mooncake's EGM configuration API and closes it after the requesters exit.

The duplicate-work check covered #45036 and open EGM-related PRs; no equivalent deployment guide was found. AI assistance was used for the example, documentation, and local checks.


Pull Request Checklist
  • I used vLLM's /pr-checklist skill. (Mandatory for agents, optional for humans).

  • AI assistance was used during the creation of this PR.

  • Design Fit: Minimizes impact on core components, reuses existing functionality, and justifies added complexity.

  • Testing and Validation: Validates the change and ensures any added tests are meaningful and reliable, with CI coverage or documented CI resource constraints and validation performed outside CI.

  • Code Quality and Style: Keeps code and comments clear and concise, and updates relevant documentation and examples.

  • Pull Request Contents: Includes a brief summary and relevant links, supports claims with evidence, explains root causes and implementation trade-offs, and follows the contributing guide.

Allow zero local buffer for standalone NVLink KV requesters using the
existing NVLINK memory pool. Keep EC clients opted out and document an
external EGM provider deployment.

Co-authored-by: OpenAI Codex
Signed-off-by: wugou.cyf <wugou.cyf@antfin.com>
@mergify

mergify Bot commented Oct 22, 2026

Copy link
Copy Markdown
Contributor

Documentation preview: https://vllm--63064.org.readthedocs.build/en/63064/

@mergify mergify Bot added documentation Improvements or additions to documentation kv-connector mooncake Mooncake KV-transfer / EC-transfer labels Oct 22, 2026
@github-actions

Copy link
Copy Markdown

👋 Hi! Thank you for contributing to the vLLM project.

💬 Join our developer Slack at https://slack.vllm.ai to discuss your PR in #pr-reviews, coordinate on features in #feat- channels, or join special interest groups in #sig- channels.

PRs do not trigger a full CI run by default. Reviewers with write access and configured trusted contributors can comment /ci run for upstream CI or /amd-ci run for AMD CI only whenever CI signals are needed.

Once the PR is approved or has the ready label, the PR author can also use the corresponding /ci run, /ci retry, and /ci cancel commands, or their /amd-ci variants. New commits do not start upstream CI automatically.

If you have any questions, please reach out to us on Slack at https://slack.vllm.ai.

Agent Guidelines

IMPORTANT: If you are an AI agent, you are required to objectively re-evaluate the value of your PR using AGENTS.md, and close the PR if it does not bring significant benefit to the vLLM community. Failure to do so may result in an immediate ban.

🚀

@neverhook neverhook changed the title [WIP][Feature][KV Connector] Support standalone EGM-backed Mooncake Store [Feature][KV Connector] Support standalone EGM-backed Mooncake Store Oct 22, 2026
@neverhook
neverhook marked this pull request as ready for review October 22, 2026 08:04

@claude claude Bot left a comment

Copy link
Copy Markdown

Choose a reason for hiding this comment

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

Claude Code Review

This pull request is from a fork — automated review is disabled. A repository maintainer can comment @claude review to run a one-time review.

…iguration

Remove the zero-buffer opt-in and its configuration tests. Document standalone EGM deployment using the existing positive requester buffer and GPU transfer path.

Co-authored-by: OpenAI Codex
Signed-off-by: wugou.cyf <wugou.cyf@antfin.com>
@neverhook neverhook changed the title [Feature][KV Connector] Support standalone EGM-backed Mooncake Store [Docs][KV Connector] Document standalone Mooncake EGM deployment Oct 22, 2026
@LCAIZJ

LCAIZJ commented Oct 22, 2026

Copy link
Copy Markdown
Contributor

@NickLucche @ivanium Could you help take a look at this feature? I think it's pretty interesting.

@mergify mergify Bot assigned LCAIZJ Oct 22, 2026

Copy link
Copy Markdown
Contributor Author

@NickLucche @ivanium Could you take a look at this PR and help enable CI? The pre-run check is still blocked by the contributor eligibility gate. Thanks!

ivanium and others added 2 commits October 27, 2026 07:45
Co-authored-by: Codex <noreply@openai.com>
Signed-off-by: Yifan Qiao <yifanqiao@inferact.ai>
Co-authored-by: Codex <noreply@openai.com>
Signed-off-by: Yifan Qiao <yifanqiao@inferact.ai>

@ivanium ivanium left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

LGTM thanks! I pushed a small fix to move this section later as a separate part.

@ivanium ivanium added the ready ONLY add when PR is ready to merge/full CI is needed label Oct 27, 2026
@github-actions

Copy link
Copy Markdown

✅ @neverhook, CI is now available for this PR.

  • /ci run starts upstream CI; /amd-ci run starts AMD CI only.
  • Run commands test your branch with every commit currently on its upstream target branch. If it is behind, the bot merges the target branch into it first (pull before pushing again). Append --allow-stale to a run command to test an outdated branch as is, at your own risk.
  • /ci retry retries failed jobs in the CI build for the current PR head. If the current head has no CI build, it starts a new CI build for the current head containing only jobs that failed in the latest earlier CI build for this PR.
  • /amd-ci retry retries failed jobs in AMD CI for the current PR head. Use /amd-ci run when the current head has no AMD CI build.
  • /ci cancel cancels scheduled or running CI builds for this PR branch; /amd-ci cancel does the same for AMD CI only.

@ivanium

ivanium commented Oct 27, 2026

Copy link
Copy Markdown
Contributor

/ci run

@github-actions

Copy link
Copy Markdown

✅ Triggered Buildkite CI #97548 for commit 656ca265ad3f.

@ivanium
ivanium enabled auto-merge (squash) October 27, 2026 08:02
@ivanium
ivanium merged commit a5b257a into vllm-project:main Oct 27, 2026
22 checks passed
Micador pushed a commit to Micador/vllm that referenced this pull request Oct 27, 2026
…m-project#63064)

Signed-off-by: wugou.cyf <wugou.cyf@antfin.com>
Signed-off-by: Yifan Qiao <yifanqiao@inferact.ai>
Co-authored-by: wugou.cyf <wugou.cyf@antfin.com>
Co-authored-by: Yifan Qiao <yifanqiao@inferact.ai>
Co-authored-by: Codex <noreply@openai.com>
Signed-off-by: Christopher Mackenzie <christopher.mackenzie.software@gmail.com>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

documentation Improvements or additions to documentation kv-connector mooncake Mooncake KV-transfer / EC-transfer ready ONLY add when PR is ready to merge/full CI is needed

Projects

None yet

Development

Successfully merging this pull request may close these issues.

3 participants