跳转到主要内容

剧本列表

Pigsty v4.x 预置 Ansible 剧本导航与执行要点

本文汇总 Pigsty v4.x 各模块剧本入口与执行要点,详细任务标签请进入对应模块 playbook 文档。

模块剧本导航

模块数量剧本
INFRA3deploy.yml infra.yml infra-rm.yml
NODE2node.yml node-rm.yml
ETCD2etcd.yml etcd-rm.yml
VAULT2vault.yml vault-rm.yml
PGSQL7pgsql.yml pgsql-rm.yml
pgsql-user.yml pgsql-db.yml
pgsql-monitor.yml pgsql-migration.yml pgsql-pitr.yml
REDIS2redis.yml redis-rm.yml
MINIO2minio.yml minio-rm.yml
DOCKER1docker.yml
JUICE1juice.yml
VIBE1vibe.yml
KAFKA2kafka.yml kafka-rm.yml
MYSQL2mysql.yml mysql-rm.yml

剧本总表

剧本模块主要用途
deploy.ymlINFRA一次性串联部署核心链路(infra -> node -> etcd -> vault -> minio -> pgsql)
infra.ymlINFRA初始化基础设施节点
infra-rm.ymlINFRA移除基础设施组件
node.ymlNODE节点纳管与基线配置
node-rm.ymlNODE节点去纳管
etcd.ymlETCDETCD 安装/扩容
etcd-rm.ymlETCDETCD 移除/缩容
vault.ymlVAULT初始化或收敛 OpenBao 密钥管理集群
vault-rm.ymlVAULT移除 OpenBao 密钥管理集群或退役单个成员
pgsql.ymlPGSQL初始化 PostgreSQL 集群或新增实例
pgsql-rm.ymlPGSQL移除 PostgreSQL 集群/实例
pgsql-user.ymlPGSQL增加业务用户
pgsql-db.ymlPGSQL增加业务数据库
pgsql-monitor.ymlPGSQL纳管远程 PostgreSQL 监控
pgsql-migration.ymlPGSQL生成迁移手册与脚本
pgsql-pitr.ymlPGSQL时间点恢复(PITR)
redis.ymlREDISRedis 部署
redis-rm.ymlREDISRedis 移除
minio.ymlMINIOSilo 部署
minio-rm.ymlMINIO移除 Silo、配置与可选数据
docker.ymlDOCKERDocker 引擎部署
juice.ymlJUICEJuiceFS 实例部署/移除
vibe.ymlVIBEVIBE 开发环境部署
kafka.ymlKAFKA创建或收敛完整的 dynamic KRaft 集群
kafka-rm.ymlKAFKA移除 Kafka 集群,或安全退役单个成员
mysql.ymlMYSQL收敛原生 MySQL 8.4 单节点或三节点 InnoDB Cluster
mysql-rm.ymlMYSQL移除原生 MySQL 集群或摘除单个成员(默认删除数据与配置,保留备份目录)

辅助剧本

以下剧本不归属于特定模块,提供一些辅助功能。

剧本说明
cache.yml构建离线安装包缓存
cert.yml使用 Pigsty CA 签发证书
app.yml使用 Docker Compose 安装应用模板
slim.yml最小化组件安装场景

剧本使用注意事项

保护机制

多个模块提供了防误删保险,通过 *_safeguard 参数控制:

  • PGSQL: pg_safeguard 参数用于防止误删 PostgreSQL 集群(默认 false)
  • ETCD: etcd_safeguard 参数用于防止误删 Etcd 集群(默认 false)
  • VAULT: vault_safeguard 参数用于防止误删 OpenBao 密钥管理集群(默认 true)
  • MINIO: minio_safeguard 参数用于防止误删 Silo 集群(默认 false)
  • REDIS: redis_safeguard 参数用于防止误删 Redis 实例(默认 false)
  • KAFKA: kafka_safeguard 参数用于阻止 Kafka 移除剧本(默认 false)
  • MYSQL: mysql_safeguard 参数用于防止误删原生 MySQL 实例或集群(默认 true)

PGSQL、ETCD、MINIO、REDIS 与 KAFKA 的角色默认值均为 false,生产环境建议在已初始化的集群上显式设为 true;而 VAULT 与 MYSQL 的 vault_safeguard、mysql_safeguard 默认即为 true,防止意外销毁加密主密钥或 MySQL 数据。此外,mysql-rm.yml 默认开启 mysql_rm_data: true(销毁 /data/mysql 数据目录、配置与 Router 状态,但保留备份目录 mysql_backup_dir);仅整集群或单机移除时支持追加 -e mysql_rm_data=false 执行停服保数据。

当保护开关为 true 时,对应的 *-rm.yml 剧本会立即中止执行。确认风险与备份后,可通过命令行参数覆盖:

./pgsql-rm.yml -l pg-test -e pg_safeguard=false
./etcd-rm.yml  -l etcd -e etcd_safeguard=false
./vault-rm.yml -l vault -e vault_safeguard=false
./minio-rm.yml -l minio -e minio_type=silo -e minio_safeguard=false
./redis-rm.yml -l redis-test -e redis_safeguard=false
./kafka-rm.yml -l kf-main -e kafka_safeguard=false
./mysql-rm.yml -l my-test -e mysql_safeguard=false

限制执行范围

执行剧本时建议使用 -l 参数限制命令执行的对象范围:

./pgsql.yml -l pg-meta            # 限制在集群 pg-meta 上执行
./node.yml -l 10.10.10.10         # 限制在特定节点上执行
./redis.yml -l redis-test         # 限制在 redis-test 集群上执行

在大规模部署上批量执行时,建议先在单集群灰度验证,再分批执行到全局。

