README_zh.md

简体中文 | English

Riverpass | Documentation

这是一个简易的基于本地磁盘的远端存储的热数据缓存服务。

• 极简的启动和停止缓存服务的命令。
• 无需对远端云存储执行繁琐的配置步骤。
• 缓存项持久化能力: 服务重启时，之前的缓存项能从磁盘重新加载。

系统设计

Detailed design document

Docker镜像

• 下载缓存程序镜像：https://riverpass.oss-cn-shanghai.aliyuncs.com/images/oss.tar.
• 下载数据库配置镜像：https://riverpass.oss-cn-shanghai.aliyuncs.com/images/data.tar
• 加载镜像

docker load -i oss.tar

• 在server文件夹中加载数据库配置

tar -xvf data.tar

如何使用

• 进入 server 文件夹, 运行 ./oss_docker_start.sh 100, '100' 指缓存大小为100MB. 缓存数据默认存放到 /server/localfs_oss/ 文件夹.
• 使用 wget <url> 命令, 替换路径为执行的主机地址和缓存端口。例如: wget http://localhost:10009/getFile?url=https://raw.githubusercontent.com/open-mmlab/mmdeploy/master/resources/mmdeploy-logo.png
• 运行 ./oss_docker_stop.sh 来停止缓存服务. 数据会被保存在盘上.
• 运行 ./oss_docker_restart.sh 来重启缓存服务，数据和元数据会被重新加载到缓存服务。
• 如何编译
  • 进入 server/holder 文件夹, 运行 ./oss_start.sh 来编译Go程序和启动服务来调试。
• 如何贡献改动

依赖项

• MySQL 8.0
• Aliyun OSS SDK

后续开发

• CI和测试覆盖
• 数据库中失效元数据的垃圾回收
• OSS下载优化
• 其他云服务提供商的对象接入
• 缓存替换策略改进

联系我们

• Issue: this link
• Email: [email protected]

License

• Apache 2.0