[GH-ISSUE #998] [Usage]: How to use NVMeoF Segment in Mooncake #331

New issue

Closed

opened 2026-10-29 21:12:52 +00:00 by bsakaguchi · 4 comments

bsakaguchi commented

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

Owner

Originally created by @tianlang-wq on GitHub (Oct 31, 2025).
Original GitHub issue: https://github.com/kvcache-ai/Mooncake/issues/998

Describe your usage question

Hi,

I noticed that besides the RAM segment type, Mooncake also supports an NVMeoF segment.
Is there any documentation or guide on how to configure and use the NVMeoF segment?

Specifically:

How to enable or register an NVMeoF segment in Mooncake

What configuration parameters are required (e.g., target address, namespace, etc.)

Any example setup or recommended best practices

Thank you!

Before submitting a new issue...

Make sure you already searched for relevant issues and read the documentation

Originally created by @tianlang-wq on GitHub (Oct 31, 2025). Original GitHub issue: https://github.com/kvcache-ai/Mooncake/issues/998 ### Describe your usage question Hi, I noticed that besides the RAM segment type, Mooncake also supports an NVMeoF segment. Is there any documentation or guide on how to configure and use the NVMeoF segment? Specifically: How to enable or register an NVMeoF segment in Mooncake What configuration parameters are required (e.g., target address, namespace, etc.) Any example setup or recommended best practices Thank you! ### Before submitting a new issue... - [ ] Make sure you already searched for relevant issues and read the [documentation](https://kvcache-ai.github.io/Mooncake/)

bsakaguchi closed this issue

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

bsakaguchi commented

2026-10-29 21:12:53 +00:00

Author

Owner

@alogfans commented on GitHub (Nov 3, 2025):

To use NVMe-of segment in Mooncake, the API is the identical to other segments. The only difference is that you should specify the mapped path file://path/to/mapped/file during openSegment.

The current branch has some limitations (e.g., GDS must be installed). You can try out our next generation https://github.com/kvcache-ai/Mooncake/tree/dev/tent for enhancements

@alogfans commented on GitHub (Nov 3, 2025): To use NVMe-of segment in Mooncake, the API is the identical to other segments. The only difference is that you should specify the mapped path `file://path/to/mapped/file` during openSegment. The current branch has some limitations (e.g., GDS must be installed). You can try out our next generation https://github.com/kvcache-ai/Mooncake/tree/dev/tent for enhancements

bsakaguchi commented

2026-10-29 21:12:53 +00:00

Author

Owner

@tianlang-wq commented on GitHub (Nov 3, 2025):

Okay, do you currently have tutorial documents

@tianlang-wq commented on GitHub (Nov 3, 2025): Okay, do you currently have tutorial documents

bsakaguchi commented

2026-10-29 21:12:53 +00:00

Author

Owner

@nickyc975 commented on GitHub (Nov 4, 2025):

Hello, we are working on upstreaming generic NVMeoF transport support to the community. Here is the code: https://github.com/nickyc975/Mooncake/tree/jinlong/nvmeof-upstream

You can refer to the document for usage: English, 中文

Bug reports and improvement suggesstions are welcomed.

@nickyc975 commented on GitHub (Nov 4, 2025): Hello, we are working on upstreaming generic NVMeoF transport support to the community. Here is the code: https://github.com/nickyc975/Mooncake/tree/jinlong/nvmeof-upstream You can refer to the document for usage: [English](https://github.com/nickyc975/Mooncake/blob/jinlong/nvmeof-upstream/doc/en/nvmeof_generic_transport.md), [中文](https://github.com/nickyc975/Mooncake/blob/jinlong/nvmeof-upstream/doc/zh/nvmeof_generic_transport.md) Bug reports and improvement suggesstions are welcomed.

bsakaguchi commented

2026-10-29 21:12:53 +00:00

Author

Owner

@tianlang-wq commented on GitHub (Nov 4, 2025):

Well, thank you very much.

@tianlang-wq commented on GitHub (Nov 4, 2025): Well, thank you very much.

bsakaguchi referenced this issue

2026-10-29 21:27:53 +00:00

[PR #331] [MERGED] Update README figure of components #1489