[PR #1416] [MERGED] [docs] add conductor indexer api design doc

No labels

No milestone

No project

No assignees

1 participant

Notifications

Due date

The due date is invalid or out of range. Please use the format "yyyy-mm-dd".

No due date set.

Dependencies

No dependencies set.

Reference

kvcache-ai/Mooncake#2233

bsakaguchi commented

2026-10-29 21:33:52 +00:00

Owner

📋 Pull Request Information

Original PR: https://github.com/kvcache-ai/Mooncake/pull/1416
Author: @yejj710
Created: 1/21/2026
Status: ✅ Merged
Merged: 2/9/2026
Merged by: @stmatengss

Base: main ← Head: api_docs

📝 Commits (10+)

79081ad add indexer api design doc
2b38dc5 remove some api & add explain info for tiered storage
c89d6f3 rename tired storage level name
b2944b3 add overview architecture
f50e9bb define the input of indexer kvevent
894bb27 add example for indexer api output
4fb339e fix some issue from code reviews
9964939 add explain for different medium
5e55938 delete the confusing note
25857f2 add more Introduction for indexer output value

📊 Changes

2 files changed (+224 additions, -0 deletions)

View changed files

➕ docs/source/design/conductor/indexer-api-design.md (+224 -0)
➕ docs/source/image/conductor/architecture.png (+0 -0)

📄 Description

Description

This is the first version of the Mooncake KV indexer design, which includes the service API and the input KV event format for the indexer.related issue

Type of Change

Types
- Bug fix
- New feature
  - Transfer Engine
  - Mooncake Store
  - Mooncake EP
  - Integration
  - P2P Store
  - Python Wheel
- Breaking change
- CI/CD
- Documentation update
- Other

How Has This Been Tested?

Checklist

I have performed a self-review of my own code.
I have formatted my own code using ./scripts/code_format.sh before submitting.
I have updated the documentation.
I have added tests to prove my changes are effective.

_{🔄 This issue represents a GitHub Pull Request. It cannot be merged through Gitea due to API limitations.}

## 📋 Pull Request Information **Original PR:** https://github.com/kvcache-ai/Mooncake/pull/1416 **Author:** [@yejj710](https://github.com/yejj710) **Created:** 1/21/2026 **Status:** ✅ Merged **Merged:** 2/9/2026 **Merged by:** [@stmatengss](https://github.com/stmatengss) **Base:** `main` ← **Head:** `api_docs` --- ### 📝 Commits (10+) - [`79081ad`](https://github.com/kvcache-ai/Mooncake/commit/79081ad80e696cd67f6c4812ff4b3833dc487634) add indexer api design doc - [`2b38dc5`](https://github.com/kvcache-ai/Mooncake/commit/2b38dc5635d6f76f403bdce73949e2397bb191ae) remove some api & add explain info for tiered storage - [`c89d6f3`](https://github.com/kvcache-ai/Mooncake/commit/c89d6f30bd5a5011798a0340d58b4e27c46c95a4) rename tired storage level name - [`b2944b3`](https://github.com/kvcache-ai/Mooncake/commit/b2944b3f39b94be230c9585065f74e12723c5174) add overview architecture - [`f50e9bb`](https://github.com/kvcache-ai/Mooncake/commit/f50e9bb285e453a91967f02fbbe53372fd68d329) define the input of indexer kvevent - [`894bb27`](https://github.com/kvcache-ai/Mooncake/commit/894bb272fa81ea2cffec4a1bea94a0ed9caebada) add example for indexer api output - [`4fb339e`](https://github.com/kvcache-ai/Mooncake/commit/4fb339e61eda8a5a1948cafe611e74304243d553) fix some issue from code reviews - [`9964939`](https://github.com/kvcache-ai/Mooncake/commit/996493928db3d1d7b5b5b99a6109fcae71978040) add explain for different medium - [`5e55938`](https://github.com/kvcache-ai/Mooncake/commit/5e55938bf803d78855aa89ca7c07b31b9abe649b) delete the confusing note - [`25857f2`](https://github.com/kvcache-ai/Mooncake/commit/25857f2ef65c8c2e49978f624c338bf13a23f4e6) add more Introduction for indexer output value ### 📊 Changes **2 files changed** (+224 additions, -0 deletions) <details> <summary>View changed files</summary> ➕ `docs/source/design/conductor/indexer-api-design.md` (+224 -0) ➕ `docs/source/image/conductor/architecture.png` (+0 -0) </details> ### 📄 Description ## Description This is the first version of the Mooncake KV indexer design, which includes the service API and the input KV event format for the indexer.related [issue](https://github.com/kvcache-ai/Mooncake/issues/1403)  ## Type of Change * Types - [ ] Bug fix - [x] New feature - [ ] Transfer Engine - [ ] Mooncake Store - [ ] Mooncake EP - [ ] Integration - [ ] P2P Store - [ ] Python Wheel - [ ] Breaking change - [ ] CI/CD - [x] Documentation update - [ ] Other ## How Has This Been Tested?  ## Checklist - [ ] I have performed a self-review of my own code. - [ ] I have formatted my own code using `./scripts/code_format.sh` before submitting. - [x] I have updated the documentation. - [ ] I have added tests to prove my changes are effective. --- <sub>🔄 This issue represents a GitHub Pull Request. It cannot be merged through Gitea due to API limitations.</sub>

bsakaguchi

closed this issue
added the
pull-request
label

Rows
Columns

[PR #1416] [MERGED] [docs] add conductor indexer api design doc #2233