Repository navigation
[Doc] Document master KV event publisher flags - #3150
Merged
Merged
Conversation
Aionw
marked this pull request as ready for review
July 28, 2026 06:39
Aionw
requested review from
ShangmingCai,
XucSh,
YiXR,
stmatengss and
ykwd
as code owners
July 28, 2026 06:39
|
Codecov Report✅ All modified and coverable lines are covered by tests. 📢 Thoughts on this report? Let us know! |
ykwd
approved these changes
Jul 30, 2026
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
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
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.
Description
Documents the currently shipped
mooncake_masterKV cache event publisher so its build-time requirement and runtime flags no longer drift from the implementation.ENABLE_KV_EVENTS=ON/libzmq3-devprerequisite and a minimal startup example--kv_events_queue_capacityhelp text: the implementation uses it to bound the queue and drops the oldest event when full;0is unboundedRoot 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_idsupport and does not update the current master startup guide, Conductor anchor, ormaster.cppflag help covered here.Module
mooncake-transfer-engine)mooncake-store)mooncake-ep)mooncake-pg)mooncake-integration)mooncake-p2p-store)mooncake-wheel)mooncake-common)mooncake-rl)Type of Change
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.cppTest results:
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
./scripts/code_format.shpre-commit run --all-filesand all hooks passAI Assistance Disclosure
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.