PureFlash 开源项目启动与配置教程

PureFlash 开源项目启动与配置教程

1. 项目的目录结构及介绍

PureFlash 项目是一个开源的 ServerSAN 存储系统实现。项目目录结构如下：

• .github/: 包含 GitHub Actions 工作流文件。
• common/: 存放通用库和工具。
• docker/: 包含用于 Docker 容器化的相关文件。
• docs/: 项目文档。
• pfs/: PureFlash 存储服务模块。
• pre_build_libs/: 预编译库。
• scripts/: 脚本文件，用于项目的构建和部署。
• sld/: 存储层相关代码。
• testing/: 测试代码和工具。
• thirdParty/: 第三方依赖库。
• .gitignore: Git 忽略文件。
• .gitmodules: Git 子模块配置文件。
• CMakeLists.txt: CMake 构建脚本。
• CODE_OF_CONDUCT.md: 项目行为准则。
• CONTRIBUTING.md: 贡献指南。
• LICENSE: 项目许可证信息。
• MAINTAINERS.md: 项目维护者列表。
• README.md: 项目自述文件。
• README_cn.md: 项目自述文件中文版。
• ROADMAP.md: 项目路线图。
• build_and_run.txt: 构建和运行指南。
• deploy.md: 部署指南。
• docker-based-develope-env.txt: 基于 Docker 的开发环境设置。

2. 项目的启动文件介绍

项目的启动文件主要是 build_and_run.txt，该文件包含了构建和启动 PureFlash 的基本步骤。以下是一个简化的构建过程：

# 克隆依赖的代码库
git clone ...

# 编译依赖的库
cd path/to/dependency
make

# 编译 PureFlash
cd path/to/PureFlash
cmake .
make

启动 PureFlash 的服务通常涉及运行存储服务模块 pfs 和集群控制模块 pfconductor。

3. 项目的配置文件介绍

PureFlash 的配置文件主要位于 common/ 目录下，例如：

• config.json: 通用配置文件，包含网络设置、存储节点信息等。
• pfconductor.conf: 集群控制模块的配置文件，定义了集群的配置参数。
• pfs.conf: 存储服务模块的配置文件，包含了存储服务的相关参数。

配置文件通常是 JSON 或 INI 格式，可以使用文本编辑器进行编辑。下面是一个 config.json 的示例：

{
  "network": {
    "rdma": {
      "enabled": true,
      "port": 12345
    },
    "tcp": {
      "enabled": true,
      "port": 8080
    }
  },
  "storage": {
    "nodes": [
      {
        "host": "node1.example.com",
        "port": 12345,
        "ssd": "/dev/nvme0n1"
      },
      {
        "host": "node2.example.com",
        "port": 12345,
        "ssd": "/dev/nvme0n1"
      }
    ]
  }
}

在配置完文件后，可以根据 build_and_run.txt 中的指南启动相应的服务模块。