幂等性

大部分剧本都是幂等的,可以重复执行。但需要注意:

  • infra.yml 默认 不会 清除数据,可安全重复执行。所有 clean 参数(vmetrics_clean、vlogs_clean、vtraces_clean、grafana_clean、nginx_clean)默认均为 false
  • 如需清除基础设施数据重建,需显式设置对应的 clean 参数为 true
  • 重复执行 *-rm.yml 删除剧本需格外小心,确保在正确的目标上执行

任务标签

可以使用 -t 参数只执行特定的任务子集:

./pgsql.yml -l pg-test -t pg_service    # 只刷新集群 pg-test 的服务
./node.yml -t haproxy                   # 只在节点上设置 haproxy
./etcd.yml -t etcd_launch               # 只重启 etcd 服务

常用命令速查

INFRA 模块

./deploy.yml                     # 一次性部署核心链路
./infra.yml                      # 初始化基础设施
./infra-rm.yml                   # 移除基础设施
./cache.yml -l <infra-host>      # 从指定 Infra 节点的现有仓库创建离线安装包
./cert.yml -e cn=<name>          # 签发客户端证书

NODE 模块

./node.yml -l <cls|ip>           # 添加节点
./node-rm.yml -l <cls|ip>        # 移除节点
bin/node-add <cls|ip>            # 添加节点 (包装脚本)
bin/node-rm <cls|ip>             # 移除节点 (包装脚本)

ETCD 模块

./etcd.yml                       # 初始化 etcd 集群
./etcd-rm.yml -l etcd            # 默认删除该集群的本机数据与配置
bin/etcd-add <ip>                # 添加 etcd 成员 (包装脚本)
bin/etcd-rm <ip>                 # 移除 etcd 成员 (包装脚本)

VAULT 模块

./vault.yml -l vault                           # 初始化或收敛 OpenBao 密钥集群
./vault-rm.yml -l vault -e vault_safeguard=false   # 移除整套集群(先保存最终快照至控制机)
./vault-rm.yml -l <ip> -e vault_safeguard=false    # 从集群安全摘除单个成员
bin/vault-add                                  # 初始化或收敛集群 (包装脚本)
bin/vault-add <ip>                             # 扩容添加新成员并刷新集群配置 (包装脚本)
bin/vault-rm                                   # 移除整套集群 (包装脚本)
bin/vault-rm <ip>                              # 退役单个成员 (包装脚本)

PGSQL 模块

./pgsql.yml -l <cls>             # 初始化 PostgreSQL 集群
./pgsql-rm.yml -l <cls>          # 移除 PostgreSQL 集群
./pgsql-user.yml -l <cls> -e username=<user>   # 创建业务用户
./pgsql-db.yml -l <cls> -e dbname=<db>         # 创建业务数据库
./pgsql-monitor.yml -e clsname=<cls>           # 监控远程集群
./pgsql-migration.yml -e@files/migration/<cls>.yml  # 生成迁移手册
./pgsql-pitr.yml -l <cls> -e '{"pg_pitr": {}}'      # 执行 PITR 恢复

bin/pgsql-add <cls>              # 初始化集群 (包装脚本)
bin/pgsql-rm <cls>               # 移除集群 (包装脚本)
bin/pgsql-user <cls> <user>      # 创建用户 (包装脚本)
bin/pgsql-db <cls> <db>          # 创建数据库 (包装脚本)
bin/pgsql-svc <cls>              # 刷新服务 (包装脚本)
bin/pgsql-hba <cls>              # 重载 HBA (包装脚本)
bin/pgmon-add <cls>              # 监控远程集群 (包装脚本)

REDIS 模块

./redis.yml -l <cls>             # 初始化 Redis 集群
./redis-rm.yml -l <cls>          # 移除 Redis 集群

MINIO 模块

./minio.yml -l <cls>                       # 初始化 MINIO 模块的 Silo 集群
./minio-rm.yml -l <cls> -e minio_type=silo # 移除 Silo;minio_type 默认即为 silo

DOCKER 模块

./docker.yml -l <host>           # 安装 Docker
./app.yml -e app=<name>          # 部署 Docker Compose 应用

KAFKA 模块

./kafka.yml -l <cls>             # 创建/收敛完整 Kafka 集群
./kafka.yml -l <cls> --check     # 只读预检
./kafka-rm.yml -l <cls>          # 移除完整集群
./kafka-rm.yml -l <ip>           # 从集群退役单个成员

普通收敛的 -l 必须包含所选 Kafka 集群的全部已声明成员;kafka-rm.yml 才支持选择单个成员执行退役。

MYSQL 模块

./mysql.yml -l <cls> --check     # 只读预检
./mysql.yml -l <cls>             # 创建或收敛完整的 1 成员或 3 成员集群
./mysql-rm.yml -l <cls> -e mysql_safeguard=false                      # 移除集群并默认清理 /data/mysql 与配置
./mysql-rm.yml -l <cls> -e mysql_safeguard=false -e mysql_rm_data=false  # 仅停止整套集群服务并保留数据
./mysql-rm.yml -l <ip> -e mysql_safeguard=false                       # 通过存活成员安全摘除单个 HA 成员

mysql-rm.yml 必须显式指定 -l 且传入 -e mysql_safeguard=false;默认 mysql_rm_data=true 会销毁 /data/mysql、配置文件与 Router 状态,但始终保留 mysql_backup_dir(默认 /data/backups/mysql)下的本地物理备份。单成员摘除(-l <ip>)若命中主库会自动先切主,不支持 -e mysql_rm_data=false。

这个页面对您有帮助吗?

表格阅读