Skip to content

[Doc] Document master KV event publisher flags - #3150

Merged
ykwd merged 3 commits into
kvcache-ai:mainfrom
Aionw:codex/fix-doc-drift
Jul 30, 2026
Merged

ykwd merged 3 commits into
kvcache-ai:mainfrom
Aionw:codex/fix-doc-drift

Conversation

@Aionw

@Aionw Aionw commented Jul 28, 2026 •

Copy link
Copy Markdown
Collaborator

Description

Documents the currently shipped mooncake_master KV cache event publisher so its build-time requirement and runtime flags no longer drift from the implementation.

  • adds the ENABLE_KV_EVENTS=ON / libzmq3-dev prerequisite and a minimal startup example
  • documents required, compatibility, object-key, and queue-capacity flags
  • explains which legacy identity flags are retained but no longer emitted
  • adds a stable cross-reference to the existing Conductor publisher contract
  • corrects the --kv_events_queue_capacity help text: the implementation uses it to bound the queue and drops the oldest event when full; 0 is unbounded

Root cause: the publisher landed with API/design documentation, but the deployment guide's master flag reference was not updated. The queue implementation and its gflag help also diverged.

This does not duplicate #2663. That PR proposes a separate logical-block/group publisher with worker_id support and does not update the current master startup guide, Conductor anchor, or master.cpp flag help covered here.

Module

  • Transfer Engine (mooncake-transfer-engine)
  • Mooncake Store (mooncake-store)
  • Mooncake EP (mooncake-ep)
  • Mooncake PG (mooncake-pg)
  • Integration (mooncake-integration)
  • P2P Store (mooncake-p2p-store)
  • Python Wheel (mooncake-wheel)
  • Common (mooncake-common)
  • Mooncake RL (mooncake-rl)
  • CI/CD
  • Docs
  • Other

Type of Change

  • Bug fix
  • New feature
  • Refactor
  • Breaking change
  • Documentation update
  • Performance improvement
  • Other

How Has This Been Tested?

Test commands:

cd docs
make html SPHINXBUILD=.venv/bin/sphinx-build

pre-commit run --files \
  docs/source/api-reference/http/conductor-indexer.md \
  docs/source/deployment/mooncake-store-deployment-guide.md \
  mooncake-store/src/master.cpp

Test results:

  • Unit tests pass
  • Integration tests pass (not applicable)
  • Manual testing done: inspected generated HTML and verified the deployment-guide link resolves to the Conductor publisher section

The Sphinx build succeeds. It reports seven environment-only warnings because the local proxy returns HTTP 403 for external intersphinx inventories; there are no local document or cross-reference warnings.

Checklist

  • I have performed a self-review of my own code
  • I have formatted my code using ./scripts/code_format.sh
  • I have run pre-commit run --all-files and all hooks pass
  • I have updated the documentation (if applicable)
  • I have added tests to prove my changes are effective
  • For changes >500 LOC: I have filed an RFC issue

AI Assistance Disclosure

  • No AI tools were used
  • AI tools were used (specify below)

OpenAI Codex audited the implementation and documentation for drift, authored the documentation/help-text update, checked related open work, and ran the validation commands above. The human submitter should review every changed line before marking this draft ready for review.

@github-actions github-actions Bot added documentation Improvements or additions to documentation run-ci Store labels Jul 28, 2026
@Aionw
Aionw marked this pull request as ready for review July 28, 2026 06:39
@codecov-commenter

Copy link
Copy Markdown

⚠️ Please install the 'codecov app svg image' to ensure uploads and comments are reliably processed by Codecov.

Codecov Report

✅ All modified and coverable lines are covered by tests.

📢 Thoughts on this report? Let us know!

@Icedcoco Icedcoco left a comment

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.

LGTM.

@ykwd
ykwd merged commit 04791cd into kvcache-ai:main Jul 30, 2026
26 checks passed
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 run-ci Store

Projects

None yet

Development

Successfully merging this pull request may close these issues.

4 participants