Skip to content

Commit b63322c

Browse files
authored
[Doc] fix 3fs doc link problem (#762)
1 parent d3f2da1 commit b63322c

File tree

4 files changed

+46
-3
lines changed

4 files changed

+46
-3
lines changed

doc/en/mooncake-store-preview.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -469,7 +469,7 @@ After enabling the persistence feature:
469469
- For each `Get` or `BatchGet` operation, if the corresponding kvcache is not found in the memory pool, the system will attempt to read the file data from DFS and return it to the user.
470470

471471
#### 3FS USRBIO Plugin
472-
If you need to use 3FS's native API (USRBIO) to achieve high-performance persistent file reads and writes, you can refer to the configuration instructions in this document [3FS USRBIO Plugin](/mooncake-store/src/hf3fs/READMD.md).
472+
If you need to use 3FS's native API (USRBIO) to achieve high-performance persistent file reads and writes, you can refer to the configuration instructions in this document [3FS USRBIO Plugin](/mooncake-store/src/hf3fs/README.md).
473473

474474
## Mooncake Store Python API
475475

doc/zh/mooncake-store-preview.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -472,7 +472,7 @@ struct ReplicateConfig {
472472
启用持久化功能后,对于每次 `Put``BatchPut` 操作,都会发起一次同步的memory pool写入操作和一次异步的DFS持久化操作。之后执行 `Get``BatchGet` 时,如果在memory pool中没有找到对应的kvcache,则会尝试从DFS中读取该文件数据,并返回给用户。
473473

474474
#### 3FS USRBIO 插件
475-
如需通过3FS原生接口(USRBIO)实现高性能持久化文件读写,请参阅本文档的配置说明。[3FS USRBIO 插件配置](/mooncake-store/src/hf3fs/READMD.md)
475+
如需通过3FS原生接口(USRBIO)实现高性能持久化文件读写,请参阅本文档的配置说明。[3FS USRBIO 插件配置](/mooncake-store/src/hf3fs/README.md)
476476

477477
## Mooncake Store Python API
478478

docs/source/design/mooncake-store-preview.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -469,7 +469,7 @@ After enabling the persistence feature:
469469
- For each `Get` or `BatchGet` operation, if the corresponding kvcache is not found in the memory pool, the system will attempt to read the file data from DFS and return it to the user.
470470

471471
#### 3FS USRBIO Plugin
472-
If you need to use 3FS's native API (USRBIO) to achieve high-performance persistent file reads and writes, you can refer to the configuration instructions in this document [3FS USRBIO Plugin](/mooncake-store/src/hf3fs/READMD.md).
472+
If you need to use 3FS's native API (USRBIO) to achieve high-performance persistent file reads and writes, you can refer to the configuration instructions in this document [3FS USRBIO Plugin](https://kvcache-ai.github.io/Mooncake/plugin-usage/3FS-USRBIO-Plugin.html).
473473

474474
## Mooncake Store Python API
475475

Lines changed: 43 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,43 @@
1+
# Mooncake HF3FS Plugin
2+
3+
This plugin implements 3FS native API (USRBIO) as a high-performance storage backend for Mooncake.
4+
5+
## Prerequisites
6+
7+
### 1. 3FS Installation
8+
- Build and install [3FS](https://github.com/deepseek-ai/3FS/)
9+
- Required library: `libhf3fs_api_shared.so` (Default location: `3FS_PATH/build/src/lib/api`)
10+
→ Install to: `/usr/lib/`
11+
- Required header: `hf3fs_usrbio.h` (Default location: `3FS_PATH/src/lib/api`)
12+
→ Install to: `/usr/include/`
13+
14+
### 2. Mooncake Configuration
15+
- Enable 3FS support during CMake configuration:
16+
```bash
17+
18+
cmake -DUSE_3FS=ON ...
19+
```
20+
21+
- Build and install Mooncake as usual.
22+
23+
## Usage
24+
25+
### Basic Operation
26+
Start master server and specify the 3FS mount point:
27+
```bash
28+
29+
./build/mooncake-store/src/mooncake_master \
30+
--root_fs_dir=/path/to/3fs_mount_point
31+
```
32+
### Important Notes
33+
1. The specified directory **must** be a 3FS mount point
34+
- If not, the system will automatically fall back to POSIX API
35+
2. For optimal performance:
36+
- Ensure proper permissions on the 3FS mount point
37+
- Verify 3FS service is running before execution
38+
39+
### Example
40+
```bash
41+
42+
ROLE=prefill MOONCAKE_STORAGE_ROOT_DIR=/mnt/3fs python3 ./stress_cluster_benchmark.py
43+
```

0 commit comments

Comments
 (0)