剧本列表
本文汇总 Pigsty v4.x 各模块剧本入口与执行要点,详细任务标签请进入对应模块 playbook 文档。
模块剧本导航
| 模块 | 数量 | 剧本 |
|---|---|---|
INFRA | 3 | deploy.yml infra.yml infra-rm.yml |
NODE | 2 | node.yml node-rm.yml |
ETCD | 2 | etcd.yml etcd-rm.yml |
VAULT | 2 | vault.yml vault-rm.yml |
PGSQL | 7 | pgsql.yml pgsql-rm.ymlpgsql-user.yml pgsql-db.ymlpgsql-monitor.yml pgsql-migration.yml pgsql-pitr.yml |
REDIS | 2 | redis.yml redis-rm.yml |
MINIO | 2 | minio.yml minio-rm.yml |
DOCKER | 1 | docker.yml |
JUICE | 1 | juice.yml |
VIBE | 1 | vibe.yml |
KAFKA | 2 | kafka.yml kafka-rm.yml |
MYSQL | 2 | mysql.yml mysql-rm.yml |
剧本总表
| 剧本 | 模块 | 主要用途 |
|---|---|---|
deploy.yml | INFRA | 一次性串联部署核心链路(infra -> node -> etcd -> vault -> minio -> pgsql) |
infra.yml | INFRA | 初始化基础设施节点 |
infra-rm.yml | INFRA | 移除基础设施组件 |
node.yml | NODE | 节点纳管与基线配置 |
node-rm.yml | NODE | 节点去纳管 |
etcd.yml | ETCD | ETCD 安装/扩容 |
etcd-rm.yml | ETCD | ETCD 移除/缩容 |
vault.yml | VAULT | 初始化或收敛 OpenBao 密钥管理集群 |
vault-rm.yml | VAULT | 移除 OpenBao 密钥管理集群或退役单个成员 |
pgsql.yml | PGSQL | 初始化 PostgreSQL 集群或新增实例 |
pgsql-rm.yml | PGSQL | 移除 PostgreSQL 集群/实例 |
pgsql-user.yml | PGSQL | 增加业务用户 |
pgsql-db.yml | PGSQL | 增加业务数据库 |
pgsql-monitor.yml | PGSQL | 纳管远程 PostgreSQL 监控 |
pgsql-migration.yml | PGSQL | 生成迁移手册与脚本 |
pgsql-pitr.yml | PGSQL | 时间点恢复(PITR) |
redis.yml | REDIS | Redis 部署 |
redis-rm.yml | REDIS | Redis 移除 |
minio.yml | MINIO | Silo 部署 |
minio-rm.yml | MINIO | 移除 Silo、配置与可选数据 |
docker.yml | DOCKER | Docker 引擎部署 |
juice.yml | JUICE | JuiceFS 实例部署/移除 |
vibe.yml | VIBE | VIBE 开发环境部署 |
kafka.yml | KAFKA | 创建或收敛完整的 dynamic KRaft 集群 |
kafka-rm.yml | KAFKA | 移除 Kafka 集群,或安全退役单个成员 |
mysql.yml | MYSQL | 收敛原生 MySQL 8.4 单节点或三节点 InnoDB Cluster |
mysql-rm.yml | MYSQL | 移除原生 MySQL 集群或摘除单个成员(默认删除数据与配置,保留备份目录) |
辅助剧本
以下剧本不归属于特定模块,提供一些辅助功能。
剧本使用注意事项
保护机制
多个模块提供了防误删保险,通过 *_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 剧本会立即中止执行。确认风险与备份后,可通过命令行参数覆盖:
限制执行范围
执行剧本时建议使用 -l 参数限制命令执行的对象范围:
在大规模部署上批量执行时,建议先在单集群灰度验证,再分批执行到全局。
幂等性
大部分剧本都是幂等的,可以重复执行。但需要注意:
infra.yml默认 不会 清除数据,可安全重复执行。所有 clean 参数(vmetrics_clean、vlogs_clean、vtraces_clean、grafana_clean、nginx_clean)默认均为false- 如需清除基础设施数据重建,需显式设置对应的 clean 参数为
true - 重复执行
*-rm.yml删除剧本需格外小心,确保在正确的目标上执行
任务标签
可以使用 -t 参数只执行特定的任务子集:
常用命令速查
INFRA 模块
NODE 模块
ETCD 模块
VAULT 模块
PGSQL 模块
REDIS 模块
MINIO 模块
DOCKER 模块
KAFKA 模块
普通收敛的 -l 必须包含所选 Kafka 集群的全部已声明成员;kafka-rm.yml 才支持选择单个成员执行退役。
MYSQL 模块
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。
这个页面对您有帮助吗?
感谢反馈,我们会据此改进这篇文档。
哪里没有解决?(可选)