Pigsty 开源项目使用教程

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

Pigsty 是一个电池包含的 PostgreSQL 发行版，作为免费的 RDS 替代方案。项目的目录结构如下：

pigsty/
├── README.md
├── LICENSE
├── docs/
├── scripts/
├── conf/
├── src/
├── tests/
├── examples/
└── ...

• README.md: 项目介绍和基本使用说明。
• LICENSE: 项目许可证文件。
• docs/: 包含项目的详细文档。
• scripts/: 包含各种脚本，用于项目的安装、配置和管理。
• conf/: 包含项目的配置文件模板。
• src/: 包含项目的源代码。
• tests/: 包含项目的测试脚本和测试数据。
• examples/: 包含项目的使用示例。

2. 项目的启动文件介绍

Pigsty 的启动文件主要位于 scripts/ 目录下，其中最重要的启动文件是 bootstrap.sh 和 install.yml。

• bootstrap.sh: 用于初始化环境，安装必要的依赖和工具。
• install.yml: 用于根据配置文件安装和配置 Pigsty 的各个模块。

3. 项目的配置文件介绍

Pigsty 的配置文件主要位于 conf/ 目录下，其中最重要的配置文件是 pigsty.yml。

• pigsty.yml: 主配置文件，包含项目的全局配置和各个模块的配置。

配置文件的结构如下：

global:
  # 全局配置
  repo: "https://repo.pigsty.io"
  version: "v2.7.0"

modules:
  # 模块配置
  infra:
    enabled: true
    config:
      # 模块具体配置
  node:
    enabled: true
    config:
      # 模块具体配置
  etcd:
    enabled: true
    config:
      # 模块具体配置
  pgsql:
    enabled: true
    config:
      # 模块具体配置

通过修改 pigsty.yml 文件，可以自定义 Pigsty 的安装和配置。