Categories: 参考
亮点特性
Pigsty 的价值主张与亮点功能特性。
发展规划
未来功能的规划,新功能的发布节奏,待办事项列表。
历史沿革
Pigsty 项目的由来与动机,过去发展的历史,未来的目标与愿景。
活动新闻
与 Pigsty 和 PostgreSQL 相关的活动事件与新闻,以及最新活动预告!
加入社区
Pigsty 是一个 Build in Public 的项目,我们在 GitHub 上非常活跃,中文区用户主要活跃于微信群组中。
隐私政策
Pigsty 软件与网站会收集哪些用户数据,以及我们将如何处理您的数据并保护您的隐私权?
开源协议
Pigsty 使用的开源协议 —— Apache-2.0,它授予您什么样的权利,又有哪些限制?
赞助我们
Pigsty 的赞助者,投资人名单,感谢你们对本项目的支持!
行业案例
Pigsty 在各个领域与行业的客户/应用案例
订阅服务
Pigsty 专业版/企业版订阅服务:当您遇到与 PostgreSQL 和 Pigsty 有关的疑难杂症时,订阅服务可以为您兜底。
常见问题
解答关于 Pigsty 项目本身的常见问题。
同类对比
本文列出了与 Pigsty 生态位有重叠的产品与项目,并比较其在特性上的差异。
成本对比
本文提供了一组成本数据,供您评估 Pigsty 自建,使用云数据库 RDS 所需的成本,以及常规的 DBA 薪酬参考。
发布注记
Pigsty 历史版本发布说明
上手
快速上手 Pigsty:根据需求进行规划,准备资源,置备服务器,创建管理用户,下载软件并完成安装。
声明配置
使用声明式的配置来描述数据库集群与基础设施
常见问题
Pigsty 下载,安装,部署常见问题答疑
概念
了解 Pigsty 的重要概念:整体架构、逻辑模型,基础设施,以及数据库 HA,PITR,服务接入的原理。
任务
如何去完成单个任务。每个任务页面是一般通过给出若干步骤展示如何执行完成某事。
Docker:启用容器支持与配置
如何在 Pigsty 启用 Docker 容器支持?Docker 的安装部署配置,以及如何解决DockerHub被“墙”的问题
使用 PostgreSQL 作为 Ansible 的配置清单与 CMDB
使用 PostgreSQL ,而不是静态 YAML 配置文件作为 Ansible 的配置源,从而更好地与外部系统集成整合。
使用 Keepalived 为 Pigsty 节点集群配置二层 VIP
使用 VIP-Manager 为 PostgreSQL 集群配置二层 VIP
使用 TimescaleDB + Promscale 存储 Prometheus 时序指标数据
您可以通过 Promscale,使用TimescaleDB持久化Prometheus指标数据。
声明配置
使用声明式的配置来描述数据库集群与基础设施
常见问题
Pigsty 下载,安装,部署常见问题答疑
参考
详细的参考信息与列表:支持的操作系统,模块,参数,监控指标,数据库扩展,同类对比,术语表等。
Linux 兼容性
Pigsty 兼容的 Linux 操作系统发行版大版本,以及芯片架构指令集
meta
Pigsty 默认使用的配置模板,单节点,覆盖核心功能,标准单机配置,在线安装,本地备份仓库。
rich
功能丰富的单节点配置,构建本地软件源,下载所有扩展,启用 MinIO 备份,预置完整示例
slim
精简安装配置模板,不部署监控基础设施,直接从互联网安装 PostgreSQL
fat
功能全测试模板,单节点安装所有扩展,构建包含 PG 13-18 全版本的本地软件源。
infra
仅安装可观测性基础设施,不包含 PostgreSQL 与 etcd 的专用配置模板
模块列表
本文列出了 Pigsty 中可用的功能模块,以及后续的功能模块规划。
pgsql
原生 PostgreSQL 内核,支持 PostgreSQL 13 到 18 的多版本部署
citus
Citus 分布式 PostgreSQL 集群,提供水平扩展与分片能力
mssql
WiltonDB / Babelfish 内核,提供 Microsoft SQL Server 协议与语法兼容能力
polar
PolarDB for PostgreSQL 内核,提供 Aurora 风格的存算分离能力
ivory
IvorySQL 内核,提供 Oracle 语法与 PL/SQL 兼容能力
mysql
OpenHalo 内核,提供 MySQL 协议与语法兼容能力
pgtde
Percona PostgreSQL 内核,提供透明数据加密 (pg_tde) 能力
oriole
OrioleDB 内核,提供无膨胀的 OLTP 增强存储引擎
supabase
使用 Pigsty 托管的 PostgreSQL 自建 Supabase 开源 Firebase 替代方案
扩展列表
本文列出了 Pigsty 支持的 PostgreSQL 扩展插件,以及这些插件在不同系统下的支持情况。
文件结构
Pigsty 的文件系统结构是如何设计与组织的,以及各个模块使用的目录结构。
ha/simu
20 节点生产环境仿真配置,用于大规模部署测试
ha/full
四节点完整功能演示环境,带有两套 PostgreSQL 集群、MinIO、Redis 等组件示例
ha/safe
安全加固的高可用配置模板,采用高标准的安全最佳实践
ha/trio
三节点标准高可用配置模板,允许任意一台服务器宕机。
ha/dual
双节点配置模板,有限高可用部署,允许宕机特定一台服务器。
参数列表
Pigsty 配置参数总览与导航
app/odoo
使用 Pigsty 托管的 PostgreSQL 部署 Odoo 开源 ERP 系统
app/dify
使用 Pigsty 托管的 PostgreSQL 部署 Dify AI 应用开发平台
app/electric
使用 Pigsty 托管的 PostgreSQL 部署 Electric 实时同步服务
app/maybe
使用 Pigsty 托管的 PostgreSQL 部署 Maybe 个人财务管理系统
app/teable
使用 Pigsty 托管的 PostgreSQL 部署 Teable 开源 Airtable 替代品
app/registry
使用 Pigsty 部署 Docker Registry 镜像代理和私有仓库
剧本列表
Pigsty 预置剧本总览与导航
demo/el
Enterprise Linux (RHEL/Rocky/Alma) 专用配置模板
demo/debian
Debian/Ubuntu 专用配置模板
demo/demo
Pigsty 公开演示站点配置,展示如何配置 SSL 证书、暴露域名、安装全部扩展
demo/minio
四节点 x 四盘位的高可用多节点多盘 MinIO 集群演示
build/oss
Pigsty 开源版离线软件包构建环境配置
build/pro
Pigsty 专业版离线软件包构建环境配置(多版本)
应用
使用 Docker 拉起应用软件模板,使用 Pigsty Grafana & Echarts 工具箱进行数据分析与可视化
Supabase 企业级自建
使用 Pigsty 自托管企业级 supabase,带有监控,高可用,PITR,IaC 以及 400+ PG扩展。
Odoo:自建开源 ERP
如何拉起开箱即用的企业级应用全家桶 Odoo,并使用 Pigsty 管理其后端 PostgreSQL 数据库。
Dify:AI 工作流平台
如何使用 Pigsty 自建 AI Workflow LLMOps 平台 —— Dify,并使用外部 PostgreSQL,PGVector,Redis 作为存储?
NocoDB:开源 Airtable
使用 NocoDB 将 PostgreSQL 数据库转变为智能电子表格,无代码数据库应用平台。
Teable:AI 无代码数据库
使用 Teable 构建 AI 驱动的无代码数据库应用,提升团队生产力。
Gitea:自建简易代码托管平台
使用Docker拉起Gitea,并使用Pigsty的PG作为外部的元数据库
Wiki.js:维基百科站
如何使用 Wiki.js 搭建你自己的开源维基百科,并使用 Pigsty 管理的PG作为持久数据存储
Mattermost:开源 IM
使用 Mattermost 构建私有化的团队协作平台,开源的 Slack 替代方案。
Maybe:个人财务管理
使用 Maybe 管理个人财务,开源的 Mint/Personal Capital 替代方案。
Metabase:BI 分析工具
使用 Metabase 进行快速的商业智能分析,友好的用户界面让团队自主探索数据。
Kong:API 网关
拉起基于 Nginx 与 OpenResty 的强力开源 API 网关,并使用 PostgreSQL 与 Redis 作为其后端状态存储
Registry:容器镜像仓库
部署 Docker Registry 镜像服务,加速 Docker 镜像拉取,特别适合中国用户。
模板
开箱即用的配置模板,针对具体场景的配置示例,以及配置文件的详细解释。
PGWeb:网页客户端
使用Docker拉起PGWEB,以便从浏览器进行小批量在线数据查询
PostgREST:自动 API
使用Docker拉起PostgREST,自动根据PostgreSQL模式生成后端REST API
Electric:PGLite 同步引擎
使用 Electric 解决 PostgreSQL 数据同步难题,支持部分复制和实时数据传输。
Jupyter:笔记本 AI IDE
使用 Jupyter Lab 并访问 PostgreSQL 数据库,组合使用 SQL 与 Python 的能力进行数据分析。
PGLOG:PG自带日志分析应用
Pigsty自带的,用于分析PostgreSQL CSV日志样本的一个样例Applet
NOAA ISD 全球气象站历史数据查询
以ISD数据集为例,展现如何将数据导入数据库中
COVID-19 数据大盘
Pigsty 自带的,用于展示世界卫生组织官方 COVID 疫情数据的一个样例 Applet
StackOverflow 调研
分析 StackOverflow 最近七年全球开发者调研数据中关于数据库的部分
DB-Engine 热度分析
分析 DB-Engine 上的数据库管理系统,查阅其流行度变迁。
云上算力价格计算器
分析阿里云 / AWS 上算力与存储的价格 (ECS/ESSD)
DNF 变更日志
PostgreSQL 和扩展 RPM 包变更日志和发布说明
APT 变更日志
PostgreSQL 和扩展 DEB 包变更日志和发布说明
模块:PGSQL
如何使用 Pigsty 部署并管理世界上最先进的开源关系型数据库 —— PostgreSQL,按需定制,开箱即用!
核心概念
系统架构
介绍 PostgreSQL 集群的整体架构与实现细节。
集群配置
根据需求场景选择合适的实例与集群类型,配置出满足需求的 PostgreSQL 数据库集群。
集群实例
根据需求场景选择合适的实例与集群类型,配置出满足需求的 PostgreSQL 数据库集群。
内核版本
如何选择合适的 PostgreSQL 内核与大版本。
别名翻译
Pigsty 提供软件包别名翻译机制,可以屏蔽底层操作系统的二进制包细节差异,让安装更简易。
用户/角色
用户/角色指的是使用 SQL 命令 CREATE USER/ROLE 创建的,数据库集簇内的逻辑对象。
数据库
数据库指的是使用 SQL 命令 CREATE DATABASE 创建的,数据库集簇内的逻辑对象。
访问控制
Pigsty 提供的默认角色系统与权限模型
服务/接入
分离读写操作,正确路由流量,稳定可靠地交付 PostgreSQL 集群提供的能力。
访问控制
Pigsty 提供的默认角色系统与权限模型
其他说明
Pigsty 提供的默认角色系统与权限模型
用户/角色
用户/角色指的是使用 SQL 命令 CREATE USER/ROLE 创建的,数据库集簇内的逻辑对象。
数据库
数据库指的是使用 SQL 命令 CREATE DATABASE 创建的,数据库集簇内的逻辑对象。
服务/接入
分离读写操作,正确路由流量,稳定可靠地交付 PostgreSQL 集群提供的能力。
参数优化
调整 postgres 参数
认证 / HBA
Pigsty 中基于主机的身份认证 HBA(Host-Based Authentication)详解。
访问控制
Pigsty 提供的默认角色系统与权限模型
监控面板
Pigsty 为 PostgreSQL 提供了诸多开箱即用的 Grafana 监控仪表盘
指标列表
Pigsty PGSQL 模块提供的完整监控指标列表与释义
管理任务
管理预案
数据库管理任务标准操作指南(SOP)
备份恢复
时间点恢复(PITR)备份与恢复
数据迁移
如何将现有的 PostgreSQL 集群以最小的停机时间迁移至新的、由Pigsty管理的 PostgreSQL 集群?
监控系统
Pigsty监控系统架构概览,以及如何监控现存的 PostgreSQL 实例?
参考资料
内核分支
如何在 Pigsty 中使用其他 PostgreSQL 内核分支?例如 Citus,Babelfish,IvorySQL,PolarDB 等
扩展插件
利用 PostgreSQL 扩展的协同超能力
参数列表
PGSQL 模块提供的 PostgreSQL 相关配置参数详解
扩展简介
PostgreSQL 扩展的核心概念与 Pigsty 扩展生态
软件包
扩展包别名与类别命名规则
下载扩展
从软件仓库下载扩展包到本地
配置扩展
预加载扩展库与配置扩展参数
启用扩展
在数据库中创建和启用扩展
更新扩展
升级 PostgreSQL 扩展版本
移除扩展
卸载 PostgreSQL 扩展
默认扩展
Pigsty 默认安装的 PostgreSQL 扩展
扩展仓库
Pigsty 扩展软件仓库配置
常见问题
PostgreSQL 常见问题答疑
模块:INFRA
可独立使用且可选的基础设施,为 PostgreSQL 提供 NTP,DNS,可观测性等基础服务。
集群配置
如何配置 Infra 节点?定制 Nginx 服务器的配置与本地软件仓库的内容?配置 DNS,NTP 与监控组件的方法。
参数列表
INFRA 模块提供了 10 组共 70+ 个配置参数
管理预案
基础设施组件与 Infra 集群管理 SOP:创建,销毁,扩容,缩容,证书,仓库……
监控告警
如何在 Pigsty 中对基础设施进行自监控?
指标列表
Pigsty INFRA 模块提供的完整监控指标列表与释义
常见问题
Pigsty INFRA 基础设施模块常见问题答疑
模块:NODE
配置目标服务器,纳管主机节点,并将其调整至描述的状态。也包括节点上的 VIP,HAProxy 以及监控组件。
核心概念
介绍 Node 集群中涉及到的重要概念
集群配置
根据需求场景选择合适的 Node 部署类型,并对外提供可靠的接入。
参数列表
NODE 模块提供了 11 组共 60+ 个配置参数
监控告警
如何在 Pigsty 中监控 Node?如何使用 Node 本身的管控面板?有哪些告警规则值得关注?
指标列表
Pigsty NODE 模块提供的完整监控指标列表与释义
常见问题
Pigsty NODE 主机节点模块常见问题答疑
模块:ETCD
Pigsty 可部署 etcd 模块,作为 DCS 为 PostgreSQL 高可用提供可靠的分布式配置存储支持。
集群配置
根据需求场景选择合适的 Etcd 集群规模,并对外提供可靠的接入。
参数列表
ETCD 模块提供了 13 个配置参数,用于精细控制集群的行为表现。
监控告警
etcd 监控面板,指标,以及告警规则。
指标列表
Pigsty ETCD 模块提供的完整监控指标列表与释义
常见问题
Pigsty etcd 模块常见问题答疑
模块:MINIO
Pigsty 内置了 MinIO 支持,一个本地 S3 对象存储开源替代,可用于 PGSQL 模块冷备份存储。
使用方法
快速上手,如何上手使用 MinIO ?如何可靠地接入 MinIO?如何使用 mc / rclone 客户端工具?
集群配置
根据需求场景选择合适的 MinIO 部署类型,并对外提供可靠的接入。
参数列表
MinIO 模块提供了 21 个相关配置参数,用于定制所需的 MinIO 集群。
监控告警
如何在 Pigsty 中监控 MinIO?如何使用 MinIO 本身的管控面板?有哪些告警规则值得关注?
指标列表
Pigsty MINIO 模块提供的完整监控指标列表与释义
常见问题
Pigsty MINIO 对象存储模块常见问题答疑
模块:REDIS
Pigsty 内置了 Redis 支持,开源高性能缓存,可作为 PostgreSQL 的辅助与补充,支持主从、集群、哨兵三种模式。
集群配置
根据需求场景选择合适的 Redis 模式,并通过配置清单表达您的需求
参数列表
REDIS 模块提供了 21 个配置参数
监控告警
如何监控 redis?有哪些告警规则值得关注?
指标列表
Pigsty REDIS 模块提供的完整监控指标列表与释义
常见问题
Pigsty REDIS 模块常见问题答疑
模块:FERRET
使用 FerretDB 为 PostgreSQL 添加 MongoDB 兼容的协议支持
使用方法
安装客户端工具,连接并使用 FerretDB
集群配置
配置 FerretDB 模块,定义集群拓扑
参数列表
使用 9 个参数自定义 FerretDB 组件
监控告警
FerretDB 模块的监控仪表板与告警规则
指标列表
FerretDB 模块提供的完整监控指标列表与释义
常见问题
FerretDB 与 DocumentDB 模块常见问题答疑
模块:DOCKER
Docker Daemon 服务,允许用户一键拉起容器化的无状态软件工具模板,加装各种功能。
使用方法
Docker 模块快速上手,安装,卸载,下载,仓库,镜像,代理,拉取,关于 Docker 你需要知道的内容。
参数列表
DOCKER 模块提供了 8 个配置参数
指标列表
Pigsty Docker 模块提供的完整监控指标列表与释义
常见问题
Pigsty Docker 模块常见问题答疑
模块:PILOT
试点开发的额外功能模组
模块:MySQL
使用 Pigsty 拉起过气的 MySQL 集群,用于测试,迁移,性能评估等目的。
模块:Kafka
使用 Pigsty 拉起 Kafka Kraft 集群,一个开源的分布式流处理平台。
模块:DuckDB
使用 Pigsty 安装 DuckDB,一个高性能,嵌入式的分析数据库组件。
模块:TigerBeetle
使用 Pigsty 部署 TigerBeetle,金融会计事务专用数据库。
模块:Kubernetes
使用 Pigsty 安装 Kubernetes,生产级无状态容器调度编排私有云平台
模块:Consul
使用 Pigsty 安装部署 Consul —— Etcd 的替代品。
模块:Victoria
使用 Pigsty 拉起 VictoriaMetrics 与 VictoriaLogs,Prometheus 与 Loki 的原位上位替代组件。
模块:Jupyter
使用 Pigsty 拉起 JupyterNotebook,搭建开箱即用的数据分析环境。
版本
pig —— PostgreSQL 包管理器的发布说明
pig
pig CLI 命令参考概览
pig ext
使用 pig ext 子命令管理 PostgreSQL 扩展
pig repo
使用 pig repo 子命令管理软件仓库
pig sty
使用 pig sty 子命令管理 Pigsty 安装
pig build
使用 pig build 子命令从源码构建扩展
发布日志
pigsty-infra 仓库变更日志和可观测性包发布说明
配置参考
PG Exporter 的配置选项与采集器定义
API 参考
PG Exporter 的 HTTP API 端点参考
部署指南
生产环境部署策略与最佳实践