Repository navigation
[Doc] Conductor docs refresh - #4824
Merged
Merged
Conversation
The architecture page still described the removed Go implementation, and the HTTP indexer reference predated the Conductor series: it documented a JSON wire format, GPU/CPU/DISK tiers, /query_by_hash, and master-side seq_hash parsing, none of which match the code. - Rewrite the architecture page around the C++ components, the device/cpu_local/cpu_share/disk tiers, hash profiles, gap recovery, configuration, and the CMake build. - Rewrite the HTTP reference for the msgpack routes (/register, /unregister, /query, /global_view, /services), their validation and error format, and how Conductor indexes the Store master stream from object keys. - Document the session_id field on Store stored events. - Fix the Python API link text and note the default RPC port. Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
Chase-Rong
requested review from
ShangmingCai,
UNIDY2002,
alogfans,
staryxchen,
stmatengss and
ykwd
as code owners
October 21, 2026 10:13
ykwd
approved these changes
Oct 23, 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
This PR rewrites both pages from the current implementation and fills smaller
gaps in the related pages. Documentation only, no code changes.
design/conductor/conductor-architecture-design.md(rewritten)EventManager,ConductorService(shared by HTTP and RPC),ZMQClient,KVEventHandler,PrefixCacheTable, and the C++/Python/Rustclients.
(tenant_id, model_name, lora_name, block_size), onehash profile per context, the 200000-entry cap per context, and the
device/cpu_local/cpu_share/disktiers with the medium-to-tiermapping for vLLM, SGLang, and Mooncake events.
vllm_v1,sglang,sglang_bigram) and how block coveragediffers between them.
DEALER, stale sources, and reconnect.http_server_port,rpc_server_port,kvevent_instance),environment variables, the
WITH_CONDUCTORCMake build, and the currentdirectory layout.
api-reference/http/conductor-indexer.md(rewritten)Content-Type: application/msgpack.Requests are validated strictly, and errors use the
{error, reason, field, index}format./registerdocuments the requiredhash_profileand the optionalcache_group. Theadditionalsaltfield, which does not exist, is removed./querydocuments the actual response shape:{"instances": {id: {longest_matched, dp, rank_matches, device, cpu_local, cpu_share, disk}}}. The old doc showed a response keyed by tenant withGPU/CPU/DISKfields.GET /global_viewandGET /services. Removes/query_by_hash,the
lora_id/block_hashaliases, and the XXH3 hashing section, none ofwhich are implemented.
object keys into
seq_hashes, and it does emitmodel_name/block_size/lora_name/dp_rankfrom its flags. The section nowexplains how Conductor derives block identity from
object_keyunder eachhash profile, and the steps to index a master stream. The
(mooncake-store-master-publisher)=anchor is kept because the Storedeployment guide links to it.
Module
mooncake-transfer-engine)mooncake-store)mooncake-conductor)mooncake-reshard)mooncake-ep)mooncake-pg)mooncake-integration)mooncake-p2p-store)mooncake-wheel)mooncake-common)mooncake-rl)Type of Change
How Has This Been Tested?
Built the docs locally and checked the rendered conductor pages, the mermaid
diagram, and the
mooncake-store-master-publisheranchor. The build producedno new warnings; the only warnings were intersphinx inventory fetch failures
caused by the local network. Ran pre-commit on the changed files.
Test commands:
Test results:
Every documented field name, default, route, and error code was checked against
mooncake-conductor/src (event_manager.cpp, config.cpp, main.cpp,
event_handler.cpp, zmq_client.cpp, hash_strategy.cpp) and
mooncake-store/src/kv_event/kv_event_publisher.cpp.
Checklist
AI Assistance Disclosure