This is the multi-page printable view of this section.
Click here to print .
Return to the regular view of this page .
Pigsty 中文文档 v3.1
“P ostgreSQL I n G reat STY le”: P ostgres, I nfras, G raphics, S ervice, T oolbox, it’s all Y ours.
—— 开箱即用、本地优先的 PostgreSQL 发行版,开源 RDS 替代
仓库 | 演示 | 博客 | 论坛 | GPTs | 微信公众号 | EN Docs
快速上手 最新版本的 Pigsty:curl -fsSL https://repo.pigsty.io/get | bash
入门 : 安装部署 | 离线安装 | 资源准备 | 声明配置 | 执行剧本 | 置备机器 | 安全考量 | FAQ
模块 :PGSQL
| INFRA
| NODE
| ETCD
| MINIO
| REDIS
| FERRET
| DOCKER
| APP
关于 :功能特性 | 历史沿革 | 活动新闻 | 加入社区 | 隐私政策 | 开源协议 | 赞助我们 | 服务订阅
概念 : 架构概览 | 集群模型 | 监控系统 | 本地CA | IaC | HA | PITR | 服务接入 | 认证鉴权
参考 : 兼容性 | 参数列表 | 扩展列表 | 文件结构 | 同类产品 | 成本参考 | 术语表
1 - 快速开始
快速上手 Pigsty:根据需求进行规划,准备资源,置备服务器,创建管理用户,下载软件并完成安装。
1.1 - 安装部署
下载、配置、安装 Pigsty
安装 Pigsty 四步走: 准备 ,下载 ,配置 ,以及 安装 。没有互联网访问,请同时参阅 离线安装 。
简短版本
准备 一个安装了 兼容 操作系统的 Linux x86_64
/ aarch64
节点,使用带有免密 sudo
权限的用户,执行以下命令:
curl -fsSL https://repo.pigsty.io/get | bash; cd ~/pigsty;
该命令会 下载 并解压 Pigsty 源码至家目录,依次完成 配置 与安装 即可完成安装。
./bootstrap; ./configure; ./install.yml; # 准备依赖,生成配置,安装 Pigsty 三步走!
整个安装过程根据服务器规格/网络条件需 5 到 30 分钟不等,离线安装 可以显著加速。
安装完成后,您可以通过域名,或80/443
端口通过 Nginx 访问 WEB 界面 ,
通过 5432
端口 访问 默认的 PostgreSQL 数据库 服务 。
您可以继续使用 Pigsty 纳管 更多 节点,并部署各种 模块 。
如果您觉得 Pigsty 的组件过于复杂,还可以考虑使用 最小化安装 ,仅安装高可用 PostgreSQL 集群所必需的组件。
视频样例:在线单机安装(EL9)
准备
关于准备工作的完整详细说明,请参考 入门:准备工作 一节。
Pigsty 支持 Linux
内核与 x86_64/aarch64
架构,运行于物理机、虚拟机环境中,要求使用静态IP地址 。
最低配置要求为 1C1G
,推荐至少使用 2C4G
以上的机型,上不封顶,参数会自动优化适配。
我们强烈建议您使用刚安装完操作系统的全新节点部署,从而避免无谓的安装异常问题,建议使用 RockyLinux 8.9 或 Ubuntu 22.04.3 ,
支持的完整操作系统列表请参考 兼容性 。
在安装 Pigsty 的管理节点上,您需要拥有 ssh
登陆权限与 sudo
权限。
如果您的部署涉及多个节点,您应当确保当前管理用户在当前管理节点上,可以通过 SSH 公钥免密登陆其他被管理的节点(包括本节点)。
避免使用 root 用户安装
尽管使用
root
用户安装 Pigsty 是可行的,但
安全最佳实践
是使用一个不同于根用户(
root
)与数据库超级用户 (
postgres
) 的专用管理员用户(如:
dba
),
Pigsty 安装过程中会默认创建由配置文件指定的可选管理员用户
dba
。
Pigsty 依赖 Ansible 执行剧本,在执行安装前,您需要先安装 ansible
与 jmespath
软件包。
您可以通过 bootstrap
脚本完成这一任务,特别是当您没有互联网访问,需要进行离线安装 时。
./bootstrap # 使用各种可选方式安装 Ansible 与 Jmespath 依赖,如果离线包存在则使用离线包
您也可以直接使用操作系统的包管理器安装所需的 Ansible 与 Jmespath 软件包:
安装 Ansible
EL 8 / 9
EL 7
Debian / Ubuntu
MacOS
sudo dnf install -y ansible python3.12-jmespath python3-cryptography
sudo yum install -y ansible # EL7 无需显式安装 Jmespath
sudo apt install -y ansible python3-jmespath
下载
您可以使用以下命令自动下载、解压 Pigsty 源码包至 ~/pigsty
目录下使用:
curl -fsSL https://repo.pigsty.cc/get | bash # 安装最新稳定版本
curl -fsSL https://repo.pigsty.cc/get | bash -s v3.1.0 # 安装特定版本 3.1.0
一键下载脚本的样例输出
$ curl -fsSL https://repo.pigsty.cc/get | bash
[ v3.1.0] ===========================================
$ curl -fsSL https://repo.pigsty.cc/get | bash
[ Site] https://pigsty.io
[ Demo] https://demo.pigsty.cc
[ Repo] https://github.com/Vonng/pigsty
[ Docs] https://pigsty.io/docs/setup/install
[ Download] ===========================================
[ OK ] version = v3.1.0 ( from default)
curl -fSL https://repo.pigsty.cc/src/pigsty-v3.1.0.tgz -o /tmp/pigsty-v3.1.0.tgz
[ WARN] tarball = /tmp/pigsty-v3.1.0.tgz exists, size = 1227379, use it
[ OK ] md5sums = 01b4acbe8983c1324652ae68b4f3c56f /tmp/pigsty-v3.1.0.tgz
[ Install] ===========================================
[ WARN] os user = root , it's recommended to install as a sudo-able admin
[WARN] pigsty already installed on ' /root/pigsty', if you wish to overwrite:
sudo rm -rf /tmp/pigsty_bk; cp -r /root/pigsty /tmp/pigsty_bk; # backup old
sudo rm -rf /tmp/pigsty; tar -xf /tmp/pigsty-v3.1.0.tgz -C /tmp/; # extract new
rsync -av --exclude=' /pigsty.yml' --exclude=' /files/pki/***' /tmp/pigsty/ /root/pigsty/; # rsync src
[ TodoList] ===========================================
cd /root/pigsty
./bootstrap # [OPTIONAL] install ansible & use offline package
./configure # [OPTIONAL] preflight-check and config generation
./install.yml # install pigsty modules according to your config.
[ Complete] ===========================================
你也可以使用 git
来下载 Pigsty 源代码,请 务必 检出特定版本后使用。
git clone https://github.com/Vonng/pigsty; cd pigsty; git checkout v3.1.0
检出特定版本使用
main
主干为活跃开发分支,使用
git
时请务必检出特定版本后使用,可用版本请参考
发行注记 。
配置
配置 / configure
会根据您当前的环境,自动生成推荐的(单机安装) pigsty.yml
配置文件 。
提示: 如果您已经了解了如何配置 Pigsty,configure
这个步骤是可选的,可以跳过。 Pigsty 提供了许多开箱即用的预置 配置模板 供您参考。
./configure # 不带参数会自动推荐配置,并交互式问询
./configure [ -i| --ip <ipaddr>] # 指定首要 IP 地址,如果不指定,将在检测到多个可用IP地址时问询。
[ -c| --conf <conf>] # 指定配置模板(相对于 conf/ 目录的配置名称,不带.yml 后缀),默认使用 meta 单节点模板
[ -v| --version <ver>] # 指定要安装 PostgreSQL 大版本,部分模板不适用此配置
[ -r| --region <default| china| europe>] # 选择镜像源区域,如果在 GFW 区域内,将被设置为 china
[ -n| --non-interactive] # 跳过交互式向导
[ -x| --proxy] # 将环境变量中的代理配置写入配置文件的 proxy_env 参数中
配置 / configure 过程的样例输出
$ ./configure
configure pigsty v3.1.0 begin
[ OK ] region = china
[ OK ] kernel = Linux
[ OK ] machine = x86_64
[ OK ] package = rpm,yum
[ OK ] vendor = centos ( CentOS Linux)
[ OK ] version = 7 ( 7)
[ OK ] sudo = vagrant ok
[ OK ] ssh = vagrant@127.0.0.1 ok
[ WARN] Multiple IP address candidates found:
( 1) 192.168.121.110 inet 192.168.121.110/24 brd 192.168.121.255 scope global noprefixroute dynamic eth0
( 2) 10.10.10.10 inet 10.10.10.10/24 brd 10.10.10.255 scope global noprefixroute eth1
[ OK ] primary_ip = 10.10.10.10 ( from demo)
[ OK ] admin = vagrant@10.10.10.10 ok
[ WARN] mode = el7, CentOS 7.9 EOL @ 2024-06-30, deprecated, consider using el8 or el9 instead
[ OK ] configure pigsty done
proceed with ./install.yml
-i|--ip
: 当前主机的首要内网IP地址,用于替换配置文件中的 IP 地址占位符 10.10.10.10
。
-c|--conf
: 用于指定使用的配置 配置模板 ,相对于 conf/
目录,不带 .yml
后缀的配置名称。
-v|--version
: 用于指定要安装的 PostgreSQL 大版本,如 13
、14
、15
、16
、17
,部分模板不支持此配置。
-r|--region
: 用于指定上游软件源的区域,加速下载: (default|china|europe
)
-n|--non-interactive
: 直接使用命令行参数提供首要IP地址,跳过交互式向导。
-x|--proxy
: 使用当前环境变量配置 proxy_env
变量(影响 http_proxy
/HTTP_PROXY
, HTTPS_PROXY
, ALL_PROXY
, NO_PROXY
)。
如果您的机器网卡绑定了多个 IP 地址,那么需要使用 -i|--ip <ipaddr>
显式指定一个当前节点的首要 IP 地址,或在交互式问询中提供。
选用的地址应为静态 IP 地址,请勿使用公网 IP 地址。
配置过程生成的配置文件默认位于:~/pigsty/pigsty.yml
,您可以在安装前进行检查与修改定制。
修改默认密码!
我们强烈建议您在安装前,事先修改配置文件中使用的默认密码与凭据,详情参考
安全考量 。
安装
使用 install.yml
剧本,默认在当前节点上完成标准的单节点 Pigsty 安装。
./install.yml # 一次性在所有节点上完成安装
安装过程的样例输出
[ vagrant@meta pigsty] $ ./install.yml
PLAY [ IDENTITY] ********************************************************************************************************************************
TASK [ node_id : get node fact] *****************************************************************************************************************
changed: [ 10.10.10.10]
...
...
PLAY RECAP **************************************************************************************************************************************************************************
10.10.10.10 : ok = 288 changed = 215 unreachable = 0 failed = 0 skipped = 64 rescued = 0 ignored = 0
localhost : ok = 3 changed = 0 unreachable = 0 failed = 0 skipped = 4 rescued = 0 ignored = 0
这是一个 Ansible 剧本 ,您可以使用以下参数控制其执行的目标、任务、并传递额外的命令参数:
-l
: 限制执行的目标对象
-t
: 限制要执行的任务
-e
: 传入额外的命令行参数
-i
: 指定使用不同于 pigsty.yml
的配置文件
…
避免重复执行安装剧本!
警告: 在已经初始化的环境中再次运行 install.yml
会重置整个环境,所以请务必小心!
此剧本仅用于初始安装,安装完毕后可以用 rm install.yml
或 chmod a-x install.yml
来避免此剧本的误执行。
用户界面
当安装完成后,当前节点会安装有四个 核心模块 :PGSQL
,INFRA
,NODE
,ETCD
。
本机上的 PGSQL 模块提供了一个开箱即用的单机 PostgreSQL 数据库实例,默认可以使用以下连接串 访问 :
默认用户连接串
dbuser_dba
dbuser_meta
dbuser_view
psql postgres://dbuser_dba:DBUser.DBA@10.10.10.10/meta # DBA / 超级用户(IP直连)
psql postgres://dbuser_meta:DBUser.Meta@10.10.10.10/meta # 业务管理员用户,读/写/DDL变更
psql postgres://dbuser_view:DBUser.View@pg-meta/meta # 只读用户(走域名访问)
本机上的 INFRA 模块为您提供了监控基础设施,默认使用的域名与端口如下所示:
Grafana 监控系统(g.pigsty / 3000端口)的默认用户名与密码为:admin
/ pigsty
您可以通过 IP地址 + 端口的方式直接访问这些服务。但我们更推荐您使用域名通过 Nginx 80/443 端口代理访问所有组件。
使用域名访问 Pigsty WebUI 时,您需要配置 DNS 解析,或者修改本地的 /etc/hosts
静态解析文件。
如何通过域名访问 Pigsty WebUI ?
客户端可以通过几种不同的办法来使用域名访问:
通过 DNS 服务商解析互联网域名,适用于公网可访问的系统。
通过配置内网 DNS 服务器解析记录实现内网域名解析。
修改本机的 /etc/hosts
文件添加静态解析记录。(Windows下为:)
我们建议普通用户使用第三种方式,在使用浏览器访问 Web 系统的机器上,修改 /etc/hosts
(需要 sudo 权限)或 C:\Windows\System32\drivers\etc\hosts
(Windows)文件,添加以下的解析记录:
<your_public_ip_address> h.pigsty a.pigsty p.pigsty g.pigsty
这里的 IP 地址是安装 Pigsty 服务的 对外IP地址 。
如何配置服务端使用的域名?
服务器端域名使用 Nginx 进行配置,如果您想要替换默认的域名,在参数 infra_portal
中填入使用的域名即可。
当您使用 http://g.pigsty
访问 Grafana 监控主页时,实际上是通过 Nginx 代理访问了 Grafana 的 WebUI:
http://g.pigsty ️-> http://10.10.10.10:80 (nginx) -> http://10.10.10.10:3000 (grafana)
如何使用 HTTPS 访问 Pigsty WebUI ?
Pigsty默认使用自动生成的自签名的 CA 证书为 Nginx 启用 SSL,如果您希望使用 HTTPS 访问这些页面,而不弹窗提示"不安全",通常有三个选择:
在您的浏览器或操作系统中信任 Pigsty 自签名的 CA 证书: files/pki/ca/ca.crt
如果您使用 Chrome,可以在提示不安全的窗口键入 thisisunsafe
跳过提示
您可以考虑使用 Let’s Encrypt 或其他免费的 CA 证书服务,为 Pigsty Nginx 生成正式的 SSL证书。
更多
你可以使用 Pigsty 部署更多的集群,管理更多的节点,例如:
bin/node-add pg-test # 将集群 pg-test 的3个节点纳入 Pigsty 管理
bin/pgsql-add pg-test # 初始化一个3节点的 pg-test 高可用PG集群
bin/redis-add redis-ms # 初始化 Redis 集群: redis-ms
大多数模块都依赖 NODE
模块,请确保节点被 Pigsty 纳管后再加装其他模块。更多细节请参考 模块 详情:
PGSQL
,INFRA
,NODE
,ETCD
,MINIO
,REDIS
,MONGO
,DOCKER
,……
1.2 - 离线安装
如何在没有互联网访问的环境中安装 Pigsty?以及如何制作、使用、下载离线软件安装包?
Pigsty 默认的 标准安装 流程需要访问互联网,然而生产环境的数据库服务器通常是与互联网隔离的。
为了解决这个问题,Pigsty 提供了离线安装的功能。通过使用离线软件包 ,用户可以在没有互联网访问的环境中同样完成安装与部署。
离线软件包是本地软件源的快照与镜像,使用离线软件包可以避免重复的下载请求与流量消耗,显著加速安装速度,并提高安装交付过程的可靠性与一致性。
构建本地软件源
Pigsty 会在安装过程中从互联网上游的 yum/apt 软件仓库,下载所需的 rpm/deb 包并构建一个本地软件源(默认位于 /www/pigsty
)。
本地软件源由 Nginx 对外提供服务,后续无论是本机还是其他节点,都默认会使用本地软件源进行安装,而不再需要访问互联网
使用本地软件源有四个主要好处:
本地软件源可以避免重复的下载请求与流量消耗,显著加速安装速度并提高安装过程的可靠性。
构建本地软件源会对当前可用软件版本取快照,确保部署环境内节点所安装软件版本的一致性。
使用本地快照可以避免上游依赖变化导致的依赖错漏与安装失败问题,只要首个节点成功,相同环境的节点就能成功。
构建好的本地软件源可以整体打包,复制到安装有相同操作系统的隔离环境中用于离线安装 。
在 Pigsty 中,本地软件源的默认位置是本机上的 /www/pigsty
目录(可以通过 nginx_home
& repo_name
参数进行配置)。
这个本地软件源将使用 createrepo_c
(EL) 或 dpkg-dev
(Debian) 构建,本节点和其他节点可以通过 repo_upstream
中 module=local
的仓库定义引用并使用该软件仓库。
您可以在安装完全相同操作系统的节点上执行标准安装,一旦构建完成,你可以将这个节点上的本地软件源目录,使用各种手段(scp/rsync/ftp/usb
)拷贝到另一台安装了完全相同操作系统的节点上,用于 离线安装 。
更为标准通用的做法是在安装完毕的节点上,将本地软件源打包制作为 离线软件包 ,并将其拷贝至同环境的待安装隔离节点上使用。
制作离线软件包
Pigsty 提供了 cache.yml
剧本,用于制作离线软件包。
例如以下命令会将 infra 节点上的 /www/pigsty 本地软件源,打包成离线软件包,并取回到本地 dist/${version}
目录下。
您可以使用 cache_pkg_dir
与 cache_pkg_name
参数自定义离线软件包的输出目录与名称,例如,以下命令会将离线软件包生成至 files/pkg.tgz
。
./cache.yml -l infra -e '{"cache_pkg_dir":"files","cache_pkg_name":"pkg.tgz"}'
使用离线软件包
离线软件包实际上是一个使用 gzip
与 tar
制作的压缩包,使用时解压到 /www/pigsty
目录下即可。
sudo rm -rf /www/pigsty ; sudo tar -xf /tmp/pkg.tgz -C /www
更简单的做法是将离线软件包拷贝至待安装节点的 /tmp/pkg.tgz
路径下,然后 Pigsty 会在 bootstrap
过程中会自动解包,并从本地软件源安装所需软件。
Pigsty 在构建本地软件源时会生成一个标记文件 repo_complete
,标记这是一个 Pigsty 本地软件源。
当 Pigsty 安装 时,如果发现本地软件源已经存在,就会进入离线安装模式。
在此模式下,Pigsty 将跳过从互联网下载并构建本地软件源的过程,使用本地软件源完成整个安装过程,期间无需互联网访问。
进入离线安装模式的判定标准
判定本地软件源存在的标准是:默认位于 /www/pigsty/repo_complete
的标记文件存在。
这个标记文件会在标准安装过程中,下载完成后自动生成,说明这是一个可用的本地软件源。
删除本地软件源的 repo_complete
标记文件后,安装时将重新从上游下载 缺失的 软件包。
离线包兼容性须知
离线软件包中的 RPM/DEB 包大体上可以分为三类:
INFRA 软件包:例如 Prometheus,Grafana,各种监控组件,通常在任何 Linux 发行版下都可以运行。
PGSQL 软件包:例如 PostgreSQL 内核与各种扩展插件,通常与 Linux 发行版 大版本 绑定。
NODE 软件包:例如各种动态链接库与主机依赖,通常与 Linux 发行版 大小版本 绑定
因此,离线软件包的适用性取决于操作系统的 大版本 与 小版本 ,因为它包含了上面三种软件包。
通常来说,离线软件包只能用于操作系统大小版本精准匹配的场景。
如果大版本不匹配,INFRA 类软件包 通常可以成功安装,PGSQL 和 NODE 类软件包基本必定会出现依赖缺失或冲突。
如果小版本不匹配,INFRA 类软件包和 PGSQL 软件包通常可以成功安装,而 NODE 类软件包有概率成功,也有概率失败。
例如,RockLinux 8.9 下制作的离线软件包,在 RockyLinux 8.10 环境中有较大的概率可以直接使用。
而在 Ubuntu 22.04.3 下制作的离线软件,有极大概率会在 22.04.4 中出现依赖冲突问题。
(是的没错,Ubuntu 版本号里的 .3
才是小版本号,22.04
整个是 jammy
大版本号!)
如果离线软件包的操作系统小版本不匹配,您可以采用一种折中策略进行安装,即在 bootstrap 过程后,
移除 /www/pigsty/repo_complete
标记文件,让 Pigsty 重新在安装过程中从上游下载缺失的 NODE 软件包与相关依赖。
这种方式可以有效解决使用离线软件包时的依赖冲突问题,并同时获得离线安装的全部优点。
下载离线软件包
从 Pigsty v3 开始,Pigsty 不再公开提供预制的离线软件包,统一默认使用在线安装的方式。
在线安装允许您从 Pigsty 提供的官方仓库与中国大陆 CDN 下载 INFRA / PGSQL 软件包,并由您操作系统的官方源与镜像下载 NODE 类软件包,从而最大程度的避免了 NODE 软件包小版本依赖冲突问题。
不过针对以下精确的操作系统版本,我们提供有偿制作的预制离线软件包,还额外包含了全部可用扩展插件,Docker 等组件。
RockyLinux 8.9 / 8.10 (x86_64)
RockyLinux 9.3 / 9.4 (x86_64, aarch64)
Ubuntu 24.04.1 (x86_64, arm64)
Ubuntu 22.04.5 (x86_64, arm64)
Debian 12.7 (x86_64, arm64)
Pigsty 的全套集成测试都针对于发布前预制的离线软件包快照进行,离线软件包能有效降低上游依赖变动导致的交付风险,省去您折腾的麻烦、与等待的时间。
更能体现您对开源事业的支持,物美价廉,仅需 ¥199 ,请联系 @Vonng 获取下载链接。
对于 Pigsty 专业版订阅 ,我们会针对您使用的具体操作系统大小版本,提供精确匹配,并经过集成测试后的离线软件包。
Bootstrap
Pigsty 需要使用 Ansible 来运行剧本,因此 Ansible 本身不适合通过剧本进行安装。
Bootstrap 脚本用于解决这一问题:它会尽最大努力用各种方式来确保 Ansible 在节点上安装成功。
./bootstrap # 确保 ansible 正确安装(如果有离线包,优先使用离线安装并解包使用)
如果您使用离线软件包 进行安装,Bootstrap 过程会自动识别并处理位于 /tmp/pkg.tgz
的离线软件包,并优先从中安装 Ansible。
如果没有使用离线软件包,但是有互联网访问,Bootstrap 会自动添加对应操作系统/对应区域镜像的软件源,并从中安装 Ansible。
如果既没有网也没有离线包,Bootstrap 会交给用户自行处理此问题,用户需要自行保证当前节点配置的软件源包含可用的 Ansible。
Bootstrap 脚本有一些可选参数,例如您可以使用 -p|--path
参数指定一个不同于 /tmp/pkg.tgz
的离线软件包位置。
您也可以使用 -r|--region
指定一个区域,这样如果需要从互联网下载 Ansible,Pigsty 会添加对应区域的软件源(全球,中国,欧洲)。
./boostrap
[ -r| --region <region] [ default,china,europe]
[ -p| --path <path>] specify another offline pkg path
[ -k| --keep] keep existing upstream repo during bootstrap
最后, bootstrap 过程中默认会备份(/etc/yum.repos.d/backup
/ /etc/apt/source.list.d/backup
)并移除节点当前配置的软件源,从而最大程度避免软件源冲突问题。
如果这不是你期待的行为,或者您已经配置了本地软件源,可以使用 -k|--keep
参数,保留现有软件源。
例:使用离线软件包
在一台安装了 RockyLinux 8.9 的节点上使用离线软件包安装 Pigsty:
[ vagrant@el8 pigsty] $ ls -alh /tmp/pkg.tgz
-rw-r--r--. 1 vagrant vagrant 1.4G Sep 1 10:20 /tmp/pkg.tgz
[ vagrant@el8 pigsty] $ ./bootstrap
bootstrap pigsty v3.0.4 begin
[ OK ] region = china
[ OK ] kernel = Linux
[ OK ] machine = x86_64
[ OK ] package = rpm,dnf
[ OK ] vendor = rocky ( Rocky Linux)
[ OK ] version = 8 ( 8.9)
[ OK ] sudo = vagrant ok
[ OK ] ssh = vagrant@127.0.0.1 ok
[ OK ] cache = /tmp/pkg.tgz exists
[ OK ] repo = extract from /tmp/pkg.tgz
[ WARN] old repos = moved to /etc/yum.repos.d/backup
[ OK ] repo file = use /etc/yum.repos.d/pigsty-local.repo
[ WARN] rpm cache = updating, may take a while
pigsty local 8 - x86_64 49 MB/s | 1.3 MB 00:00
Metadata cache created.
[ OK ] repo cache = created
[ OK ] install el8 utils
Last metadata expiration check: 0:00:01 ago on Sun 01 Sep 2024 10:30:52 AM UTC.
Package wget-1.19.5-11.el8.x86_64 is already installed.
Package yum-utils-4.0.21-23.el8.noarch is already installed.
Dependencies resolved.
........
Installed:
createrepo_c-0.17.7-6.el8.x86_64 createrepo_c-libs-0.17.7-6.el8.x86_64 drpm-0.4.1-3.el8.x86_64 modulemd-tools-0.7-8.el8.noarch python3-createrepo_c-0.17.7-6.el8.x86_64
python3-libmodulemd-2.13.0-1.el8.x86_64 python3-pyyaml-3.12-12.el8.x86_64 sshpass-1.09-4.el8.x86_64 unzip-6.0-46.el8.x86_64
ansible-9.2.0-1.el8.noarch ansible-core-2.16.3-2.el8.x86_64 git-core-2.43.5-1.el8_10.x86_64 mpdecimal-2.5.1-3.el8.x86_64
python3-cffi-1.11.5-6.el8.x86_64 python3-cryptography-3.2.1-7.el8_9.x86_64 python3-jmespath-0.9.0-11.el8.noarch python3-pycparser-2.14-14.el8.noarch
python3.12-3.12.3-2.el8_10.x86_64 python3.12-cffi-1.16.0-2.el8.x86_64 python3.12-cryptography-41.0.7-1.el8.x86_64 python3.12-jmespath-1.0.1-1.el8.noarch
python3.12-libs-3.12.3-2.el8_10.x86_64 python3.12-pip-wheel-23.2.1-4.el8.noarch python3.12-ply-3.11-2.el8.noarch python3.12-pycparser-2.20-2.el8.noarch
python3.12-pyyaml-6.0.1-2.el8.x86_64
Complete!
[ OK ] ansible = ansible [ core 2.16.3]
[ OK ] boostrap pigsty complete
proceed with ./configure
例:不使用离线软件包,但是有互联网访问(Debian 12)
在一台有互联网访问的 Debian 12 节点上,用户不使用离线软件包,Bootstrap 会自动添加 Debian 12 的上游软件源,并安装 ansible
与依赖:
vagrant@d12:~/pigsty$ ./bootstrap
bootstrap pigsty v3.1.0 begin
[ OK ] region = china
[ OK ] kernel = Linux
[ OK ] machine = x86_64
[ OK ] package = deb,apt
[ OK ] vendor = debian ( Debian GNU/Linux)
[ OK ] version = 12 ( 12)
[ OK ] sudo = vagrant ok
[ OK ] ssh = vagrant@127.0.0.1 ok
[ WARN] old repos = moved to /etc/apt/backup
[ OK ] repo file = add debian bookworm china upstream
[ WARN] apt cache = updating, may take a while
....... apt install output
[ OK ] ansible = ansible [ core 2.14.16]
[ OK ] boostrap pigsty complete
proceed with ./configure
例:不使用离线软件包,也没有互联网访问(Ubuntu 22.04)
在一个没有互联网访问,也没有离线包的 Ubuntu 22.04 节点上进行 bootstrap。
我们假设用户已经通过各种方式解决这个问题,例如在当前的服务器上已经配置了 CD / FS 路径的本地软件源,或者内网中有可用的 YUM / APT 仓库。
您可以使用 -k
参数显式保留当前的软件源配置,当然如果 Pigsty 检测到了没有互联网访问,也没有离线软件包,那么默认也会保留当前的软件源配置。
vagrant@u22:~/pigsty$ ./bootstrap
bootstrap pigsty v3.1.0 begin
[ OK ] region = china
[ OK ] kernel = Linux
[ OK ] machine = x86_64
[ OK ] package = deb,apt
[ OK ] vendor = ubuntu ( Ubuntu)
[ OK ] version = 22 ( 22.04)
[ OK ] sudo = vagrant ok
[ OK ] ssh = vagrant@127.0.0.1 ok
[ WARN] old repos = moved to /etc/apt/backup
[ OK ] repo file = add ubuntu jammy china upstream
[ WARN] apt cache = updating, may take a while
[ OK ] repo cache = created
...( apt update/install 输出)
[ OK ] ansible = ansible 2.10.8
[ OK ] boostrap pigsty complete
proceed with ./configure
1.3 - 精简安装
如何只安装高可用 PostgreSQL 集群以及其最小依赖,不安装本地软件源与基础设施组件?
Pigsty 带有一整套服务于高可用 PostgreSQL 基础设施堆栈,但是这也完全是可选的,您可以通过 精简安装 ,只安装必要的 PostgreSQL 高可用集群组件。
概览
精简安装专注于纯粹的 HA-PostgreSQL 集群,仅安装所需的基本组件。
在精简安装模式下,不会有 Infra
模块,没有监控,没有 本地仓库
只有部分 NODE 模块的一部分,以及 ETCD 和 PGSQL 模块会被安装:您依然可以使用完整的 PGSQL 模块与 ETCD 模块的功能
在节点上会启用的 Systemd 服务有:
patroni:必选 ,PostgreSQL 高可用与管控组件
etcd:必选 , Patroni 高可用依赖的配置中心
pgbouncer:可选 ,数据库连接池
vip-manager:可选 ,为主库绑定一个可选的二层VIP。
haproxy:可选 ,提供自动路由的 服务 接入
chronyd: 可选 ,同步节点时间
tuned:可选 ,管理节点配置模板与系统内核参数
其中 patroni
和 etcd
是必选的组件,其他组件都是可选的,尽管如此,Pigsty 不建议关闭这些组件 —— 您可以留着它们不用。
配置
要执行精简安装,您需要额外配置几个选项开关,如 slim.yml
所示:
all :
children :
infra : { hosts : { 10.10.10.10 : { infra_seq: 1 } }, vars : { docker_enabled : true } }
etcd :
hosts :
10.10.10.10 : { etcd_seq : 1 }
#10.10.10.11: { etcd_seq: 2 } # optional
#10.10.10.12: { etcd_seq: 3 } # optional
vars : { etcd_cluster : etcd }
pg-meta :
hosts :
10.10.10.10 : { pg_seq: 1, pg_role : primary } # init one single-node pgsql cluster by default, with :
#10.10.10.11: { pg_seq: 2, pg_role: replica } # optional replica : bin/pgsql-add pg-meta 10.10.10.11
#10.10.10.12: { pg_seq: 3, pg_role: replica } # optional replica : bin/pgsql-add pg-meta 10.10.10.12
vars :
pg_cluster : pg-meta
pg_users: # define business users here : https://pigsty.io/docs/pgsql/user/
- { name: dbuser_meta ,password: DBUser.Meta ,pgbouncer: true ,roles: [ dbrole_admin ] ,comment : pigsty default user }
pg_databases: # define business databases here : https://pigsty.io/docs/pgsql/db/
- { name: meta ,comment : pigsty default database }
pg_hba_rules: # define HBA rules here : https://pigsty.io/docs/pgsql/hba/#define-hba
- { user: dbuser_meta , db: all ,addr: world ,auth: pwd ,title : 'allow default user world access with password (not a good idea!)' }
node_crontab : # define backup policy with crontab (full|diff|incr)
- '00 01 * * * postgres /pg/bin/pg-backup full'
#pg_vip_address: 10.10.10.2/24 # optional l2 vip address and netmask
pg_extensions: # define pg extensions (345 available) : https://pigsty.io/docs/pgext/
- postgis timescaledb pgvector
vars :
version : v3.1.0 # pigsty version string
admin_ip : 10.10.10.10 # admin node ip address
region: default # upstream mirror region : default|china|europe
node_tune : tiny # use tiny template for NODE in demo environment
pg_conf : tiny.yml # use tiny template for PGSQL in demo environment
# minimal installation setup
node_repo_modules : node,infra,pgsql
nginx_enabled : false
dns_enabled : false
prometheus_enabled : false
grafana_enabled : false
pg_exporter_enabled : false
pgbouncer_exporter_enabled : false
pg_vip_enabled : false
同时在初始化安装时,您应该使用 slim.yml
剧本进行安装,而不是默认的 install.yml
。
然后,配置指定的节点上便会安装最小化的 PostgreSQL 高可用集群组件。
1.4 - 声明配置
使用声明式的配置来描述数据库集群与基础设施
Pigsty将基础设施和数据库视为代码 :Database as Code & Infra as Code
你可以通过声明式的接口/配置文件来描述基础设施和数据库集群,你只需在 配置清单 (Inventory) 中描述你的需求,然后用简单的幂等剧本使其生效即可。
配置清单
每一套 Pigsty 部署都有一个相应的 配置清单 (Inventory)。它可以以 YAML 的形式存储在本地,并使用 git
管理;或从 CMDB 或任何 ansible 兼容的方式动态生成。
Pigsty 默认使用一个名为 pigsty.yml
的单体 YAML 配置文件作为默认的配置清单,它位于 Pigsty 源码主目录下,但你也可以通过命令行参数 -i
指定路径以使用别的配置清单。
清单由两部分组成:全局变量 和多个 组定义 。 前者 all.vars
通常用于描述基础设施,并为集群设置全局默认参数。后者 all.children
则负责定义新的集群(PGSQL/Redis/MinIO/ETCD等等)。一个配置清单文件从最顶层来看大概如下所示:
all : # 顶层对象:all
vars : {...} # 全局参数
children : # 组定义
infra : # 组定义:'infra'
hosts : {...} # 组成员:'infra'
vars : {...} # 组参数:'infra'
etcd : {...} # 组定义:'etcd'
pg-meta : {...} # 组定义:'pg-meta'
pg-test : {...} # 组定义:'pg-test'
redis-test : {...} # 组定义:'redis-test'
# ...
集群
每个组定义通常代表一个集群,可以是节点集群、PostgreSQL 集群、Redis 集群、Etcd 集群或 Minio 集群等。它们都使用相同的格式:hosts
和 vars
。
你可以用 all.children.<cls>.hosts
定义集群成员,并使用 all.children.<cls>.vars
中的集群参数描述集群。以下是名为 pg-test
的三节点 PostgreSQL 高可用集群的定义示例:
pg-test : # 集群名称
vars : # 集群参数
pg_cluster : pg-test
hosts : # 集群成员
10.10.10.11 : { pg_seq: 1, pg_role : primary } # 实例1,在 10.10.10.11 上,主库
10.10.10.12 : { pg_seq: 2, pg_role : replica } # 实例2,在 10.10.10.12 上,从库
10.10.10.13 : { pg_seq: 3, pg_role : offline } # 实例3,在 10.10.10.13 上,从库
你也可以为特定的主机/实例定义参数,也称为实例参数。它将覆盖集群参数和全局参数,实例参数通常用于为节点和数据库实例分配身份(实例号,角色)。
参数
全局变量、组变量和主机变量都是由一系列 键值对 组成的字典对象。每一对都是一个命名的参数,由一个字符串名作为键,和一个值组成。值是五种类型之一:布尔值、字符串、数字、数组或对象。查看配置参数 以了解详细的参数语法语义。
绝大多数参数都有着合适的默认值,身份参数 除外;它们被用作标识符,并必须显式配置,例如 pg_cluster
, pg_role
,以及 pg_seq
。
参数可以被更高优先级的同名参数定义覆盖,优先级如下所示:
命令行参数 > 剧本变量 > 主机变量(实例参数) > 组变量(集群参数) > 全局变量(全局参数) > 默认值
例如:
使用命令行参数 -e pg_clean=true
强制删除现有数据库
使用实例参数 pg_role
和 pg_seq
来为一个数据库实例分配角色与标号。
使用集群变量来为集群设置默认值,如集群名称 pg_cluster
和数据库版本 pg_version
使用全局变量为所有 PGSQL 集群设置默认值,如使用的默认参数和插件列表
如果没有显式配置 pg_version
,默认值 16
版本号会作为最后兜底的缺省值。
模板
在 Pigsty 目录中的 conf/
目录里,提供了针对许多不同场景的预置配置模板可供参考选用。
在 configure
过程中,您可以通过 -c
参数指定模板。否则会默认使用单节点安装的 meta
模板。
关于这些模版的功能,请参考 配置模板 中的介绍。
切换配置源
要使用不同的配置模板,您可以将模板的内容复制到 Pigsty 源码目录的 pigsty.yml
文件中,并按需进行相应调整。
您也可以在执行 Ansible 剧本时,通过 -i
命令行参数,显式指定使用的配置文件,例如:
./node.yml -i files/pigsty/rpmbuild.yml # 根据 rpmbuild 配置文件,初始化目标节点,而不是使用默认的 pigsty.yml 配置文件
如果您希望修改默认的配置文件名称与位置,您也可以修改源码根目录下的 ansible.cfg
的 inventory
参数,将其指向您的配置文件路径,这样您就可以直接执行 ansible-playbook
命令而无需显式指定 -i
参数。
Pigsty 允许您使用数据库(CMDB)作为动态配置源,而不是使用静态配置文件。 Pigsty 提供了三个便利脚本:
参考
Pigsty 带有 280+ 配置参数,分为以下32个参数组,详情请参考 配置参数 。
1.5 - 准备工作
如何准备部署 Pigsty 所需的节点,操作系统,管理员用户,端口,与所需权限。
与 Pigsty 部署有关的 101 入门知识。
节点准备
Pigsty 支持 Linux
内核与 x86_64/amd64
架构,适用于任意节点。
所谓节点(node),指 ssh 可达并提供裸操作系统环境的资源,例如物理机,裸金属,虚拟机,或者启用了 systemd 与 sshd 的操作系统容器。
部署 Pigsty 最少需要一个节点。最低配置要求为 1C1G
,推荐至少使用 2C4G
以上的机型,适用配置上不封顶,参数会自动优化适配。
作为 Demo,个人站点,或者开发环境时,可以使用单个节点。作为独立监控基础设施使用时,建议使用 1-2 个节点,作为高可用 PostgreSQL 数据库集群使用时,建议至少使用 3 个节点。用于核心场景时,建议使用至少 4-5 个节点。
充分利用 IaC 工具完成琐事
手工配置大规模生产环境繁琐且容易出错,我们建议您充分利用 Infra as Code 工具,解决此类问题。
您可以使用 Pigsty 提供的 Terraform 模板与 Vagrant 模板,使用 IaC 的方式一键创建所需的节点环境,完成好网络,操作系统,管理用户,权限,安全组的置备工作。
网络准备
Pigsty 要求节点使用 静态IPv4地址 ,即您应当为节点显式分配指定固定的 IP 地址,而不应当使用 DHCP 动态分配的地址。
节点使用的 IP 地址应当是节点用于内网通信的首要 IP 地址,并将作为节点的唯一身份标识符。
如果您希望使用可选的 Node VIP 与 PG VIP 功能,应当确保所有节点位于一个大二层网络中。
您的防火墙策略应当保证所需的端口在节点间开放,不同模块所需的具体端口列表请参考 节点:端口 。
应该暴露哪些端口?
暴露端口的方法取决于您的网络安全策略实现,例如:公有云上的安全组策略,或本地 iptables 记录,防火墙配置等。
如果您只是希望尝尝鲜,不在乎安全,并且希望一切越简单越好,那么您可以仅对外部用户按需开放 5432
端口( PostgreSQL 数据库) 与 3000
端口(Grafana 可视化界面)。
在 Infra节点 上的 Nginx 默认会对外暴露 80/443
端口提供 Web 服务,并通过域名对不同服务进行区分,这一端口应当对办公网络(或整个整个互联网)开放。
严肃的生产数据库服务端口通常不应当直接暴露在公网上,如果您确实需要这么做,建议首先查阅 安全最佳实践 ,并小心行事。
操作系统准备
Pigsty 支持多种基于 Linux 内核的服务器操作系统发行版,我们建议使用 RockyLinux 9.4 或 Ubuntu 22.04.5 作为安装 Pigsty 的 OS。
Pigsty 支持 RHEL (7,8,9),Debian (11,12),Ubuntu (20,22,24) 以及多种与之兼容的操作系统发行版,完整操作系统列表请参考 兼容性 。
在使用多个节点镜进行部署时,我们 强烈 建议您在所有用于 Pigsty 部署的节点上,使用相同版本 的操作系统发行版与 Linux 内核版本
我们强烈建议使用干净,全新安装的最小化安装的服务器操作系统环境 ,并使用 en_US
作为首要语言。
如何安装并启用 en_US locale?
使用其他系统语言包时,如何确保 en_US
本地化规则集可用:
yum install -y glibc-locale-source glibc-langpack-en
localedef -i en_US -f UTF-8 en_US.UTF-8
localectl set-locale LANG = en_US.UTF-8
注:Pigsty 部署的 PostgreSQL 集群默认使用 C.UTF8
locale,但字符集定义使用 en_US
以确保 pg_trgm
扩展可以正常工作。
如果您确实不需要此功能,可以配置 pg_lc_ctype
的值为 C.UTF8
,以避免在系统语言包缺失的情况下,数据库初始化报错的问题。
管理用户准备
在安装 Pigsty 的节点上,您需要拥有一个 “管理用户 ” —— 拥有免密 ssh
登陆权限与免密 sudo
权限。
免密 sudo
是必选项,用于在安装过程中执行需要 sudo
权限的命令,例如安装软件包,配置系统参数等。
如何配置管理用户的免密码 sudo 权限?
假设您的管理用户名为 vagrant
,则可以创建 /etc/sudoers.d/vagrant
文件,并添加以下记录:
%vagrant ALL =( ALL) NOPASSWD: ALL
则 vagrant 用户即可免密 sudo
执行所有命令。如果你的用户名不是 vagrant
,请将上面操作中的 vagrant
替换为您的用户名。
避免使用 root 用户安装
尽管使用 root
用户安装 Pigsty 是可行的,但我们不推荐这样做。
安全最佳实践 是使用一个不同于根用户(root
)与数据库超级用户 (postgres
) 的专用管理员用户(如:dba
)
Pigsty 提供了专用剧本任务,可以使用一个现有的管理用户(例如 root
),输入 ssh/sudo 密码,创建一个专用的 管理员用户 。
SSH 权限准备
除了免密 sudo
权限, Pigsty 还需要管理用户免密 ssh
登陆的权限。
对于单机安装 的节点而言,这意味着本机上的管理用户可以通过 ssh 免密码登陆到本机上。
如果的 Pigsty 部署涉及到多个节点,这意味着管理节点 上的管理用户应当可以通过 ssh 免密码登陆到所有被 Pigsty 纳管的节点上(包括本机),并免密执行 sudo
命令。
单机安装时,在 configure
过程中,如果您的当前管理用户没有 SSH key,Pigsty 会尝试修复此问题:随机生成一对新的 id_rsa
密钥,并添加至本地 ~/.ssh/authroized_keys
文件确保本机管理用户的 SSH 登陆能力。
Pigsty 默认会为您在纳管的节点上创建一个可用的管理用户 dba
(uid=88
),如果您已经使用了此用户,我们建议您修改 node_admin_username
使用新的用户名与其他 uid,或通过 node_admin_enabled
参数禁用。
如何配置管理用户的 ssh 免密码登陆?
假设您的管理用户名为 vagrant
,则以 vagrant
用户身份执行以下命令,会为其生成公私钥对 ~/.ssh/id_rsa[.pub]
用于登陆。如果已经存在公私钥对,则无需生成新密钥对。
ssh-keygen -t rsa -b 2048 -N '' -f ~/.ssh/id_rsa -q
生成的公钥默认位于:/home/vagrant/.ssh/id_rsa.pub
,私钥默认位于:/home/vagrant/.ssh/id_rsa
,如果您操作系统用户名不叫 vagrant
,将上面的 vagrant
替换为您的用户名即可。
您应当将公钥文件(id_rsa.pub
)追加写入到需要登陆机器的对应用户上:/home/vagrant/.ssh/authorized_keys
文件中。如果您已经可以直接通过密码访问远程机器,可以直接通过ssh-copy-id
的方式拷贝公钥:
ssh-copy-id <ip> # 输入密码以完成公钥拷贝
sshpass -p <password> ssh-copy-id <ip> # 直接将密码嵌入命令中,避免交互式密码输入(注意安全!)
Pigsty 推荐将管理用户的创建,权限配置与密钥分发放在虚拟机的置备阶段完成,作为标准化交付内容的一部分。
SSH 例外情况
如果您的 SSH 访问有一些额外限制,例如,使用了跳板机,或者进行了某些定制化修改,无法通过简单的 ssh <ip>
方式访问,那么可以考虑使用 ssh 别名。
例如,如果您的服务器可以通过 ~/.ssh/config
中定义的别名,例如 meta
通过 ssh
访问,那么可以为 配置清单 中的节点配置 ansible_host
参数,指定 SSH Alias:
nodes :
hosts : # 10.10.10.10 无法直接 ssh,但可以通过ssh别名 `meta` 访问
10.10.10.10 : { ansible_host : meta }
如果 SSH 别名无法满足您的需求,Ansible 还提供了一系列自定义 ssh 连接参数 ,可以精细控制 SSH 连接的行为。
最后,如果以下命令可以在管理节点上使用管理用户成功执行,意味着该目标节点上的管理用户与权限配置已经妥当:
软件准备
在 管理节点 上,Pigsty 需要使用 Ansible 发起控制命令。如果您使用本地单机安装,那么管理节点和被管理的节点是同一台,需要安装 Ansible。对于普通节点,则无需安装 Ansible。
在 bootstrap
过程中,Pigsty 会尽最大努力自动为您完成安装 Ansible 这一任务,但您也可以选择手工安装 Ansible。手工安装 Ansible 的过程因不同操作系统发行版/大版本而异(通常涉及到额外的弱依赖 jmespath
):
安装 Ansible
EL 8 / 9
EL 7
Debian / Ubuntu
MacOS
sudo dnf install -y ansible python3.12-jmespath python3-cryptography
sudo yum install -y ansible # EL7 无需显式安装 Jmespath
sudo apt install -y ansible python3-jmespath
为了安装 Pigsty,您还需要准备 Pigsty 源码包。您可以直接从 GitHub Release 页面下载特定版本,或使用以下命令获取最新稳定版本:
curl -fsSL https://repo.pigsty.cc/get | bash
如果您的环境没有互联网访问,也可以考虑直接从 GitHub Release 页面或其他渠道下载针对不同操作系统发行版预先制作的 离线安装包 。
1.6 - 执行剧本
Pigsty 使用 Ansible 剧本来实现所需的安装部署管理功能,但如果只是使用的话,您并不需要了解太多细节。
在 Pigsty 中,剧本 / Playbooks 用于在节点上安装模块 。
剧本可以视作可执行文件直接执行,例如:./install.yml
.
剧本
以下是 Pigsty 中默认包含的剧本:
一次性安装
特殊的剧本 install.yml
实际上是一个复合剧本,它在当前环境上安装所有以下组件。
playbook / command / group infra nodes etcd minio pgsql
[ infra.yml] ./infra.yml [ -l infra] [ +infra][ +node]
[ node.yml] ./node.yml [ +node] [ +node] [ +node] [ +node]
[ etcd.yml] ./etcd.yml [ -l etcd ] [ +etcd]
[ minio.yml] ./minio.yml [ -l minio] [ +minio]
[ pgsql.yml] ./pgsql.yml [ +pgsql]
请注意,NODE
和 INFRA
之间存在循环依赖:为了在 INFRA 上注册 NODE,INFRA 应该已经存在,而 INFRA 模块依赖于 INFRA节点上的 NODE 模块才能工作。
为了解决这个问题,INFRA 模块的安装剧本也会在 INFRA 节点上安装 NODE 模块。所以,请确保首先初始化 INFRA 节点。
如果您非要一次性初始化包括 INFRA 在内的所有节点,install.yml
剧本就是用来解决这个问题的:它会正确的处理好这里的循环依赖,一次性完成整个环境的初始化。
Ansible
执行剧本需要 ansible-playbook
可执行文件,该文件包含在 ansible
rpm/deb 包中。
Pigsty 将在 准备 期间在尽最大努力尝试在当前节点安装 ansible
。
您可以自己使用 yum
/ apt
/ brew
install ansible
来安装 Ansible,它含在各大发行版的默认仓库中。
了解 ansible 对于使用 Pigsty 很有帮助,但也不是必要的。对于基本使用,您只需要注意四个参数就足够了:
-i|--inventory <path>
:显式指定使用的配置文件
-l|--limit <pattern>
: 限制剧本在特定的组/主机/模式上执行目标(在哪里/Where)
-t|--tags <tags>
: 只运行带有特定标签的任务(做什么/What)
-e|--extra-vars <vars>
: 传递额外的命令行参数(怎么做/How)
指定配置文件
您可以使用 -i
命令行参数,显式指定使用的配置文件。
Pigsty 默认使用名为 pigsty.yml
配置文件,该文件位于 Pigsty 源码根目录中的 pigsty.yml
。但您可以使用 -i
覆盖这一行为,例如:
./node.yml -i files/pigsty/rpmbuild.yml # 根据 rpmbuild 配置文件,初始化目标节点,而不是使用默认的 pigsty.yml 配置文件
./pgsql.yml -i files/pigsty/rpm.yml # 根据 files/pigsty/rpm.yml 配置文件中的定义,在目标节点上安装 pgsql 模块
./redis.yml -i files/pigsty/redis.yml # 根据 files/pigsty/redis.yml 配置文件中的定义,在目标节点上安装 redis 模块
如果您希望永久修改默认使用的配置文件,可以修改源码根目录下的 ansible.cfg
的 inventory
参数,将其指向您的配置文件路径。
这样您就可以在执行 ansible-playbook
命令时无需显式指定 -i
参数了。
指定执行对象
您可以使用 -l|-limit <selector>
限制剧本的执行目标。
缺少此值可能很危险,因为大多数剧本会在 all
分组,也就是所有主机上执行,使用时务必小心。
以下是一些主机限制的示例:
./pgsql.yml # 在所有主机上运行(非常危险!)
./pgsql.yml -l pg-test # 在 pg-test 集群上运行
./pgsql.yml -l 10.10.10.10 # 在单个主机 10.10.10.10 上运行
./pgsql.yml -l pg-* # 在与通配符 `pg-*` 匹配的主机/组上运行
./pgsql.yml -l '10.10.10.11,&pg-test' # 在组 pg-test 的 10.10.10.10 上运行
/pgsql-rm.yml -l 'pg-test,!10.10.10.11' # 在 pg-test 上运行,除了 10.10.10.11 以外
./pgsql.yml -l pg-test # 在 pg-test 集群的主机上执行 pgsql 剧本
执行剧本子集
你可以使用 -t|--tags <tag>
执行剧本的子集。 你可以在逗号分隔的列表中指定多个标签,例如 -t tag1,tag2
。
如果指定了任务子集,将执行给定标签的任务,而不是整个剧本。以下是任务限制的一些示例:
./pgsql.yml -t pg_clean # 如果必要,清理现有的 postgres
./pgsql.yml -t pg_dbsu # 为 postgres dbsu 设置操作系统用户 sudo
./pgsql.yml -t pg_install # 安装 postgres 包和扩展
./pgsql.yml -t pg_dir # 创建 postgres 目录并设置 fhs
./pgsql.yml -t pg_util # 复制工具脚本,设置别名和环境
./pgsql.yml -t patroni # 使用 patroni 引导 postgres
./pgsql.yml -t pg_user # 提供 postgres 业务用户
./pgsql.yml -t pg_db # 提供 postgres 业务数据库
./pgsql.yml -t pg_backup # 初始化 pgbackrest 仓库和 basebackup
./pgsql.yml -t pgbouncer # 与 postgres 一起部署 pgbouncer sidecar
./pgsql.yml -t pg_vip # 使用 vip-manager 将 vip 绑定到 pgsql 主库
./pgsql.yml -t pg_dns # 将 dns 名称注册到 infra dnsmasq
./pgsql.yml -t pg_service # 使用 haproxy 暴露 pgsql 服务
./pgsql.yml -t pg_exporter # 使用 haproxy 暴露 pgsql 服务
./pgsql.yml -t pg_register # 将 postgres 注册到 pigsty 基础设施
# 运行多个任务:重新加载 postgres 和 pgbouncer hba 规则
./pgsql.yml -t pg_hba,pg_reload,pgbouncer_hba,pgbouncer_reload
# 运行多个任务:刷新 haproxy 配置并重新加载
./node.yml -t haproxy_config,haproxy_reload
传递额外参数
您可以通过 -e|-extra-vars KEY=VALUE
传递额外的命令行参数。
命令行参数具有压倒性的优先级,以下是一些额外参数的示例:
./node.yml -e ansible_user = admin -k -K # 作为另一个用户运行剧本(带有 admin sudo 密码)
./pgsql.yml -e pg_clean = true # 在初始化 pgsql 实例时强制清除现有的 postgres
./pgsql-rm.yml -e pg_uninstall = true # 在 postgres 实例被删除后明确卸载 rpm
./redis.yml -l 10.10.10.11 -e redis_port = 6379 -t redis # 初始化一个特定的 redis 实例:10.10.10.11:6379
./redis-rm.yml -l 10.10.10.13 -e redis_port = 6379 # 删除一个特定的 redis 实例:10.10.10.11:6379
此外,您还可以通过 JSON 的方式,传递诸如数组与对象这样的复杂参数:
# 通过指定软件包与仓库模块,在节点上安装 duckdb
./node.yml -t node_repo,node_pkg -e '{"node_repo_modules":"infra","node_default_packages":["duckdb"]}'
大多数剧本都是幂等的,这意味着在未打开保护选项的情况下,一些部署剧本可能会 删除现有的数据库 并创建新的数据库。
请仔细阅读文档,多次校对命令,并小心操作。作者不对因误用造成的任何数据库损失负责 。
1.7 - 置备机器
介绍 Pigsty 演示所使用的标准四节点沙箱环境,以及如何使用 Vagrant 与 Terraform 置备所需的虚拟机。
Pigsty 在节点上运行,这些节点可以是裸机或虚拟机。您可以手工置备它们,或使用 terraform 和 vagrant 这样的工具在云端或本地进行自动配置。
沙箱环境
Pigsty 带有一个演示沙箱,所谓沙箱,就是专门用来演示/测试的环境:IP地址和其他标识符都预先固定配置好,便于复现各种演示用例。
默认的沙箱环境由4个节点组成,配置文件请参考 full.yml
。
沙箱的 4 个节点有着固定的 IP 地址:10.10.10.10
、10.10.10.11
、10.10.10.12
、10.10.10.13
。
沙箱带有一个位于 meta
节点上的单实例 PostgreSQL 集群:pg-meta
:
meta 10.10.10.10 pg-meta pg-meta-1
沙箱中还有一个由三个实例组成的 PostgreSQL 高可用集群:pg-test
,部署在另外三个节点上:
node-1 10.10.10.11 pg-test.pg-test-1
node-2 10.10.10.12 pg-test.pg-test-2
node-3 10.10.10.13 pg-test.pg-test-3
两个可选的 L2 VIP 分别绑定在 pg-meta
和 pg-test
集群的主实例上:
10.10.10.2 pg-meta
10.10.10.3 pg-test
在 meta
节点上,还有一个单实例的 etcd
“集群”和一个单实例的 minio
“集群”。
您可以在本地虚拟机或云虚拟机上运行沙箱。Pigsty 提供基于 Vagrant 的本地沙箱(使用 Virtualbox/libvirt 启动本地虚拟机)以及基于 Terraform 的云沙箱(使用云供应商 API 创建虚拟机)。
此外,Pigsty 还提供了一个 42节点 的生产仿真环境沙箱 prod.yml
。
Vagrant
Vagrant 可以按照声明式的方式创建本地虚拟机。请查看 Vagrant 模板介绍 以获取详情。
安装
确保您的操作系统中已经安装并可以使用 Vagrant 和 Virtualbox 。
如果您使用的是 macOS,您可以使用 homebrew
一键命令安装它们,注意安装 Virtualbox 后需要重启系统。
如果你用的是 Linux,可以使用 virtualbox,也可以考虑使用 KVM: vagrant-libvirt 。
/bin/bash -c " $( curl -fsSL https://raw.githubusercontent.com/Homebrew/install/HEAD/install.sh) "
brew install vagrant virtualbox ansible # 在 MacOS 中可以轻松一键安装,但只有 x86_64 Intel 芯片的可以
配置
vagarnt/Vagranfile
是一个 Ruby 脚本文件,用来描述 Vagrant 要创建的虚拟机节点。Pigsty 提供了一些默认的配置模板:
模板
快捷方式
规格
注释
meta.rb
v1
4C8G x 1
单一 Meta 节点
full.rb
v4
2C4G + 1C2G x 3
完整的4节点沙盒示例
el7.rb
v7
2C4G + 1C2G x 3
EL7 3-节点测试环境
el8.rb
v8
2C4G + 1C2G x 3
EL8 3-节点测试环境
el9.rb
v9
2C4G + 1C2G x 3
EL9 3-节点测试环境
build.rb
vb
2C4G x 3
3-节点 EL7,8,9 构建环境
check.rb
vc
2C4G x 30
30 EL7-9, PG12-16 测试环境
minio.rb
vm
2C4G x 3 + Disk
3-节点 MinIO/etcd 测试环境
prod.rb
vp
2C4G x 42
42节点的生产模拟环境
每个规格文件包含一个描述虚拟机节点的 Specs
变量。例如,full.rb
包含4节点沙盒规格的描述:
Specs = [
{ "name" => "meta" , "ip" => "10.10.10.10" , "cpu" => "2" , "mem" => "4096" , "image" => "generic/rocky9" },
{ "name" => "node-1" , "ip" => "10.10.10.11" , "cpu" => "1" , "mem" => "2048" , "image" => "generic/rocky9" },
{ "name" => "node-2" , "ip" => "10.10.10.12" , "cpu" => "1" , "mem" => "2048" , "image" => "generic/rocky9" },
{ "name" => "node-3" , "ip" => "10.10.10.13" , "cpu" => "1" , "mem" => "2048" , "image" => "generic/rocky9" },
]
您可以使用 vagrant/config
脚本切换 Vagrant 配置文件,它会根据规格以及虚拟机软件类型,渲染生成最终的 Vagrantfile
。
cd ~/pigsty
vagrant/config <spec>
vagrant/config meta # singleton meta | 别名:`make v1`
vagrant/config full # 4-node sandbox | 别名:`make v4`
vagrant/config el7 # 3-node el7 test | 别名:`make v7`
vagrant/config el8 # 3-node el8 test | 别名:`make v8`
vagrant/config el9 # 3-node el9 test | 别名:`make v9`
vagrant/config prod # prod simulation | 别名:`make vp`
vagrant/config build # building environment | 别名:`make vd`
vagrant/config minio # 3-node minio env
vagrant/config check # 30-node check env
虚拟机管理
当您使用 vagrant/Vagrantfile
描述了所需的虚拟机后,你可以使用vagrant up
命令创建这些虚拟机。
Pigsty 模板默认会使用你的 ~/.ssh/id_rsa[.pub]
作为这些虚拟机的默认ssh凭证。
在开始之前,请确保你有一个有效的ssh密钥对,你可以通过以下方式生成一对:ssh-keygen -t rsa -b 2048
此外,还有一些 makefile
快捷方式包装了 vagrant 命令,你可以使用它们来管理虚拟机。
make # 等于 make start
make new # 销毁现有虚拟机,根据规格创建新的
make ssh # 将 SSH 配置写入到 ~/.ssh/ 中 (新虚拟机拉起后必须完成这一步)
make dns # 将 虚拟机 DNS 记录写入到 /etc/hosts 中 (如果想使用名称访问虚拟机)
make start # 等于先执行 up ,再执行 ssh
make up # 根据配置拉起虚拟机,或启动现有虚拟机
make halt # 关停现有虚拟机 (down,dw)
make clean # 销毁现有虚拟机 (clean/del/destroy)
make status # 显示虚拟机状态 (st)
make pause # 暂停虚拟机运行 (suspend,pause)
make resume # 恢复虚拟机运行 (resume)
make nuke # 使用 virsh 销毁所有虚拟机 (仅libvirt可用)
快捷方式
你可以使用以下的 Makefile 快捷方式使用 vagrant 拉起虚拟机环境。
make meta # 单个元节点
make full # 4-节点沙箱
make el7 # 3-节点 el7 测试环境
make el8 # 3-节点 el8 测试环境
make el9 # 3-节点 el9 测试环境
make prod # 42 节点生产仿真环境
make build # 3-节点 EL7,8,9 构建环境
make check # 30-节点构建校验测试环境
make minio # 3-节点 MinIO 测试环境
make meta install # 进行完整的单机安装
make full install # 进行4节点沙箱安装
make prod install # 进行42节点生产仿真环境安装
make check install # 进行30节点本地测试环境安装
...
Terraform 是一个开源的实践“基础设施即代码”的工具:描述你想要的云资源,然后一键创建它们。
Pigsty 提供了 AWS,阿里云,腾讯云的 Terraform 模板,您可以使用它们在云上一键创建虚拟机。
在 MacOS 上,Terraform 可以使用 homebrew 一键安装:brew install terraform
。你需要创建一个云帐户,获取 AccessKey 和 AccessSecret 凭证来继续下面的操作。
terraform/
目录包含两个示例模板:一个 AWS 模板,一个阿里云模板,你可以按需调整它们,或者作为其他云厂商配置文件的参考,让我们用阿里云为例:
cd terraform # 进入 Terraform 模板目录
cp spec/alicloud.tf terraform.tf # 使用 阿里云 Terraform 模板
在执行 terraform apply
拉起虚拟机之前,你要执行一次 terraform init
安装相应云厂商的插件。
terraform init # 安装 terraform 云供应商插件:例如默认的 aliyun 插件 (第一次使用时安装即可)
terraform apply # 生成执行计划,显示会创建的云资源:虚拟机,网络,安全组,等等等等……
运行 apply
子命令并按提示回答 yes
后,Terraform 将为你创建虚拟机以及其他云资源(网络,安全组,以及其他各种玩意)。
执行结束时,管理员节点的IP地址将被打印出来,你可以登录并开始完成 Pigsty 本身的安装
1.8 - 安全考量
Pigsty部署中与安全有关的考量
Pigsty 的默认配置已经足以覆盖绝大多数场景对于安全的需求。
Pigsty 已经提供了开箱即用的认证 与访问控制 模型,对于绝大多数场景已经足够安全。
如果您希望进一步加固系统的安全性,那么以下建议供您参考:
机密性
重要文件
保护你的 pigsty.yml 配置文件或CMDB
pigsty.yml
配置文件通常包含了高度敏感的机密信息,您应当确保它的安全。
严格控制管理节点的访问权限,仅限 DBA 或者 Infra 管理员访问。
严格控制 pigsty.yml 配置文件仓库的访问权限(如果您使用 git 进行管理)
保护你的 CA 私钥和其他证书,这些文件非常重要。
相关文件默认会在管理节点Pigsty源码目录的 files/pki
内生成。
你应该定期将它们备份到一个安全的地方存储。
密码
在生产环境部署时,必须更改这些密码,不要使用默认值!
如果您使用MinIO,请修改MinIO的默认用户密码,与pgbackrest中的引用
如果您使用远程备份仓库,请务必启用备份加密,并设置加解密密码
为 PostgreSQL 使用安全可靠的密码加密算法
使用 pg_pwd_enc
默认值 scram-sha-256
替代传统的 md5
这是默认行为,如果没有特殊理由(出于对历史遗留老旧客户端的支持),请不要将其修改回 md5
使用 passwordcheck
扩展强制执行强密码 。
在 pg_libs
中添加 $lib/passwordcheck
来强制密码策略。
使用加密算法加密远程备份
为业务用户配置密码自动过期实践
不要将更改密码的语句记录到 postgres 日志或其他日志中
SET log_statement TO 'none' ;
ALTER USER "{{ user.name }}" PASSWORD '{{ user.password }}' ;
SET log_statement TO DEFAULT;
IP地址
为 postgres/pgbouncer/patroni 绑定指定的 IP 地址,而不是所有地址。
默认的 pg_listen
地址是 0.0.0.0
,即所有 IPv4 地址。
考虑使用 pg_listen: '${ip},${vip},${lo}'
绑定到特定IP地址(列表)以增强安全性。
不要将任何端口直接暴露到公网IP上,除了基础设施出口Nginx使用的端口(默认80/443)
出于便利考虑,Prometheus/Grafana 等组件默认监听所有IP地址,可以直接从公网IP端口访问
您可以修改它们的配置文件,只监听内网IP地址,限制其只能通过 Nginx 门户通过域名访问,你也可以当使用安全组,防火墙规则来实现这些安全限制。
出于便利考虑,Redis服务器默认监听所有IP地址,您可以修改 redis_bind_address
只监听内网IP地址。
使用 HBA 限制 postgres 客户端访问
限制 patroni 管理访问权限:仅 infra/admin 节点可调用控制API
网络流量
使用 SSL 和域名,通过Nginx访问基础设施组件
使用 SSL 保护 Patroni REST API
使用 SSL 保护 Pgbouncer 客户端流量
完整性
为关键场景下的 PostgreSQL 数据库集群配置一致性优先模式(例如与钱相关的库)
pg_conf
数据库调优模板,使用 crit.yml
将以一些可用性为代价,换取最佳的数据一致性。
使用crit节点调优模板,以获得更好的一致性。
node_tune
主机调优模板使用 crit
,可以以减少脏页比率,降低数据一致性风险。
启用数据校验和,以检测静默数据损坏。
记录建立/切断连接的日志
该配置默认关闭,但在 crit.yml
配置模板中是默认启用的。
可以手工配置集群 ,启用 log_connections
和 log_disconnections
功能参数。
如果您希望彻底杜绝PG集群在故障转移时脑裂的可能性,请启用watchdog
如果你的流量走默认推荐的 HAProxy 分发,那么即使你不启用 watchdog,你也不会遇到脑裂的问题。
如果你的机器假死,Patroni 被 kill -9
杀死,那么 watchdog 可以用来兜底:超时自动关机。
最好不要在基础设施节点上启用 watchdog。
可用性
对于关键场景的PostgreSQL数据库集群,请使用足够的节点/实例数量
你至少需要三个节点(能够容忍一个节点的故障)来实现生产级的高可用性。
如果你只有两个节点,你可以容忍特定备用节点的故障。
如果你只有一个节点,请使用外部的 S3/MinIO 进行冷备份和 WAL 归档存储。
对于 PostgreSQL,在可用性和一致性之间进行权衡
不要直接通过固定的 IP 地址访问数据库;请使用 VIP、DNS、HAProxy 或它们的排列组合
使用 HAProxy 进行服务接入
在故障切换/主备切换的情况下,Haproxy 将处理客户端的流量切换。
在重要的生产部署中使用多个基础设施节点(例如,1~3)
小规模部署或要求宽松的场景,可以使用单一基础设施节点 / 管理节点。
大型生产部署建议设置至少两个基础设施节点互为备份。
使用足够数量的 etcd 服务器实例,并使用奇数个实例(1,3,5,7)
1.9 - 常见问题
Pigsty 下载,安装,部署常见问题答疑
这里列出了Pigsty用户在下载、安装、部署时常遇到的问题,如果您遇到了难以解决的问题,可以提交 Issue 或者联系我们 。
如何获取Pigsty软件源码包?
使用以下命令一键安装 Pigsty: curl -fsSL https://repo.pigsty.cc/get | bash
上述命令会自动下载最新的稳定版本 pigsty.tgz
并解压到 ~/pigsty
目录。您也可以从以下位置手动下载 Pigsty 源代码的特定版本。
如果您需要在没有互联网的环境中安装,可以提前在有网络的环境中下载好,并通过 scp/sftp 或者 CDROM/USB 传输至生产服务器。
如何加速从上游仓库下载 RPM ?
考虑使用本地仓库镜像,仓库镜像在repo_upstream
参数中配置,你可以选择 region
来使用不同镜像站。
例如,您可以设置 region
= china
,这样将使用 baseurl
中键为 china
的 URL 而不是 default
。
如果防火墙或GFW屏蔽了某些仓库,考虑使用proxy_env
来绕过。
安装失败应该如何解决?
Pigsty 不依赖 Docker,所以期待的环境是一个全新安装操作系统后的状态,如果您使用已经跑了千奇百怪服务的系统,更容易遇到疑难杂症,我们建议不要这么做。
出现安装失败时,可以按照以下思路进行排查:
您应当确认当前失败的位置在哪个模块,不同模块失败有不同的原因。您应当保留 Ansible 剧本输出结果备用,并找到所有标红的 Failed 任务。
如果出现无法识别配置,剧本直接无法开始,请检查您的配置文件是否是合法的 YAML,缩进,括号等是否有问题。
如果错误与本地软件源,Nginx 有关,请检查你的系统是不是全新系统,是否已经运行了 Nginx 或其他组件?或者是否有特殊的防火墙与安全策略在运作?
如果是安装节点软件包时出现错误,您是否使用了OS小版本精确匹配的离线软件包?上游是否出现依赖错漏?请参考下面的内容解决
如果是系统配置出现错误,您的操作系统是否是全新安装的状态?或者 —— 精简安装到了 Locale 都没有配置的状态?
如果是 MinIO 出现问题,您是否使用了 SNMD,MNMD 部署却没有提供真实的磁盘挂载点?您的 sss.pigsty
静态域名是否指向了任意 MinIO 节点或 LB 集群?
如果是 PGSQL 安装出现了问题,您在 pg_extension 中指定安装的扩展,是否还没有添加到 repo_packages 中,或者还没有被覆盖?
如果是 PGSQL 启动出现了问题,例如 wait for patroni primary,请参考 PGSQL FAQ 解决。
软件包安装失败如何解决?
请注意,Pigsty 的预制 离线软件包 是针对 特定操作系统发行版小版本 打包的,
因此如果您使用的操作系统版本没有精确对齐,我们不建议使用离线软件安装包,而是直接从上游下载符合当前操作系统实际情况的软件包版本。
如果在线安装无法解决包冲突问题,您首先可以尝试修改 Pigsty 使用的上游软件源。例如在 EL 系操作系统中, Pigsty 默认的上游软件源中使用 $releasever
这样的大版本占位符,它将被解析为具体的 7,8,9 大版本号,但是许多操作系统发行版都提供了 Vault,允许您使用特定某一个版本的软件包镜像。
因此,您可以将 repo_upstream
参数中的 BaseURL 前段替换为具体的 Vault 小版本仓库,例如:
https://mirrors.aliyun.com/rockylinux/$releasever/
(原始 BaseURL 前缀,不带 vault
)
https://mirrors.tuna.tsinghua.edu.cn/centos-vault/7.6.1810/
(使用 7.6 而不是默认的 7.9)
https://mirrors.aliyun.com/rockylinux-vault/8.6/
(使用 8.6 而不是默认的 8.9)
https://mirrors.aliyun.com/rockylinux-vault/9.2/
(使用 9.2 而不是默认的 9.3)
在替换前请注意目标软件源的路径是否真实存在,例如 EPEL 不提供小版本特定的软件源。支持这种方式的上游源包括:base
, updates
, extras
, centos-sclo
, centos-sclo-rh
, baseos
, appstream
, extras
, crb
, powertools
, pgdg-common
, pgdg1*
repo_upstream :
- { name: pigsty-local ,description: 'Pigsty Local' ,module: local ,releases: [7,8,9] ,baseurl : { default : 'http://${admin_ip}/pigsty' }} # used by intranet nodes
- { name: pigsty-infra ,description: 'Pigsty INFRA' ,module: infra ,releases: [7,8,9] ,baseurl : { default: 'https://repo.pigsty.io/rpm/infra/$basearch' ,china : 'https://repo.pigsty.cc/rpm/infra/$basearch' }}
- { name: pigsty-pgsql ,description: 'Pigsty PGSQL' ,module: pgsql ,releases: [7,8,9] ,baseurl : { default: 'https://repo.pigsty.io/rpm/pgsql/el$releasever.$basearch' ,china : 'https://repo.pigsty.cc/rpm/pgsql/el$releasever.$basearch' }}
- { name: nginx ,description: 'Nginx Repo' ,module: infra ,releases: [7,8,9] ,baseurl : { default : 'https://nginx.org/packages/centos/$releasever/$basearch/' }}
- { name: docker-ce ,description: 'Docker CE' ,module: infra ,releases: [7,8,9] ,baseurl : { default: 'https://download.docker.com/linux/centos/$releasever/$basearch/stable' ,china: 'https://mirrors.aliyun.com/docker-ce/linux/centos/$releasever/$basearch/stable' ,europe : 'https://mirrors.xtom.de/docker-ce/linux/centos/$releasever/$basearch/stable' }}
- { name: base ,description: 'EL 7 Base' ,module: node ,releases: [7 ] ,baseurl : { default: 'http://mirror.centos.org/centos/$releasever/os/$basearch/' ,china: 'https://mirrors.tuna.tsinghua.edu.cn/centos/$releasever/os/$basearch/' ,europe : 'https://mirrors.xtom.de/centos/$releasever/os/$basearch/' }}
- { name: updates ,description: 'EL 7 Updates' ,module: node ,releases: [7 ] ,baseurl : { default: 'http://mirror.centos.org/centos/$releasever/updates/$basearch/' ,china: 'https://mirrors.tuna.tsinghua.edu.cn/centos/$releasever/updates/$basearch/' ,europe : 'https://mirrors.xtom.de/centos/$releasever/updates/$basearch/' }}
- { name: extras ,description: 'EL 7 Extras' ,module: node ,releases: [7 ] ,baseurl : { default: 'http://mirror.centos.org/centos/$releasever/extras/$basearch/' ,china: 'https://mirrors.tuna.tsinghua.edu.cn/centos/$releasever/extras/$basearch/' ,europe : 'https://mirrors.xtom.de/centos/$releasever/extras/$basearch/' }}
- { name: epel ,description: 'EL 7 EPEL' ,module: node ,releases: [7 ] ,baseurl : { default: 'http://download.fedoraproject.org/pub/epel/$releasever/$basearch/' ,china: 'https://mirrors.tuna.tsinghua.edu.cn/epel/$releasever/$basearch/' ,europe : 'https://mirrors.xtom.de/epel/$releasever/$basearch/' }}
- { name: centos-sclo ,description: 'EL 7 SCLo' ,module: node ,releases: [7 ] ,baseurl : { default: 'http://mirror.centos.org/centos/$releasever/sclo/$basearch/sclo/' ,china: 'https://mirrors.aliyun.com/centos/$releasever/sclo/$basearch/sclo/' ,europe : 'https://mirrors.xtom.de/centos/$releasever/sclo/$basearch/sclo/' }}
- { name: centos-sclo-rh ,description: 'EL 7 SCLo rh' ,module: node ,releases: [7 ] ,baseurl : { default: 'http://mirror.centos.org/centos/$releasever/sclo/$basearch/rh/' ,china: 'https://mirrors.aliyun.com/centos/$releasever/sclo/$basearch/rh/' ,europe : 'https://mirrors.xtom.de/centos/$releasever/sclo/$basearch/rh/' }}
- { name: baseos ,description: 'EL 8+ BaseOS' ,module: node ,releases: [ 8,9] ,baseurl : { default: 'https://dl.rockylinux.org/pub/rocky/$releasever/BaseOS/$basearch/os/' ,china: 'https://mirrors.aliyun.com/rockylinux/$releasever/BaseOS/$basearch/os/' ,europe : 'https://mirrors.xtom.de/rocky/$releasever/BaseOS/$basearch/os/' }}
- { name: appstream ,description: 'EL 8+ AppStream' ,module: node ,releases: [ 8,9] ,baseurl : { default: 'https://dl.rockylinux.org/pub/rocky/$releasever/AppStream/$basearch/os/' ,china: 'https://mirrors.aliyun.com/rockylinux/$releasever/AppStream/$basearch/os/' ,europe : 'https://mirrors.xtom.de/rocky/$releasever/AppStream/$basearch/os/' }}
- { name: extras ,description: 'EL 8+ Extras' ,module: node ,releases: [ 8,9] ,baseurl : { default: 'https://dl.rockylinux.org/pub/rocky/$releasever/extras/$basearch/os/' ,china: 'https://mirrors.aliyun.com/rockylinux/$releasever/extras/$basearch/os/' ,europe : 'https://mirrors.xtom.de/rocky/$releasever/extras/$basearch/os/' }}
- { name: crb ,description: 'EL 9 CRB' ,module: node ,releases: [ 9] ,baseurl : { default: 'https://dl.rockylinux.org/pub/rocky/$releasever/CRB/$basearch/os/' ,china: 'https://mirrors.aliyun.com/rockylinux/$releasever/CRB/$basearch/os/' ,europe : 'https://mirrors.xtom.de/rocky/$releasever/CRB/$basearch/os/' }}
- { name: powertools ,description: 'EL 8 PowerTools' ,module: node ,releases: [ 8 ] ,baseurl : { default: 'https://dl.rockylinux.org/pub/rocky/$releasever/PowerTools/$basearch/os/' ,china: 'https://mirrors.aliyun.com/rockylinux/$releasever/PowerTools/$basearch/os/' ,europe : 'https://mirrors.xtom.de/rocky/$releasever/PowerTools/$basearch/os/' }}
- { name: epel ,description: 'EL 8+ EPEL' ,module: node ,releases: [ 8,9] ,baseurl : { default: 'http://download.fedoraproject.org/pub/epel/$releasever/Everything/$basearch/' ,china: 'https://mirrors.tuna.tsinghua.edu.cn/epel/$releasever/Everything/$basearch/' ,europe : 'https://mirrors.xtom.de/epel/$releasever/Everything/$basearch/' }}
- { name: pgdg-common ,description: 'PostgreSQL Common' ,module: pgsql ,releases: [7,8,9] ,baseurl : { default: 'https://download.postgresql.org/pub/repos/yum/common/redhat/rhel-$releasever-$basearch' ,china: 'https://mirrors.tuna.tsinghua.edu.cn/postgresql/repos/yum/common/redhat/rhel-$releasever-$basearch' , europe : 'https://mirrors.xtom.de/postgresql/repos/yum/common/redhat/rhel-$releasever-$basearch' }}
- { name: pgdg-extras ,description: 'PostgreSQL Extra' ,module: pgsql ,releases: [7,8,9] ,baseurl : { default: 'https://download.postgresql.org/pub/repos/yum/common/pgdg-rhel$releasever-extras/redhat/rhel-$releasever-$basearch' ,china: 'https://mirrors.tuna.tsinghua.edu.cn/postgresql/repos/yum/common/pgdg-rhel$releasever-extras/redhat/rhel-$releasever-$basearch' , europe : 'https://mirrors.xtom.de/postgresql/repos/yum/common/pgdg-rhel$releasever-extras/redhat/rhel-$releasever-$basearch' }}
- { name: pgdg-el8fix ,description: 'PostgreSQL EL8FIX' ,module: pgsql ,releases: [ 8 ] ,baseurl : { default: 'https://download.postgresql.org/pub/repos/yum/common/pgdg-centos8-sysupdates/redhat/rhel-8-x86_64/' ,china: 'https://mirrors.tuna.tsinghua.edu.cn/postgresql/repos/yum/common/pgdg-centos8-sysupdates/redhat/rhel-8-x86_64/' , europe : 'https://mirrors.xtom.de/postgresql/repos/yum/common/pgdg-centos8-sysupdates/redhat/rhel-8-x86_64/' } }
- { name: pgdg-el9fix ,description: 'PostgreSQL EL9FIX' ,module: pgsql ,releases: [ 9] ,baseurl : { default: 'https://download.postgresql.org/pub/repos/yum/common/pgdg-rocky9-sysupdates/redhat/rhel-9-x86_64/' ,china: 'https://mirrors.tuna.tsinghua.edu.cn/postgresql/repos/yum/common/pgdg-rocky9-sysupdates/redhat/rhel-9-x86_64/' , europe : 'https://mirrors.xtom.de/postgresql/repos/yum/common/pgdg-rocky9-sysupdates/redhat/rhel-9-x86_64/' }}
- { name: pgdg15 ,description: 'PostgreSQL 15' ,module: pgsql ,releases: [7 ] ,baseurl : { default: 'https://download.postgresql.org/pub/repos/yum/15/redhat/rhel-$releasever-$basearch' ,china: 'https://mirrors.tuna.tsinghua.edu.cn/postgresql/repos/yum/15/redhat/rhel-$releasever-$basearch' ,europe : 'https://mirrors.xtom.de/postgresql/repos/yum/15/redhat/rhel-$releasever-$basearch' }}
- { name: pgdg16 ,description: 'PostgreSQL 16' ,module: pgsql ,releases: [ 8,9] ,baseurl : { default: 'https://download.postgresql.org/pub/repos/yum/16/redhat/rhel-$releasever-$basearch' ,china: 'https://mirrors.tuna.tsinghua.edu.cn/postgresql/repos/yum/16/redhat/rhel-$releasever-$basearch' ,europe : 'https://mirrors.xtom.de/postgresql/repos/yum/16/redhat/rhel-$releasever-$basearch' }}
- { name: timescaledb ,description: 'TimescaleDB' ,module: pgsql ,releases: [7,8,9] ,baseurl : { default : 'https://packagecloud.io/timescale/timescaledb/el/$releasever/$basearch' }}
在 Pigsty 配置文件中显式定义并覆盖 repo_upstream
后,(可清除 /www/pigsty/repo_complete
标记后)再次尝试安装。如果上游软件源与镜像源的软件没有解决问题,你可以考虑将上面的源替换为操作系统自带的软件源,再次尝试从上游直接安装。
最后如果以上手段都没有解决问题,你可以考虑移除 node_packages
, infra_packages
, pg_packages
,pg_extensions
中出现冲突的软件包。或者移除、升级现有系统上的冲突软件包。
准备 / bootstrap 过程是干什么的?
检测环境是否就绪、用各种手段确保后续安装所必需的工具 ansible
被正确安装。
当你下载 Pigsty 源码后,可以进入目录并执行 bootstrap
脚本。它会检测你的节点环境,如果没有发现离线软件包,它会询问你要不要从互联网下载。
你可以选择 “是”(y
),直接使用离线软件包安装又快又稳定。你也可以选“否” (n
) 跳过,在安装时直接从互联网上游下载最新的软件包,这样会极大减少出现 RPM/DEB 包冲突的概率。
如果使用了离线软件包,bootstrap 会直接从离线软件包中安装 ansible,否则会从上游下载 ansible 并安装,如果你没有互联网访问,又没有 DVD,或者内网软件源,那就只能用离线软件包来安装了。
配置 / configure 过程会检测你的节点环境并为你生成一个 pigsty 配置文件:pigsty.yml
,默认根据你的操作系统(EL 7/8/9)选用相应的单机安装模板。
所有默认的配置模板都在 files/pigsty
中,你可以使用 -c
直接指定想要使用的配置模板。如果您已经知道如何配置 Pigsty 了,那么完全可以跳过这一步,直接编辑 Pigsty 配置文件。
Pigsty配置文件是干什么的?
Pigsty主目录下的 pigsty.yml
是默认的配置文件,可以用来描述整套部署的环境,在 conf/
目录中有许多配置示例供你参考。在 文档站:配置模板 中相关说明。
当执行剧本时,你可以使用 -i <path>
参数,选用其他位置的配置文件。例如,你想根据另一个专门的配置文件 redis.yml
来安装 redis,可以这样做:./redis.yml -i files/pigsty/redis.yml
如何使用 CMDB 作为配置清单?
Ansible 默认使用的配置清单在 ansible.cfg
中指定为:inventory = pigsty.yml
你可以使用 bin/inventory_cmdb
切换到动态的 CMDB 清单,
使用 bin/inventory_conf
返回到本地配置文件。
你还需要使用 bin/inventory_load
将当前的配置文件清单加载到 CMDB。
如果使用 CMDB,你必须从数据库而不是配置文件中编辑清单配置,这种方式适合将 Pigsty 与外部系统相集成。
配置文件中的IP地址占位符是干什么的?
Pigsty 使用 10.10.10.10
作为当前节点 IP 的占位符,配置过程中会用当前节点的主 IP 地址替换它。
当 configure
检测到当前节点有多个 NIC 带有多个 IP 时,配置向导会提示使用哪个主要 IP,即 用户用于从内部网络访问节点的 IP ,此 IP 将用于在配置文件模板中替换占位符 10.10.10.10
。
请注意,您应当使用静态 IP 地址,而不是 DHCP 分配的动态 IP 地址,因为 Pigsty 使用静态 IPv4 地址唯一标识节点。
请注意:不要使用公共 IP 作为主 IP,因为 Pigsty 会使用主 IP 来配置内部服务,例如 Nginx,Prometheus,Grafana,Loki,AlertManager,Chronyd,DNSMasq 等,除了 Nginx 之外的服务不应该对外界暴露端口。
我没有静态IP,可以安装Pigsty吗?
如果您的服务器没有静态IP,在 单机部署 的情况下,可以使用本地环回地址 127.0.0.1
作为这个唯一节点的 IP 地址标识。
配置文件中的哪些参数需要用户特殊关注?
Pigsty 提供了 280+ 配置参数,可以对整个环境与各个模块 infra / node / etcd / minio / pgsql 进行细致入微的定制。
通常在单节点安装中,你不需要对默认生成的配置文件进行任何调整。但如果需要,可以关注以下这些参数:
当访问 web 服务组件时,域名由 infra_portal
指定,有些服务只能通过 Nginx 代理使用域名访问。
Pigsty 假定存在一个 /data
目录用于存放所有数据;如果数据磁盘的挂载点与此不同,你可以使用 node_data
调整这些路径。
进行生产部署时,不要忘记在配置文件中更改密码 ,更多细节请参考 安全考量 。
在默认单机安装时,到底都安装了什么东西?
当您执行 make install
时,实际上是调用 Ansible 剧本 install.yml
,根据配置文件中的参数,安装以下内容:
INFRA
模块:提供本地软件源,Nginx Web接入点,DNS服务器,NTP服务器,Prometheus与Grafana可观测性技术栈。
NODE
模块,将当前节点纳入 Pigsty 管理,部署 HAProxy 与 监控。
ETCD
模块,部署一个单机 etcd 集群,作为 PG 高可用的 DCS
MINIO
模块如果定义,则会安装,它可以作为 PG 的可选备份仓库。
PGSQL
模块,一个单机 PostgreSQL 数据库实例。
安装遇到软件包冲突怎么办?
在安装 node / infra / pgsql 软件包期间,可能有微小的几率出现软件包依赖错漏冲突。这里有几种常见原因:
上游软件源发布了不匹配的软件包版本或缺失了依赖,您可能要等待上游修复此问题,时间以周计。事先在依赖完备时制作的离线安装包可以预防这个问题。
您制作离线安装包操作系统小版本与当前操作系统的小版本不匹配,您可以使用在线安装,或重新使用相同系统下制作的离线软件包的方式解决此问题
个别不重要,非必选的软件包,可以直接将其从安装列表,或本地软件源中剔除的方式快速绕过。
如何重建本地软件仓库?
我想要从上游仓库重新下载软件包,但是执行 ./infra.yml
和 repo
子任务都跳过下载了,怎么办?
您可以使用以下快捷命令和剧本任务,强制重建本地软件源。 Pigsty 会重新检查上游仓库并下载软件包。
make repo-build # ./infra.yml -t repo_build
如何在安装后下载最新版本的软件包?
如果您想要下载最新的软件包版本(RPM/DEB),你可以选择在 /www/pigsty
中手工使用 apt/dnf
下载特定版本的软件包。
在这种情况下,您可以使用以下命令,只更新本地软件仓库的元数据库,而不是整个重建:
./infra.yml -t repo_create
或者移除 /www/pigsty
中的旧版本软件包后重新执行仓库重建命令:
make repo-build # ./infra.yml -t repo_build
如何使用 Vagrant 创建本地虚拟机?
当你第一次使用 Vagrant 启动某个特定的操作系统仓库时,它会下载相应的 Box/Img 镜像文件,Pigsty 沙箱默认使用 generic/rocky9
镜像。
使用代理可能会增加下载速度。Box/Image 只需下载一次,在重建沙箱时会被重复使用。
阿里云上 CentOS 7.9 特有的 RPM 冲突问题
阿里云的 CentOS 7.9 额外安装的 nscd
可能会导致 RPM 冲突问题:"Error: Package: nscd-2.17-307.el7.1.x86_64 (@base)"
遇见安装失败,RPM冲突报错不要慌,这是一个DNS缓存工具,把这个包卸载了就可以了:sudo yum remove nscd
,或者使用 ansible 命令批量删除所有节点上的 nscd
:
ansible all -b -a 'yum remove -y nscd'
腾讯云上 Rocky 9.x 特有的 RPM 冲突问题
腾讯云的 Rocky 9.x 需要额外的 annobin
软件包才可以正常完成 Pigsty 安装。
遇见安装失败,RPM冲突报错不要慌,进入 /www/pigsty
把这几个包手动下载下来就好了。
./infra.yml -t repo_upstream # add upstream repos
cd /www/pigsty; # download missing packages
repotrack annobin gcc-plugin-annobin libuser
./infra.yml -t repo_create # create repo
Ansible命令超时(Timeout waiting for xxx)
Ansible 命令的默认 ssh 超时时间是10秒。由于网络延迟或其他原因,某些命令可能需要超过这个时间。
你可以在 ansible 配置文件 ansible.cfg
中增加超时参数:
[defaults]
timeout = 10 # 将其修改为 60,120 或更高。
如果你的SSH连接非常慢,通常会是 DNS的问题,请检查sshd配置确保 UseDNS no
。
2 - 关于Pigsty
了解 Pigsty 项目本身的方方面面:功能特性、历史发展,开源协议,隐私政策,社区活动与新闻。
2.1 - 亮点特性
Pigsty 的价值主张与亮点功能特性。
“P ostgreSQL I n G reat STY le”: P ostgres, I nfras, G raphics, S ervice, T oolbox, it’s all Y ours.
—— 开箱即用、本地优先的 PostgreSQL 发行版,开源 RDS 替代
价值主张
总览
Pigsty 是一个更好的本地开源 RDS for PostgreSQL 替代:
开箱即用的RDS :从内核到RDS发行版,在 EL/Debian/Ubuntu 下提供 12-17 版本的生产级 PG 数据库服务。
丰富的扩展插件 :提供无可比拟的 340+ 扩展,提供开箱即用的分布式的时序地理空间图文向量多模态数据库能力。
灵活的模块架构 :灵活组合,自由扩展:Redis/Etcd/MinIO/Mongo;可独立使用,监控现有RDS/主机/数据库。
惊艳的观测能力 :基于现代可观测性技术栈 Prometheus/Grafana,提供令人惊艳,无可比拟的数据库观测能力。
验证过的可靠性 :故障自愈的高可用架构:硬件故障自动切换,流量无缝衔接。并提供自动配置的 PITR 兜底删库!
简单易用可维护 :声明式API,GitOps就位,傻瓜式操作,Database/Infra-as-Code 以及管理SOP封装管理复杂度!
扎实的安全实践 :加密备份一应俱全,自带基础ACL最佳实践。只要硬件与密钥安全,您无需操心数据库的安全性!
广泛的应用场景 :低代码数据应用开发,或使用预置的 Docker Compose 模板,一键拉起使用PostgreSQL的海量软件!
开源的自由软件 :以云数据库1/10不到的成本拥有与更好的数据库服务!帮您真正“拥有”自己的数据,实现自主可控!
PostgreSQL 整合了生态中的工具与最佳实践:
开箱即用的 PostgreSQL 发行版,深度整合地理、时序、分布式、图、向量、搜索、AI等 340 余个扩展插件 !
运行于裸操作系统之上,无需容器支持,支持主流操作系统: EL7/8/9, Ubuntu 20.04/22.04/24.04 以及 Debian 11/12。
基于 patroni , haproxy , 与etcd ,打造故障自愈的高可用架构:硬件故障自动切换,流量无缝衔接。
基于 pgBackRest 与可选的 MinIO 集群提供开箱即用的 PITR 时间点恢复,为软件缺陷与人为删库兜底。
基于 Ansible 提供声明式的 API 对复杂度进行抽象,以 Database-as-Code 的方式极大简化了日常运维管理操作。
Pigsty用途广泛,可用作完整应用运行时,开发演示数据/可视化应用,大量使用 PG 的软件可用 Docker 模板一键拉起。
提供基于 Vagrant 的本地开发测试沙箱环境,与基于 Terraform 的云端自动部署方案,开发测试生产保持环境一致。
部署并监控专用的 Redis (主从,哨兵,集群),MinIO,Etcd,Haproxy,MongoDB (FerretDB ) 集群
开箱即用的RDS
让您立刻在本地拥有生产级的PostgreSQL数据库服务!
PostgreSQL 是一个足够完美的数据库内核,但它需要更多工具与系统的配合才能成为一个足够好的数据库服务(RDS),Pigsty 帮助 PostgreSQL 完成这一步飞跃。
Pigsty 为您解决使用 PostgreSQL 中会遇到的各种难题:内核扩展安装,连接池,负载均衡,服务接入,高可用 / 自动故障切换,日志收集,指标监控,告警,备份恢复,PITR,访问控制,参数调优,安全加密,证书签发,NTP,DNS,参数调优,配置管理,CMDB,管理预案… 您无需再为这些细节烦心劳神!
Pigsty 支持 PostgreSQL 12 ~ 17 主干内核与其他兼容分支,可运行于 EL / Debian / Ubuntu 以及 兼容操作系统发行版 上,在 x86_64 与 ARM64 芯片架构上可用,且无需容器支持。
除了数据库内核与大量开箱即用的扩展插件以外,Pigsty 还提供了数据库服务所需的完整基础设施与运行时,以及本地沙箱 / 生产环境 / 云 IaaS 自动部署方案。
Pigsty 可以一键从裸机开始拉起整套环境,触达软件交付的最后一公里。普通研发运维均可快速上手并兼职进行数据库管理,无需数据库专家即可自建企业级RDS服务!
丰富的扩展插件
超融合多模态,一切皆用 PostgreSQL,一个PG替换所有数据库!
PostgreSQL 的灵魂在于其丰富的 扩展生态 ,而 Pigsty 独一无二地深度整合了 PostgreSQL 生态中的 340+ 扩展 ,为您提供开箱即用的超融合多模态数据库!
插件间可以产生协同效应 ,产生 1+1 远大于 2 的效果。
您可以使用 PostGIS 处理地理空间数据,使用 TimescaleDB 分析时序/事件流数据,并使用 Citus 将其原地升级为分布式地理时空数据库;
您可以用 PGVector 存储并搜索AI嵌入,用 ParadeDB 实现 ES级全文检索,并同时使用精准的 SQL,全文检索,与模糊向量进行混合检索。
您还可以通过 Hydra 、 duckdb_fdw 、pg_analytics 、pg_duckdb 等分析扩展,实现专用 OLAP 数据库/数据湖仓的分析表现。
使用 PostgreSQL 单一组件替代 MySQL,Kafka,ElasticSearch,MongoDB,以及大数据分析技术栈已经成为一种最佳实践 —— 单一数据库选型能够显著降低系统复杂度,极大提高研发效能与敏捷性,实现程度惊人的软硬件,研发/运维人力降本增效。
灵活的模块架构
灵活组合,自由扩展,多数据库支持,监控现有RDS/主机/数据库
Pigsty 中的组件被抽象可独立部署的 模块 ,并可自由组合以应对多变的需求场景。INFRA
模块带有完整的现代监控技术栈,而 NODE
模块则将节点调谐至指定状态并纳管。
在多个节点上安装 PGSQL
模块会自动组建出基于主从复制的高可用数据库集群,而同样的 ETCD
模块则为数据库高可用提供共识与元数据存储。
除了上述四个 核心模块 之外,Pigsty 还提供一系列选装功能模块:MINIO
模块可以提供本地对象存储能力,并作为集中式数据库备份仓库。
REDIS
模块能以独立主从,哨兵,原生集群的方式为数据库提供辅助。DOCKER
模块可用于拉起无状态的应用软件。
此外,Pigsty 还提供 PG 兼容 / 衍生内核的支持,您可以使用 Babelfish
提供 MS SQL Server 兼容性,使用 IvorySQL
提供 Oracle 兼容性,
使用 FerretDB
提供 MongoDB 兼容性,使用 Supabase
提供 Firebase 兼容,并使用 PolarDB
满足国产化合规要求。
更多专业版/试点模块将不断引入 Pigsty,如 GPSQL
,KAFKA ,DUCKDB ,VICTORIA ,TIGERBEETLE ,KUBERNETES ,CONSUL ,JUPYTER ,GREENPLUM ,CLOUDBERRY ,MYSQL , …
惊艳的观测能力
使用现代开源可观测性技术栈,提供无与伦比的监控最佳实践!
Pigsty 提供了基于开源的 Grafana / Prometheus 现代可观测性技术栈做 监控 的最佳实践:Prometheus 用于收集监控指标,Grafana 负责可视化呈现,Loki 用于日志收集与查询,Alertmanager 用于告警通知。 PushGateway 用于批处理任务监控,Blackbox Exporter 负责检查服务可用性。整套系统同样被设计为一键拉起,开箱即用的 INFRA 模块。
Pigsty 所管理的任何组件都会被自动纳入监控之中,包括主机节点,负载均衡 HAProxy,数据库 Postgres,连接池 Pgbouncer,元数据库 ETCD,KV缓存 Redis,对象存储 MinIO,……,以及整套监控基础设施本身。大量的 Grafana 监控面板与预置告警规则会让你的系统观测能力有质的提升,当然,这套系统也可以被复用于您的应用监控基础设施,或者监控已有的数据库实例或 RDS。
无论是故障分析还是慢查询优化、无论是水位评估还是资源规划,Pigsty 为您提供全面的数据支撑,真正做到数据驱动。在 Pigsty 中,超过三千类监控指标被用于描述整个系统的方方面面,并被进一步加工、聚合、处理、分析、提炼并以符合直觉的可视化模式呈现在您的面前。从全局大盘总览,到某个数据库实例中单个对象(表,索引,函数)的增删改查详情都能一览无余。您可以随意上卷下钻横向跳转,浏览系统现状与历史趋势,并预测未来的演变。
此外,Pigsty的监控系统模块部分还可以 独立使用 ——用它来监控现有的主机节点与数据库实例,或者是云上的 RDS 服务。只需要一个连接串一行命令,您就可以获得极致的 PostgreSQL 可观测性体验。
访问 截图画廊 与 在线演示 获取更多详情。
验证过的可靠性
开箱即用的高可用与时间点恢复能力,确保你的数据库坚如磐石!
对于软件缺陷或人为误操作造成的删表删库,Pigsty 提供了开箱即用的 PITR 时间点恢复能力,无需额外配置即默认启用。只要存储空间管够,基于 pgBackRest
的基础备份与 WAL 归档让您拥有快速回到过去任意时间点的能力。您可以使用本地目录/磁盘,亦或专用的 MinIO 集群或 S3 对象存储服务保留更长的回溯期限,丰俭由人。
更重要的是,Pigsty 让高可用与故障自愈成为 PostgreSQL 集群的标配,基于 patroni
, etcd
, 与 haproxy
打造的 高可用故障自愈架构 ,让您在面对硬件故障时游刃有余:主库故障自动切换的 RTO < 30s(可配置),一致性优先模式下确保数据零损失 RPO = 0。只要集群中有任意实例存活,集群就可以对外提供完整的服务,而客户端只要连接至集群中的任意节点,即可获得完整的服务。
Pigsty 内置了 HAProxy 负载均衡器用于自动流量切换,提供 DNS/VIP/LVS 等多种接入方式供客户端选用。故障切换与主动切换对业务侧除零星闪断外几乎无感知,应用不需要修改连接串重启。极小的维护窗口需求带来了极大的灵活便利:您完全可以在无需应用配合的情况下滚动维护升级整个集群。硬件故障可以等到第二天再抽空善后处置的特性,让研发,运维与 DBA 都能安心睡个好觉。
许多大型组织与核心机构已经在生产环境中长时间使用 Pigsty ,最大的部署有 25K CPU 核心与 200+ PostgreSQL 超大规格实例;在这一部署案例中,四年内经历了数十次硬件故障与各类事故,但依然可以保持比 99.999% 更高的可用性战绩。
简单易用可维护
Infra as Code, 数据库即代码,声明式的API将数据库管理的复杂度来封装。
Pigsty 使用声明式的接口对外提供服务,将系统的可控制性拔高到一个全新水平:用户通过配置清单告诉 Pigsty “我想要什么样的数据库集群”,而不用去操心到底需要怎样去做。从效果上讲,这类似于 K8S 中的 CRD 与 Operator,但 Pigsty 可用于任何节点上的数据库与基础设施:不论是容器,虚拟机,还是物理机。
无论是创建/销毁集群,添加/移除从库,还是新增数据库/用户/服务/扩展/黑白名单规则,您只需要修改配置清单并运行 Pigsty 提供的幂等剧本,而 Pigsty 负责将系统调整到您期望的状态。
用户无需操心配置的细节,Pigsty将自动根据机器的硬件配置进行调优,您只需要关心诸如集群叫什么名字,有几个实例放在哪几台机器上,使用什么配置模版:事务/分析/核心/微型,这些基础信息,研发也可以自助服务。但如果您愿意跳入兔子洞中,Pigsty 也提供了丰富且精细的控制参数,满足最龟毛 DBA 的苛刻定制需求。
除此之外,Pigsty 本身的安装部署也是一键傻瓜式的,所有依赖被预先打包,在安装时可以无需互联网访问。而安装所需的机器资源,也可以通过 Vagrant 或 Terraform 模板自动获取,让您在十几分钟内就可以从零在本地笔记本或云端虚拟机上拉起一套完整的 Pigsty 部署。本地沙箱环境可以跑在1核2G的微型虚拟机中,提供与生产环境完全一致的功能模拟,可以用于开发、测试、演示与学习。
扎实的安全实践
加密备份一应俱全,只要硬件与密钥安全,您无需操心数据库的安全性。
Pigsty 针对高标准,严要求的企业级场景设计,采用业界领先的 安全最佳实践 保护您的数据安全(机密性/完整性/可用性),默认配置下的安全性便足以满足绝大多数场景下的合规要求。
Pigsty 会创建自签名的 CA (或使用您提供的 CA)签发证书,加密网络通信。需要保护的敏感管理页面与API端点都受到密码保护。
数据库备份使用 AES 算法加密,数据库密码使用 scram-sha-256 算法加密,并提供插件强制执行密码强度策略。
Pigsty 提供了一套开箱即用,简单易用,便于扩展的 ACL 模型,提供读/写/管理/ETL 的权限区分,并带有遵循最小权限原则的 HBA 规则集,通过多重防护确保系统机密性。
Pigsty 默认启用数据库校验和避免静默数据腐坏,通过从库副本提供坏块兜底。提供 CRIT 数据零丢失配置模板,使用 watchdog 确保为高可用 Fencing 兜底。您可以通过 audit 插件审计数据库操作,系统与数据库日志全部收集备查,以满足合规要求。
合理配置的系统通过等保三级毫无问题,只要您遵循安全性最佳实践,内网部署并合理配置安全组与防火墙,数据库安全性将不再是您的痛点。
广泛的应用场景
使用预置的Docker模板,一键拉起使用PostgreSQL的海量软件!
在各类数据密集型应用中,数据库往往是最为棘手的部分。例如 Gitlab 企业版与社区版的核心区别就是底层 PostgreSQL 数据库的监控与高可用,如果您已经有了足够好的本地 PG RDS,完全可以拒绝为软件自带的土法手造数据库组件买单。
Pigsty 提供了 Docker 模块与大量开箱即用的 Compose 模板。您可以使用 Pigsty 管理的高可用 PostgreSQL (以及 Redis 与 MinIO )作为后端存储,以无状态的模式一键拉起这些软件: Gitlab、Gitea、Wiki.js、NocoDB、Odoo、Jira、Confluence、Habour、Mastodon、Discourse、KeyCloak 等等。如果您的应用需要一个靠谱的 PostgreSQL 数据库, Pigsty 也许是最简单的获取方案。
Pigsty 也提供了与 PostgreSQL 紧密联系的应用开发工具集:PGAdmin4、PGWeb、ByteBase、PostgREST、Kong、以及 EdgeDB、FerretDB、Supabase 这些使用 PostgreSQL 作为存储的"上层数据库"。更奇妙的是,您完全可以基于 Pigsty 内置了的 Grafana 与 Postgres ,以低代码的方式快速搭建起一个交互式的数据应用来,甚至还可以使用 Pigsty 内置的 ECharts 面板创造更有表现力的交互可视化作品。
开源的自由软件
Pigsty是基于 AGPLv3 开源的自由软件,由热爱 PostgreSQL 的社区成员用热情浇灌
Pigsty 是完全 开源免费 的自由软件,它允许您在缺乏数据库专家的情况下,用几乎接近纯硬件的成本来运行企业级的 PostgreSQL 数据库服务。
作为对比,数据库厂商的“企业级数据库服务”与公有云厂商提供的 RDS 会收取底层硬件资源几倍到十几倍不等的 溢价 作为 “服务费”。
很多用户选择上云,正是因为自己搞不定数据库;很多用户使用 RDS,是因为别无他选。
我们将打破云厂商的垄断,为用户提供一个云中立的,更好的 RDS 开源替代:
Pigsty 紧跟 PostgreSQL 上游主干,不会有供应商锁定,不会有恼人的 “授权费”,不会有节点数量限制,不会收集您的任何数据。
您的所有的核心资产 —— 数据,都能"自主可控",掌握在自己手中。
Pigsty 本身旨在用数据库自动驾驶软件,替代大量无趣的人肉数据库运维工作,但再好的软件也没法解决所有的问题。
总会有一些的冷门低频疑难杂症需要专家介入处理。这也是为什么我们也提供专业的 订阅服务 ,来为有需要的企业级用户使用 PostgreSQL 提供兜底。
几万块的订阅咨询费不到顶尖 DBA 每年工资的几十分之一,让您彻底免除后顾之忧,把成本真正花在刀刃上。对于社区用户,我们亦用爱发电 ,提供免费的支持与日常答疑。
2.2 - 模块列表
本文列出了 Pigsty 中可用的功能模块,以及后续的功能模块规划。
核心模块
Pigsty 提供了四个 基础 功能模块,对于提供完整高可用的 PostgreSQL 服务必不可少:
PGSQL
:带有高可用,时间点恢复,IaC,SOP,监控系统,以及 340 个扩展插件的自治的 PostgreSQL 集群。
INFRA
:本地软件仓库、Prometheus、Grafana、Loki、AlertManager、PushGateway、Blackbox Exporter…
NODE
:调整节点到所需状态、名称、时区、NTP、ssh、sudo、haproxy、docker、promtail、keepalived
ETCD
:分布式键值存储,用作高可用 Postgres 集群的 DCS:共识选主/配置管理/服务发现。
内核模块
Pigsty 提供了四个 内核 功能模块 ,它们是 PostgreSQL 内核的可选原位替代,提供不同风味的数据库能力。
MSSQL
:微软 SQL Server 线缆协议兼容的 PG 内核,由 AWS, WiltonDB & Babelfish 出品!
IVORY
:Oracle 兼容的 PostgreSQL 16 内核,由瀚高开源的 IvorySQL 项目提供。
POLAR
: 由阿里云开源的“云原生” PostgreSQL 内核,Aurora 风味的 RAC PostgreSQL Fork。
CITUS
:使用扩展实现分布式PostgreSQL集群(Azure Hyperscale),带有原生的 Patroni 高可用支持!
国产化内核支持!
Pigsty
专业版 提供国产化数据库内核支持:
PolarDB-O v2 —— 基于 PolarPG 的 Oracle 兼容的国产化数据库内核
扩展模块
Pigsty 提供了四个 扩展 功能模块,它对于核心功能来说并非必须,但可以用于增强 PostgreSQL 的能力:
MINIO
:S3 兼容的简单对象存储服务器,可作为可选的 PostgreSQL 数据库备份仓库,带有生产部署支持与监控。
REDIS
:Redis 服务器,高性能数据结构服务器,支持独立主从、哨兵、集群模式生产部署,并带有完善的监控支持。
MONGO
:FerertDB 原生部署支持 —— 它为 PostgreSQL 添加了 MongoDB 线缆协议级别的 API 兼容支持!
DOCKER
:Docker Daemon 服务,允许用户一键拉起容器化的无状态软件工具模板,为 Pigsty 加装各种功能!
外围模块
Pigsty 同时支持那些与 PostgreSQL 内核带有紧密联系的 外围 模块(扩展,分支,衍生,包装):
DUCKDB
:强大的嵌入式OLAP数据库,Pigsty提供二进制/动态库及相关PG扩展:pg_duckdb
,pg_lakehouse
与duckdb_fdw
SUPABASE
: Pigsty 允许用户在现有高可用 PostgreSQL 集群基础上,运行火爆的 Firebase 开源替代 —— Supabase !
GREENPLUM
:基于 PostgreSQL 12 内核的 MPP 数据仓库,目前仅提供监控支持与 RPM 安装支持。(Beta )
CLOUDBERRY
:Greenplum 闭源后原班开发者打造的开源分支,基于 PG 14 内核,目前仅提供RPM安装支持。(Beta )
NEON
:带有数据库分支功能特性的的无服务器 PostgreSQL 内核 (WIP )
试点模块
Pigsty 正在支持一些与 PostgreSQL 生态相关的 试点 模块 试点模块,它们可能会在未来成为 Pigsty 的正式模块:
KAFKA
:使用 Pigsty 部署由 KRaft 驱动的 Kafka 消息队列,并提供开箱即用的监控支持 (Beta )
MYSQL
:使用 Pigsty 部署高可用的 MySQL 8.0 集群,并提供开箱即用的监控支持(供批判/迁移评估之用) (Beta )
KUBE
:使用 SealOS 搭建开箱即用的生产级 Kubernetes 部署与监控支持 (Alpha ).
VICTORIA
:基于 VictoriaMetrics 与 VictoriaLogs 的 Infra 替代选项,提供更好的性能与资源利用率(Alpha )
JUPYTER
:开箱即用的 Jupyter Notebook 环境,用于数据分析与机器学习等场景(Alpha )
监控其他数据库
Pigsty 的 INFRA
模块可以独立使用,作为开箱即用的监控基础设施,监控其他节点或现有 PostgreSQL 数据库
现有 PostgreSQL 服务:Pigsty 可以监控外部的、非 Pigsty 托管的 PostgreSQL 服务,并仍可提供相对完整的监控支持。
RDS PG
:是云厂商提供的 PostgreSQL RDS 服务,将其视作标准的外部 Postgres 实例即可纳入监控
PolarDB
:是阿里云的云原生数据库,将其视作外部 PostgreSQL 11 / 14 实例即可纳入监控。
KingBase
: 是人大金仓提供的信创国产数据库,视作外部 PostgreSQL 12 实例即可纳入监控。
Greenplum
/ YMatrixDB
监控,目前将其视作水平分片的 PostgreSQL 集群即可纳入监控。
2.3 - 发展规划
未来功能的规划,新功能的发布节奏,待办事项列表。
版本发布策略
Pigsty 使用语义化版本号,例如:<主版本>.<次版本>.<修订号>
。Alpha / Beta / RC 版本会在版本号后添加后缀与标号,如 -a1
, -b1
, -c1
。
主版本更新意味着基础性变化和大量新特性;次版本更新通常表示新特性,软件包版本更新和较小的API变动,修订版本更新意味着修复bug和文档更新。
Pigsty 计划每年发布一次主版本更新,次版本更新通常跟随 PostgreSQL 小版本更新节奏,在 PostgreSQL 新版本发布后最迟一个月内跟进,通常每年 4 - 6 个小版本,完整发布历史请参考 发行注记 。
不要用 main 主干分支部署
Pigsty 使用
main
主干分支进行开发,请始终使用特定版本的
发行版 。除非您知道自己在做什么,否则不要使用GitHub的
main
分支。
列入考虑的新特性
这里是我们的 活跃议题 与 路线图 。
扩展插件与软件包
关于扩展支持的路线图,可以在这里找到:https://ext.pigsty.io/#/roadmap
考虑纳入
暂不考虑
2.4 - 历史沿革
Pigsty 项目的由来与动机,过去发展的历史,未来的目标与愿景。
历史起源
Pigsty 项目始于 2018 ~ 2019 年,起源于 探探 。
探探是一个互联网交友 App —— 中国的 Tinder,现已被陌陌收购。
探探这家公司是一个北欧 Style 的创业公司,有着一个瑞典工程师初创团队。
探探在技术上极有品味,使用 PostgreSQL 与 Go 作为核心技术栈。
探探整个系统架构参照了 Instagram ,一切围绕 PostgreSQL 数据库设计。
直到几百万日活,几百万 TPS,几百 TB 数据的量级下,数据组件 只用了 PostgreSQL 。
几乎所有的业务逻辑都使用 PG 存储过程实现 —— 甚至包括 100ms 的推荐算法!
探探这种深度使用 PostgreSQL 特性的非典型研发模式,对工程师与DBA的水平提出了极高的要求。
而 Pigsty ,就是我们用这种真实世界的大规模,高标准数据库集群场景打磨出的开源项目 ——
沉淀着我们作为顶尖 PostgreSQL 专家的经验与最佳实践。
发展过程
在最开始,Pigsty 并没有现在这样的愿景、目标与版图。而是旨在提供一个供我们自己使用的 PostgreSQL 监控系统。
我们调研了市面上所有的方案,开源的、商业的、云的,datadog, pgwatch,…… ,没有一个能满足我们对于可观测性的需求。
因此我们决定亲自动手,基于 Grafana 与 Prometheus 自己动手打造一个,这就是 Pigsty 的前身与雏形。
Pigsty 作为监控系统的效果相当惊艳,帮助我们解决了无数管理问题。
随后,研发人员希望在本地的开发机上也有这样的监控系统,于是我们使用 Ansible 编写了置备剧本,将这套系统从一次性建设任务转变为了可重复使用,可复制的软件。
新的功能允许用户使用 Vagrant 和 Terraform,用 Infra as Code 的方式快速拉起本地 DevBox 开发机,或生产环境服务器,并自动完成 PostgreSQL 与监控系统的部署。
接下来,我们重新设计了生产环境的 PostgreSQL 架构,引入了 Patroni 与 pgBackRest 解决了数据库的 高可用 与 时间点恢复 问题。
开发了基于逻辑复制的不停机 迁移 方案,通过蓝绿部署将生产环境两百套数据库集群滚动升级至最新大版本。并将这些能力引入 Pigsty 中。
Pigsty 是我们做给自己使用的软件,我们自己作为甲方用户,非常清楚自己需要什么,也不会在自己的需求上偷懒。
“Eat dog food”最大的好处就是,我们自己既是开发者也更是用户 —— 因此非常了解自己需要什么,也不会在自己的需求上偷懒。
我们解决了一个又一个的问题,并将解决方案沉淀到 Pigsty 里。Pigsty 的定位,也从一个监控系统,逐渐发展成为一个开箱即用的 PostgreSQL 数据库发行版。
因此在这一阶段,我们决定将 Pigsty 对外开源,并开始了一系列的技术分享与宣传,也开始有各行各业的外部用户使用起 Pigsty 并提出反馈意见。
全职创业
在 2022 年,Pigsty 项目获得了由陆奇博士发起的奇绩创坛的种子轮投资,我得以全职出来做这件事情。
作为一个开源项目,Pigsty 的发展相当不赖,在全职创业这两年里,Pigsty 在 Github 上的 Star 数从的 几百翻了几番到了 3400;上了 HN 头条推荐,增长开始滚起雪球;
在 OSSRank 开源榜单 中,Pigsty 在 PostgreSQL 生态项目中排名第 37 名,在中国人主导的项目里是最靠前的。
从前 Pigsty 只能跑在 CentOS 7 上,现今已经基本覆盖了所有主流 Linux 发行版 (EL, Debian, Ubuntu)。支持的 PG 大版本覆盖 12 - 17,维护,收录整合了PG生态中的 340+ 扩展插件。
其中,我本人维护了这里超过一半的扩展插件,并提供开箱即用的 RPM/DEB 包,算上 Pigsty 本身,“基于开源,回馈开源”,算是为 PG 生态做一些贡献。
Pigsty 的定位,也在不断发展的过程中,从一个 PostgreSQL 数据库发行版,进一步扩展到了 开源云数据库替代 。它真正对标的是云厂商的整个云数据库品牌。
公有云的反叛者
AWS、Azure、GCP、Aliyun 等公有云厂商为初创企业提供了许多便利,但它们是闭源的,并迫使用户以高额费用租赁基础资源。
我们认为,优秀的数据库服务,应该和优秀的数据库内核一样,普及到每一个用户手中,而不是必须花费高昂的代价去向赛博领主租赁。
云计算的敏捷与弹性都很好,但它应该是自由、开源、普惠、本地优先的 ——
我们认为云计算宇宙中需要一个代表开源价值观的解决方案,在不牺牲云带来好处的前提下,将基础设施的控制权交还给用户。
因此,我们也在引领着一场 下云的运动与战役 ,作为公有云的反叛者,来重塑这个行业的价值观。
我们的愿景
我希望,未来的世界人人都有自由使用优秀服务的事实权利,而不是只能被圈养在几个赛博领主公有云巨头厂商的地盘上当赛博佃户甚至赛博农奴。
这正是 Pigsty要做的事 —— 一个更好的,开源免费的RDS替代 。让用户能够在任何地方(包括云服务器)上,一键拉起有比云RDS更好的数据库服务。
Pigsty 是是对 PostgreSQL 的彻底补完,更是对云数据库的辛辣嘲讽 。它本意是“猪圈”,但更是 Postgres In Great STYle 的缩写,即“全盛状态下的 PostgreSQL ”。
Pigsty 本身是一款完全开源免费的软件,我们纯粹靠提供 咨询与服务 来维持运营
建设良好的系统也许跑个几年都不会遇到需要 ”兜底“ 的问题,但数据库的问题一但出现就不是小问题。
很多时候,专家的经验更是能够一言化腐朽为神奇,而我们为有需求的客户提供这样的服务 —— 我们认为这是一种更加公正、合理、可持续的模式。
关于团队
我是冯若航,Pigsty 的作者,Pigsty 绝大部分的代码由我 一人开发 ,个别特性由社区贡献。
软件领域依然存在个人英雄主义,独一无二的个体才能够创造出独一无二的作品来 —— 我希望 Pigsty 能够成为这样的作品。
如果您对我感兴趣,这里是我的个人主页:https://vonng.com/
《墨天轮风云人物访谈录 —— 冯若航 》
《90后,辞职创业,说要卷死云数据库 》
2.5 - 活动新闻
与 Pigsty 和 PostgreSQL 相关的活动事件与新闻,以及最新活动预告!
最近新闻
Pigsty 3.1.0 发布,提供完整的 PostgreSQL 17.2 扩展支持
Pigsty 3.0.4 发布! 提供扩展目录与仓库,编译 PG17扩展,自建Supabase流程优化
Pigsty 3.0.3 发布! 提供正式的 PostgreSQL 17 支持,优化 Etcd 运维与监控
Pigsty 3.0.2 发布! 精简安装模式,PolarDB 15 支持,例行问题修复(2024-09-07)
Pigsty 3.0.1 发布!Oracle 兼容性,Patroni 4 支持,例行问题修复 (2024-08-31)
Pigsty 3.0.0 发布!333 个扩展,可替换内核,完整RDS服务!
新闻:Pigsty提供的Yum/APT补充软件仓库,提供254个额外的开箱即用的二进制RPM/DEB扩展!
PGCon.Dev 2024 参会记!
Pigsty v2.7 发布!
Pigsty v2.6 发布!
The name of this project always makes me grin: PIGSTY is actually an acronym, standing for Postgres In Great STYle! It’s a Postgres distribution that includes lots of components and tools out of the box in areas like availability, deployment, and observability. The latest release pushes everything up to Postgres 16.2 standards and introduces new ParadeDB and DuckDB FDW extensions.
这个项目的名字总能让我笑开花:PIGSTY 实际上是一个首字母缩略词,代表 Postgres In Great STYle!它是一个 Postgres 发行版,包括了大量的组件和工具,涵盖了可用性、部署和可观测性等领域。最新版本将所有内容推进到了 Postgres 16.2,并引入了新的 ParadeDB 和 DuckDB FDW 扩展。
版本发布
Pigsty 发布注记
版本
发布时间
摘要
地址
v3.1.0
2024-11-22
PG 17 作为默认大版本,配置简化,Ubuntu 24 与 ARM 支持,MinIO 改进
v3.1.0
v3.0.4
2024-10-30
PG 17 扩展,OLAP 全家桶,pg_duckdb
v3.0.4
v3.0.3
2024-09-27
PostgreSQL 17,Etcd 运维优化,IvorySQL 3.4,PostGIS 3.5
v3.0.3
v3.0.2
2024-09-07
精简安装模式,PolarDB 15支持,监控视图更新
v3.0.2
v3.0.1
2024-08-31
例行问题修复,Patroni 4支持,Oracle兼容性改进
v3.0.1
v3.0.0
2024-08-25
333个扩展插件,可插拔内核,MSSQL,Oracle,PolarDB 兼容性
v3.0.0
v2.7.0
2024-05-20
扩展大爆炸,新增20+强力扩展插件,与多款Docker应用
v2.7.0
v2.6.0
2024-02-28
PG 16 作为默认大版本,引入 ParadeDB 与 DuckDB 等扩展
v2.6.0
v2.5.1
2023-12-01
例行小版本更新,PG16重要扩展支持
v2.5.1
v2.5.0
2023-09-24
Ubuntu/Debian支持:bullseye, bookworm, jammy, focal
v2.5.0
v2.4.1
2023-09-24
Supabase/PostgresML支持与各种新扩展:graphql, jwt, pg_net, vault
v2.4.1
v2.4.0
2023-09-14
PG16,监控RDS,服务咨询支持,新扩展:中文分词全文检索/图/HTTP/嵌入等
v2.4.0
v2.3.1
2023-09-01
带HNSW的PGVector,PG 16 RC1, 文档翻新,中文文档,例行问题修复
v2.3.1
v2.3.0
2023-08-20
主机VIP, ferretdb, nocodb, MySQL存根, CVE修复
v2.3.0
v2.2.0
2023-08-04
仪表盘 & 置备重做,UOS 兼容性
v2.2.0
v2.1.0
2023-06-10
支持 PostgreSQL 12 ~ 16beta
v2.1.0
v2.0.2
2023-03-31
新增 pgvector 支持,修复 MinIO CVE
v2.0.2
v2.0.1
2023-03-21
v2 错误修复,安全增强,升级 Grafana 版本
v2.0.1
v2.0.0
2023-02-28
架构大升级,兼容性、安全性、可维护性显著增强
v2.0.0
v1.5.1
2022-06-18
Grafana 安全性修复
v1.5.1
v1.5.0
2022-05-31
Docker 应用程序支持
v1.5.0
v1.4.1
2022-04-20
错误修复 & 英文文档完整翻译
v1.4.1
v1.4.0
2022-03-31
MatrixDB 支持,分离 INFRA/NODES/PGSQL/REDIS模块
v1.4.0
v1.3.0
2021-11-30
PGCAT 重整 & PGSQL 增强 & Redis Beta支持
v1.3.0
v1.2.0
2021-11-03
默认 PGSQL 版本升级至 14
v1.2.0
v1.1.0
2021-10-12
主页, JupyterLab, PGWEB, Pev2 & pgbadger
v1.1.0
v1.0.0
2021-07-26
v1 正式版, 监控系统重整
v1.0.0
v0.9.0
2021-04-04
Pigsty 图形界面, 命令行界面, 日志集成
v0.9.0
v0.8.0
2021-03-28
服务置备,定制对外暴露的数据库服务
v0.8.0
v0.7.0
2021-03-01
仅监控部署,监控现有 PostgreSQL 实例
v0.7.0
v0.6.0
2021-02-19
架构增强,将PG与Consul解耦
v0.6.0
v0.5.0
2021-01-07
支持在配置中定义业务数据库/用户
v0.5.0
v0.4.0
2020-12-14
支持 PostgreSQL 13,添加官方文档
v0.4.0
v0.3.0
2020-10-22
虚拟机置备方案正式定稿
v0.3.0
v0.2.0
2020-07-10
PG监控系统第六版正式发布
v0.2.0
v0.1.0
2020-06-20
在生产仿真测试环境中验证通过
v0.1.0
v0.0.5
2020-08-19
离线安装模式:无需互联网访问即可交付
v0.0.5
v0.0.4
2020-07-27
将 Ansible 剧本重构为 Role Refactor playbooks into ansible roles
v0.0.4
v0.0.3
2020-06-22
接口设计改进
v0.0.3
v0.0.2
2020-04-30
首次提交
v0.0.2
v0.0.1
2019-05-15
概念原型
v0.0.1
会议与演讲
日期
类型
活动
主题
2023-12-20
直播辩论
开源漫谈第七期
上云 or 下云,割韭菜还是降本增效?
2023-11-24
技术大会
大模型时代的向量数据库
圆桌讨论:大模型时代向量数据库新未来
2023-09-08
人物专访
墨天轮风云人物访谈
冯若航:不想当段子手的技术狂,不是一位好的开源创始人
2023-08-16
技术大会
DTCC 2023
DBA之夜:PostgreSQL vs MySQL的开源协议问题
2023-08-09
直播辩论
开源漫谈第一期
MySQL vs PostgreSQL,谁是世界第一?
2023-07-01
技术大会
SACC 2023
专题研讨会8:FinOps实践:云成本管理与优化
2023-05-12
线下活动
PostgreSQL中国社区 温州站线下沙龙
PG With DB4AI: 向量数据库 PGVECTOR & AI4DB: 数据库自动驾驶 Pigsty
2023-04-08
技术大会
数据库嘉年华 2023
更好的开源RDS替代:Pigsty
2023-04-01
技术大会
PostgreSQL中国社区 西安站线下沙龙
PG高可用与容灾最佳实践
2023-03-23
公开直播
Bytebase x Pigsty
管理 PostgreSQL 的最佳实践: Bytebase x Pigsty
2023-03-04
技术大会
PostgreSQL中国技术大会
炮打 RDS,Pigsty v2.0 发布
2023-02-01
技术大会
DTCC 2022
开源 RDS 替代:开箱即用、自动驾驶的数据库发行版 Pigsty
2022-07-21
直播辩论
云吞噬开源,那开源有机会反击吗?
云吞噬开源,那开源有机会反击吗?
2022-07-04
人物专访
专题采访:创造者说
90 后,辞职创业,说要卷死云数据库
2022-06-28
公开直播
贝斯的圆桌趴 |DBA 福音 -
SQL 审核最佳实践
2022-06-12
公开路演
奇绩创坛 S22 路演日
好用省钱的数据库发行版 Pigsty
2022-06-05
视频直播
PG中文社区直播分享
Pigstyv1.5快速上手新特性介绍与生产集群搭建
2.6 - 加入社区
Pigsty 是一个 Build in Public 的项目,我们在 GitHub 上非常活跃,中文区用户主要活跃于微信群组中。
GitHub
我们的 GitHub 仓库地址是:https://github.com/Vonng/pigsty ,欢迎点个 ⭐️ 关注 我们。
我们欢迎任何人 提交新 Issue 或创建 Pull Request ,提出功能建议并参与 Pigsty 贡献。
请注意,关于 Pigsty 文档的问题,请在 github.com/Vonng/pigsty.cc 仓库中提交 Issue 。
微信群组
中文区用户主要活跃于微信群组中,目前有七个活跃的群组,1群-4群已经满员,其他群需要添加小助手微信拉入。
加入微信社群,请用搜索 “Pigsty小助手”,(微信号 pigsty-cc
) 备注或发送 “加群” ,小助手会将您拉入群组中。
海外社群
Telegram: https://t.me/joinchat/gV9zfZraNPM3YjFh
Discord: https://discord.gg/j5pG8qfKxU
您也可以通过邮件联系我: rh@vonng.com
社区求助
当您使用 Pigsty 遇到问题时,可以向社区求助,您提供的信息越丰富,就越有可能在社区得到帮助。
请参考 社区求助指南 ,尽可能提供足够的信息,以便社区成员帮助您解决问题。以下是求助提问的参考模板:
发生了什么事? (必选项 )
Pigsty版本号与操作系统版本 (必选项 )
$ grep version pigsty.yml
$ cat /etc/os-release
$ uname -a
一些云厂商对标准操作系统发行版进行了定制,您可以告诉我们使用的是哪一家云厂商的什么操作系统镜像。
如果您在安装操作系统后对环境进行了定制与修改,或者在您的局域网中有特定的安全规则与防火墙配置,也请在提问时告知我们。
Pigsty配置文件
请不要忘记抹掉任何敏感信息:密码,内部密钥,敏感配置等。
你期待发生什么?
请描述正常情况下应该发生什么事情,实际发生的情况与期待的情况有何偏离?
如何复现此问题?
请尽可能详细地告诉我们复现此问题的方法与步骤。
监控截图
如果你在使用 Pigsty 提供的监控系统,可以提供 相关 的截图。
错误日志
请尽可能提供与错误有关的日志。请不要粘贴类似 “Failed to start xxx service” 之类没有信息量的内容 。
您可以从 Grafana / Loki 中查询日志,或从以下位置获取日志:
Syslog: /var/log/messages
(rhel) or /var/log/syslog
(debian)
Postgres: /pg/log/postgres/*
Patroni: /pg/log/patroni/*
Pgbouncer: /pg/log/pgbouncer/*
Pgbackrest: /pg/log/pgbackrest/*
journalctl -u patroni
journalctl -u <service name>
您已经搜索过 Issue/网站/FAQ了吗?
在 FAQ 中,我们提供了许多常见问题的解答,请在提问前检查
您也可以从 Github Issue 与 Discussion 中搜索相关问题:
有什么其他信息是我们需要知道的吗?
您提供的信息与上下文越丰富,我们越有可能帮助您解决问题。
2.7 - 隐私政策
Pigsty 软件与网站会收集哪些用户数据,以及我们将如何处理您的数据并保护您的隐私权?
Pigsty软件
当您安装 Pigsty 软件时,如果在网络隔离的环境中使用离线软件包安装,我们不会收到任何关于您的数据 。
如果您选择在线安装,那么在下载相关软件包时,我们的服务器或云供应商的服务器会自动在日志中记录来访机器的 IP 地址和/或主机名,和您下载的软件包名称。
除非法律要求,我们不会与其他组织共享这些信息。(实话说也是吃饱了撑着才会去看这些东西)
Pigsty 使用的主域名为:pigsty.io ,中国大陆请使用备案镜像站点 pigsty.cc 。
Pigsty网站
当您访问我们的网站时,我们的服务器会自动在 Nginx 日志中记录您的 IP 地址和/或主机名。
仅当您决定通过完成调查或在我们的某个网站上注册为用户来向我们发送此类信息时,我们才会存储您的电子邮件地址、姓名和地点等信息
我们收集这些信息是为了帮助我们改进网站内容、定制网页布局以及出于技术和支持目的联系人员。除非法律要求,我们不会与其他组织共享您的电子邮件地址。
本网站使用 Google Analytics,这是 Google, Inc.(“Google”)提供的一项网络分析服务。谷歌分析使用“cookies”,即放置在您计算机上的文本文件,帮助网站分析用户如何使用该网站。
cookie 生成的有关您使用网站的信息(包括您的 IP 地址)将被传输至 Google 位于美国的服务器并由其存储。谷歌将使用这些信息来评估您对网站的使用情况,为网站运营商编制网站活动报告,并提供与网站活动和互联网使用相关的其他服务。
如果法律要求,或者第三方代表 Google 处理信息,Google 还可能会将此信息传输给第三方。 Google 不会将您的 IP 地址与 Google 持有的任何其他数据关联起来。
您可以通过在浏览器上选择适当的设置来拒绝使用 cookie,但请注意,如果您这样做,您可能无法使用本网站的全部功能。使用本网站即表示您同意 Google 以上述方式和目的处理有关您的数据。
如果您对此政策有任何疑问或意见,或要求删除个人数据,您可以通过发送邮件至 rh@pigsty.io 与我们联系
2.8 - 开源协议
Pigsty 使用的开源协议 —— AGPLv3,它授予您什么样的权利,又有哪些限制?
项目协议地址:https://github.com/Vonng/pigsty/blob/main/LICENSE
协议摘要
Pigsty 使用 GNU Affero General Public License v3.0 (AGPLv3) 开源协议,这是一种强制性的 Copyleft 许可证。
如果您通过网络分发 、托管或创建 Pigsty 软件的 衍生作品 ,GNU AGPLv3 许可证要求您也按照相同的 GNU AGPL v3 许可证分发组合作品的完整、相应的源代码。无论您是否修改了 Pigsty 此要求都适用。
本协议授权您:
本协议不提供:
本协议的条件:
包含本许可证并显著声明
不得修改其开源状态
公开源代码
通过网络使用属于分发的一种
使用同样的协议开源
请注意,Pigsty 的网站 (pigsty.io/pigsty.cc) 本身使用 CC by 4.0 协议,这是一种知识共享许可证,
允许您自由地分享与演绎本站的内容,但是您必须给出适当的署名 ,提供指向许可证的链接,并指出是否有对原始内容进行了修改 。
豁免条款
Pigsty 采用了 AGPLv3 许可证,但对于普通终端用户 (即:公有云厂商,数据库厂商除外的用户 ),执行等效 Apache 2.0 许可证。
普通终端用户可以将 AGPLv3 用于商业目的,提供服务,二次开发,而无需担心许可证问题。
即使普通终端用户对 Pigsty 进行二次开发,并违反了 AGPL 协议没有开源,只要用途在合理范围内,我们不会对此进行追索,并豁免用户的相关开源义务。
在 订阅支持 中,我们可以提供关于责任豁免的书面承诺。
我们支持并欢迎遵循 AGPLv3 协议的 PostgreSQL 服务提供商 基于 Pigsty 交付,并提供自己的付费咨询与支持服务,并将二次开发成果回馈上游社区主干。
请注意,PIGSTY® 是注册商标,在提供服务与咨询时,您应当尊重 PIGSTY 的商标权与著作权。我们提供 OEM 合作方案,详情请参考 商业支持 。
为什么使用AGPLv3
AGPLv3 的精神实质是确保用户的软件自由,并通过合法的对公有云厂商的歧视,实现共同体边界的重新划定,将其开除出社区参与之外。
AGPLv3 不影响普通用户的使用:因为使用并不是一种“发布”,您无需操心使用 Pigsty 的业务代码是否需要开源。
当您将 Pigsty 或 Pigsty 的修改作为软件/服务的全部或一部分对外“发布”时,您才需要考虑到 AGPLv3 的约束。
以下是 GNU 官方对 GPL 相关问题的解答:
GNU 许可证常见问题
SBOM清单
本项目所依赖或相关的核心开源软件及其开源协议。340 个 PostgreSQL 扩展插件的许可证请参考 PG扩展列表 。
必要性等级说明:
必选 :提供 Pigsty 关键性核心能力,不提供关闭停用选项
建议:Pigsty 默认启用的组件,可以通过配置选项停用
可选:Pigsty 默认会下载但不启用的组件,可通过配置启用
按需:按需使用的工具,可按需配置下载并启用
协议原文
GNU AFFERO GENERAL PUBLIC LICENSE
Version 3 , 19 November 2007
Copyright ( C ) 2007 Free Software Foundation , Inc . < https : //fsf.org/>
Everyone is permitted to copy and distribute verbatim copies
of this license document , but changing it is not allowed .
Preamble
The GNU Affero General Public License is a free , copyleft license for
software and other kinds of works , specifically designed to ensure
cooperation with the community in the case of network server software .
The licenses for most software and other practical works are designed
to take away your freedom to share and change the works . By contrast ,
our General Public Licenses are intended to guarantee your freedom to
share and change all versions of a program -- to make sure it remains free
software for all its users .
When we speak of free software , we are referring to freedom , not
price . Our General Public Licenses are designed to make sure that you
have the freedom to distribute copies of free software ( and charge for
them if you wish ), that you receive source code or can get it if you
want it , that you can change the software or use pieces of it in new
free programs , and that you know you can do these things .
Developers that use our General Public Licenses protect your rights
with two steps : ( 1 ) assert copyright on the software , and ( 2 ) offer
you this License which gives you legal permission to copy , distribute
and/ or modify the software .
A secondary benefit of defending all users ' freedom is that
improvements made in alternate versions of the program , if they
receive widespread use , become available for other developers to
incorporate . Many developers of free software are heartened and
encouraged by the resulting cooperation . However , in the case of
software used on network servers , this result may fail to come about .
The GNU General Public License permits making a modified version and
letting the public access it on a server without ever releasing its
source code to the public .
The GNU Affero General Public License is designed specifically to
ensure that , in such cases , the modified source code becomes available
to the community . It requires the operator of a network server to
provide the source code of the modified version running there to the
users of that server . Therefore , public use of a modified version , on
a publicly accessible server , gives the public access to the source
code of the modified version .
An older license , called the Affero General Public License and
published by Affero , was designed to accomplish similar goals . This is
a different license , not a version of the Affero GPL , but Affero has
released a new version of the Affero GPL which permits relicensing under
this license .
The precise terms and conditions for copying , distribution and
modification follow .
TERMS AND CONDITIONS
0 . Definitions .
" This License " refers to version 3 of the GNU Affero General Public License .
" Copyright " also means copyright - like laws that apply to other kinds of
works , such as semiconductor masks .
" The Program " refers to any copyrightable work licensed under this
License . Each licensee is addressed as " you " . " Licensees " and
" recipients " may be individuals or organizations .
To " modify " a work means to copy from or adapt all or part of the work
in a fashion requiring copyright permission , other than the making of an
exact copy . The resulting work is called a " modified version " of the
earlier work or a work " based on " the earlier work .
A " covered work " means either the unmodified Program or a work based
on the Program .
To " propagate " a work means to do anything with it that , without
permission , would make you directly or secondarily liable for
infringement under applicable copyright law , except executing it on a
computer or modifying a private copy . Propagation includes copying ,
distribution ( with or without modification ), making available to the
public , and in some countries other activities as well .
To " convey " a work means any kind of propagation that enables other
parties to make or receive copies . Mere interaction with a user through
a computer network , with no transfer of a copy , is not conveying .
An interactive user interface displays " Appropriate Legal Notices "
to the extent that it includes a convenient and prominently visible
feature that ( 1 ) displays an appropriate copyright notice , and ( 2 )
tells the user that there is no warranty for the work ( except to the
extent that warranties are provided ), that licensees may convey the
work under this License , and how to view a copy of this License . If
the interface presents a list of user commands or options , such as a
menu , a prominent item in the list meets this criterion .
1 . Source Code .
The " source code " for a work means the preferred form of the work
for making modifications to it . " Object code " means any non - source
form of a work .
A " Standard Interface " means an interface that either is an official
standard defined by a recognized standards body , or , in the case of
interfaces specified for a particular programming language , one that
is widely used among developers working in that language .
The " System Libraries " of an executable work include anything , other
than the work as a whole , that ( a ) is included in the normal form of
packaging a Major Component , but which is not part of that Major
Component , and ( b ) serves only to enable use of the work with that
Major Component , or to implement a Standard Interface for which an
implementation is available to the public in source code form . A
" Major Component " , in this context , means a major essential component
( kernel , window system , and so on ) of the specific operating system
( if any ) on which the executable work runs , or a compiler used to
produce the work , or an object code interpreter used to run it .
The " Corresponding Source " for a work in object code form means all
the source code needed to generate , install , and ( for an executable
work ) run the object code and to modify the work , including scripts to
control those activities . However , it does not include the work ' s
System Libraries , or general - purpose tools or generally available free
programs which are used unmodified in performing those activities but
which are not part of the work . For example , Corresponding Source
includes interface definition files associated with source files for
the work , and the source code for shared libraries and dynamically
linked subprograms that the work is specifically designed to require ,
such as by intimate data communication or control flow between those
subprograms and other parts of the work .
The Corresponding Source need not include anything that users
can regenerate automatically from other parts of the Corresponding
Source .
The Corresponding Source for a work in source code form is that
same work .
2 . Basic Permissions .
All rights granted under this License are granted for the term of
copyright on the Program , and are irrevocable provided the stated
conditions are met . This License explicitly affirms your unlimited
permission to run the unmodified Program . The output from running a
covered work is covered by this License only if the output , given its
content , constitutes a covered work . This License acknowledges your
rights of fair use or other equivalent , as provided by copyright law .
You may make , run and propagate covered works that you do not
convey , without conditions so long as your license otherwise remains
in force . You may convey covered works to others for the sole purpose
of having them make modifications exclusively for you , or provide you
with facilities for running those works , provided that you comply with
the terms of this License in conveying all material for which you do
not control copyright . Those thus making or running the covered works
for you must do so exclusively on your behalf , under your direction
and control , on terms that prohibit them from making any copies of
your copyrighted material outside their relationship with you .
Conveying under any other circumstances is permitted solely under
the conditions stated below . Sublicensing is not allowed ; section 10
makes it unnecessary .
3 . Protecting Users ' Legal Rights From Anti - Circumvention Law .
No covered work shall be deemed part of an effective technological
measure under any applicable law fulfilling obligations under article
11 of the WIPO copyright treaty adopted on 20 December 1996 , or
similar laws prohibiting or restricting circumvention of such
measures .
When you convey a covered work , you waive any legal power to forbid
circumvention of technological measures to the extent such circumvention
is effected by exercising rights under this License with respect to
the covered work , and you disclaim any intention to limit operation or
modification of the work as a means of enforcing , against the work ' s
users , your or third parties ' legal rights to forbid circumvention of
technological measures .
4 . Conveying Verbatim Copies .
You may convey verbatim copies of the Program ' s source code as you
receive it , in any medium , provided that you conspicuously and
appropriately publish on each copy an appropriate copyright notice ;
keep intact all notices stating that this License and any
non - permissive terms added in accord with section 7 apply to the code ;
keep intact all notices of the absence of any warranty ; and give all
recipients a copy of this License along with the Program .
You may charge any price or no price for each copy that you convey ,
and you may offer support or warranty protection for a fee .
5 . Conveying Modified Source Versions .
You may convey a work based on the Program , or the modifications to
produce it from the Program , in the form of source code under the
terms of section 4 , provided that you also meet all of these conditions :
a ) The work must carry prominent notices stating that you modified
it , and giving a relevant date .
b ) The work must carry prominent notices stating that it is
released under this License and any conditions added under section
7 . This requirement modifies the requirement in section 4 to
" keep intact all notices " .
c ) You must license the entire work , as a whole , under this
License to anyone who comes into possession of a copy . This
License will therefore apply , along with any applicable section 7
additional terms , to the whole of the work , and all its parts ,
regardless of how they are packaged . This License gives no
permission to license the work in any other way , but it does not
invalidate such permission if you have separately received it .
d ) If the work has interactive user interfaces , each must display
Appropriate Legal Notices ; however , if the Program has interactive
interfaces that do not display Appropriate Legal Notices , your
work need not make them do so .
A compilation of a covered work with other separate and independent
works , which are not by their nature extensions of the covered work ,
and which are not combined with it such as to form a larger program ,
in or on a volume of a storage or distribution medium , is called an
" aggregate " if the compilation and its resulting copyright are not
used to limit the access or legal rights of the compilation ' s users
beyond what the individual works permit . Inclusion of a covered work
in an aggregate does not cause this License to apply to the other
parts of the aggregate .
6 . Conveying Non - Source Forms .
You may convey a covered work in object code form under the terms
of sections 4 and 5 , provided that you also convey the
machine - readable Corresponding Source under the terms of this License ,
in one of these ways :
a ) Convey the object code in , or embodied in , a physical product
( including a physical distribution medium ), accompanied by the
Corresponding Source fixed on a durable physical medium
customarily used for software interchange .
b ) Convey the object code in , or embodied in , a physical product
( including a physical distribution medium ), accompanied by a
written offer , valid for at least three years and valid for as
long as you offer spare parts or customer support for that product
model , to give anyone who possesses the object code either ( 1 ) a
copy of the Corresponding Source for all the software in the
product that is covered by this License , on a durable physical
medium customarily used for software interchange , for a price no
more than your reasonable cost of physically performing this
conveying of source , or ( 2 ) access to copy the
Corresponding Source from a network server at no charge .
c ) Convey individual copies of the object code with a copy of the
written offer to provide the Corresponding Source . This
alternative is allowed only occasionally and noncommercially , and
only if you received the object code with such an offer , in accord
with subsection 6 b .
d ) Convey the object code by offering access from a designated
place ( gratis or for a charge ), and offer equivalent access to the
Corresponding Source in the same way through the same place at no
further charge . You need not require recipients to copy the
Corresponding Source along with the object code . If the place to
copy the object code is a network server , the Corresponding Source
may be on a different server ( operated by you or a third party )
that supports equivalent copying facilities , provided you maintain
clear directions next to the object code saying where to find the
Corresponding Source . Regardless of what server hosts the
Corresponding Source , you remain obligated to ensure that it is
available for as long as needed to satisfy these requirements .
e ) Convey the object code using peer - to - peer transmission , provided
you inform other peers where the object code and Corresponding
Source of the work are being offered to the general public at no
charge under subsection 6 d .
A separable portion of the object code , whose source code is excluded
from the Corresponding Source as a System Library , need not be
included in conveying the object code work .
A " User Product " is either ( 1 ) a " consumer product " , which means any
tangible personal property which is normally used for personal , family ,
or household purposes , or ( 2 ) anything designed or sold for incorporation
into a dwelling . In determining whether a product is a consumer product ,
doubtful cases shall be resolved in favor of coverage . For a particular
product received by a particular user , " normally used " refers to a
typical or common use of that class of product , regardless of the status
of the particular user or of the way in which the particular user
actually uses , or expects or is expected to use , the product . A product
is a consumer product regardless of whether the product has substantial
commercial , industrial or non - consumer uses , unless such uses represent
the only significant mode of use of the product .
" Installation Information " for a User Product means any methods ,
procedures , authorization keys , or other information required to install
and execute modified versions of a covered work in that User Product from
a modified version of its Corresponding Source . The information must
suffice to ensure that the continued functioning of the modified object
code is in no case prevented or interfered with solely because
modification has been made .
If you convey an object code work under this section in , or with , or
specifically for use in , a User Product , and the conveying occurs as
part of a transaction in which the right of possession and use of the
User Product is transferred to the recipient in perpetuity or for a
fixed term ( regardless of how the transaction is characterized ), the
Corresponding Source conveyed under this section must be accompanied
by the Installation Information . But this requirement does not apply
if neither you nor any third party retains the ability to install
modified object code on the User Product ( for example , the work has
been installed in ROM ).
The requirement to provide Installation Information does not include a
requirement to continue to provide support service , warranty , or updates
for a work that has been modified or installed by the recipient , or for
the User Product in which it has been modified or installed . Access to a
network may be denied when the modification itself materially and
adversely affects the operation of the network or violates the rules and
protocols for communication across the network .
Corresponding Source conveyed , and Installation Information provided ,
in accord with this section must be in a format that is publicly
documented ( and with an implementation available to the public in
source code form ), and must require no special password or key for
unpacking , reading or copying .
7 . Additional Terms .
" Additional permissions " are terms that supplement the terms of this
License by making exceptions from one or more of its conditions .
Additional permissions that are applicable to the entire Program shall
be treated as though they were included in this License , to the extent
that they are valid under applicable law . If additional permissions
apply only to part of the Program , that part may be used separately
under those permissions , but the entire Program remains governed by
this License without regard to the additional permissions .
When you convey a copy of a covered work , you may at your option
remove any additional permissions from that copy , or from any part of
it . ( Additional permissions may be written to require their own
removal in certain cases when you modify the work .) You may place
additional permissions on material , added by you to a covered work ,
for which you have or can give appropriate copyright permission .
Notwithstanding any other provision of this License , for material you
add to a covered work , you may ( if authorized by the copyright holders of
that material ) supplement the terms of this License with terms :
a ) Disclaiming warranty or limiting liability differently from the
terms of sections 15 and 16 of this License ; or
b ) Requiring preservation of specified reasonable legal notices or
author attributions in that material or in the Appropriate Legal
Notices displayed by works containing it ; or
c ) Prohibiting misrepresentation of the origin of that material , or
requiring that modified versions of such material be marked in
reasonable ways as different from the original version ; or
d ) Limiting the use for publicity purposes of names of licensors or
authors of the material ; or
e ) Declining to grant rights under trademark law for use of some
trade names , trademarks , or service marks ; or
f ) Requiring indemnification of licensors and authors of that
material by anyone who conveys the material ( or modified versions of
it ) with contractual assumptions of liability to the recipient , for
any liability that these contractual assumptions directly impose on
those licensors and authors .
All other non - permissive additional terms are considered " further
restrictions " within the meaning of section 10 . If the Program as you
received it , or any part of it , contains a notice stating that it is
governed by this License along with a term that is a further
restriction , you may remove that term . If a license document contains
a further restriction but permits relicensing or conveying under this
License , you may add to a covered work material governed by the terms
of that license document , provided that the further restriction does
not survive such relicensing or conveying .
If you add terms to a covered work in accord with this section , you
must place , in the relevant source files , a statement of the
additional terms that apply to those files , or a notice indicating
where to find the applicable terms .
Additional terms , permissive or non - permissive , may be stated in the
form of a separately written license , or stated as exceptions ;
the above requirements apply either way .
8 . Termination .
You may not propagate or modify a covered work except as expressly
provided under this License . Any attempt otherwise to propagate or
modify it is void , and will automatically terminate your rights under
this License ( including any patent licenses granted under the third
paragraph of section 11 ).
However , if you cease all violation of this License , then your
license from a particular copyright holder is reinstated ( a )
provisionally , unless and until the copyright holder explicitly and
finally terminates your license , and ( b ) permanently , if the copyright
holder fails to notify you of the violation by some reasonable means
prior to 60 days after the cessation .
Moreover , your license from a particular copyright holder is
reinstated permanently if the copyright holder notifies you of the
violation by some reasonable means , this is the first time you have
received notice of violation of this License ( for any work ) from that
copyright holder , and you cure the violation prior to 30 days after
your receipt of the notice .
Termination of your rights under this section does not terminate the
licenses of parties who have received copies or rights from you under
this License . If your rights have been terminated and not permanently
reinstated , you do not qualify to receive new licenses for the same
material under section 10 .
9 . Acceptance Not Required for Having Copies .
You are not required to accept this License in order to receive or
run a copy of the Program . Ancillary propagation of a covered work
occurring solely as a consequence of using peer - to - peer transmission
to receive a copy likewise does not require acceptance . However ,
nothing other than this License grants you permission to propagate or
modify any covered work . These actions infringe copyright if you do
not accept this License . Therefore , by modifying or propagating a
covered work , you indicate your acceptance of this License to do so .
10 . Automatic Licensing of Downstream Recipients .
Each time you convey a covered work , the recipient automatically
receives a license from the original licensors , to run , modify and
propagate that work , subject to this License . You are not responsible
for enforcing compliance by third parties with this License .
An " entity transaction " is a transaction transferring control of an
organization , or substantially all assets of one , or subdividing an
organization , or merging organizations . If propagation of a covered
work results from an entity transaction , each party to that
transaction who receives a copy of the work also receives whatever
licenses to the work the party ' s predecessor in interest had or could
give under the previous paragraph , plus a right to possession of the
Corresponding Source of the work from the predecessor in interest , if
the predecessor has it or can get it with reasonable efforts .
You may not impose any further restrictions on the exercise of the
rights granted or affirmed under this License . For example , you may
not impose a license fee , royalty , or other charge for exercise of
rights granted under this License , and you may not initiate litigation
( including a cross - claim or counterclaim in a lawsuit ) alleging that
any patent claim is infringed by making , using , selling , offering for
sale , or importing the Program or any portion of it .
11 . Patents .
A " contributor " is a copyright holder who authorizes use under this
License of the Program or a work on which the Program is based . The
work thus licensed is called the contributor ' s " contributor version " .
A contributor ' s " essential patent claims " are all patent claims
owned or controlled by the contributor , whether already acquired or
hereafter acquired , that would be infringed by some manner , permitted
by this License , of making , using , or selling its contributor version ,
but do not include claims that would be infringed only as a
consequence of further modification of the contributor version . For
purposes of this definition , " control " includes the right to grant
patent sublicenses in a manner consistent with the requirements of
this License .
Each contributor grants you a non - exclusive , worldwide , royalty - free
patent license under the contributor ' s essential patent claims , to
make , use , sell , offer for sale , import and otherwise run , modify and
propagate the contents of its contributor version .
In the following three paragraphs , a " patent license " is any express
agreement or commitment , however denominated , not to enforce a patent
( such as an express permission to practice a patent or covenant not to
sue for patent infringement ). To " grant " such a patent license to a
party means to make such an agreement or commitment not to enforce a
patent against the party .
If you convey a covered work , knowingly relying on a patent license ,
and the Corresponding Source of the work is not available for anyone
to copy , free of charge and under the terms of this License , through a
publicly available network server or other readily accessible means ,
then you must either ( 1 ) cause the Corresponding Source to be so
available , or ( 2 ) arrange to deprive yourself of the benefit of the
patent license for this particular work , or ( 3 ) arrange , in a manner
consistent with the requirements of this License , to extend the patent
license to downstream recipients . " Knowingly relying " means you have
actual knowledge that , but for the patent license , your conveying the
covered work in a country , or your recipient ' s use of the covered work
in a country , would infringe one or more identifiable patents in that
country that you have reason to believe are valid .
If , pursuant to or in connection with a single transaction or
arrangement , you convey , or propagate by procuring conveyance of , a
covered work , and grant a patent license to some of the parties
receiving the covered work authorizing them to use , propagate , modify
or convey a specific copy of the covered work , then the patent license
you grant is automatically extended to all recipients of the covered
work and works based on it .
A patent license is " discriminatory " if it does not include within
the scope of its coverage , prohibits the exercise of , or is
conditioned on the non - exercise of one or more of the rights that are
specifically granted under this License . You may not convey a covered
work if you are a party to an arrangement with a third party that is
in the business of distributing software , under which you make payment
to the third party based on the extent of your activity of conveying
the work , and under which the third party grants , to any of the
parties who would receive the covered work from you , a discriminatory
patent license ( a ) in connection with copies of the covered work
conveyed by you ( or copies made from those copies ), or ( b ) primarily
for and in connection with specific products or compilations that
contain the covered work , unless you entered into that arrangement ,
or that patent license was granted , prior to 28 March 2007 .
Nothing in this License shall be construed as excluding or limiting
any implied license or other defenses to infringement that may
otherwise be available to you under applicable patent law .
12 . No Surrender of Others ' Freedom .
If conditions are imposed on you ( whether by court order , agreement or
otherwise ) that contradict the conditions of this License , they do not
excuse you from the conditions of this License . If you cannot convey a
covered work so as to satisfy simultaneously your obligations under this
License and any other pertinent obligations , then as a consequence you may
not convey it at all . For example , if you agree to terms that obligate you
to collect a royalty for further conveying from those to whom you convey
the Program , the only way you could satisfy both those terms and this
License would be to refrain entirely from conveying the Program .
13 . Remote Network Interaction ; Use with the GNU General Public License .
Notwithstanding any other provision of this License , if you modify the
Program , your modified version must prominently offer all users
interacting with it remotely through a computer network ( if your version
supports such interaction ) an opportunity to receive the Corresponding
Source of your version by providing access to the Corresponding Source
from a network server at no charge , through some standard or customary
means of facilitating copying of software . This Corresponding Source
shall include the Corresponding Source for any work covered by version 3
of the GNU General Public License that is incorporated pursuant to the
following paragraph .
Notwithstanding any other provision of this License , you have
permission to link or combine any covered work with a work licensed
under version 3 of the GNU General Public License into a single
combined work , and to convey the resulting work . The terms of this
License will continue to apply to the part which is the covered work ,
but the work with which it is combined will remain governed by version
3 of the GNU General Public License .
14 . Revised Versions of this License .
The Free Software Foundation may publish revised and/ or new versions of
the GNU Affero General Public License from time to time . Such new versions
will be similar in spirit to the present version , but may differ in detail to
address new problems or concerns .
Each version is given a distinguishing version number . If the
Program specifies that a certain numbered version of the GNU Affero General
Public License " or any later version " applies to it , you have the
option of following the terms and conditions either of that numbered
version or of any later version published by the Free Software
Foundation . If the Program does not specify a version number of the
GNU Affero General Public License , you may choose any version ever published
by the Free Software Foundation .
If the Program specifies that a proxy can decide which future
versions of the GNU Affero General Public License can be used , that proxy ' s
public statement of acceptance of a version permanently authorizes you
to choose that version for the Program .
Later license versions may give you additional or different
permissions . However , no additional obligations are imposed on any
author or copyright holder as a result of your choosing to follow a
later version .
15 . Disclaimer of Warranty .
THERE IS NO WARRANTY FOR THE PROGRAM , TO THE EXTENT PERMITTED BY
APPLICABLE LAW . EXCEPT WHEN OTHERWISE STATED IN WRITING THE COPYRIGHT
HOLDERS AND/ OR OTHER PARTIES PROVIDE THE PROGRAM " AS IS " WITHOUT WARRANTY
OF ANY KIND , EITHER EXPRESSED OR IMPLIED , INCLUDING , BUT NOT LIMITED TO ,
THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
PURPOSE . THE ENTIRE RISK AS TO THE QUALITY AND PERFORMANCE OF THE PROGRAM
IS WITH YOU . SHOULD THE PROGRAM PROVE DEFECTIVE , YOU ASSUME THE COST OF
ALL NECESSARY SERVICING , REPAIR OR CORRECTION .
16 . Limitation of Liability .
IN NO EVENT UNLESS REQUIRED BY APPLICABLE LAW OR AGREED TO IN WRITING
WILL ANY COPYRIGHT HOLDER , OR ANY OTHER PARTY WHO MODIFIES AND/ OR CONVEYS
THE PROGRAM AS PERMITTED ABOVE , BE LIABLE TO YOU FOR DAMAGES , INCLUDING ANY
GENERAL , SPECIAL , INCIDENTAL OR CONSEQUENTIAL DAMAGES ARISING OUT OF THE
USE OR INABILITY TO USE THE PROGRAM ( INCLUDING BUT NOT LIMITED TO LOSS OF
DATA OR DATA BEING RENDERED INACCURATE OR LOSSES SUSTAINED BY YOU OR THIRD
PARTIES OR A FAILURE OF THE PROGRAM TO OPERATE WITH ANY OTHER PROGRAMS ),
EVEN IF SUCH HOLDER OR OTHER PARTY HAS BEEN ADVISED OF THE POSSIBILITY OF
SUCH DAMAGES .
17 . Interpretation of Sections 15 and 16 .
If the disclaimer of warranty and limitation of liability provided
above cannot be given local legal effect according to their terms ,
reviewing courts shall apply local law that most closely approximates
an absolute waiver of all civil liability in connection with the
Program , unless a warranty or assumption of liability accompanies a
copy of the Program in return for a fee .
END OF TERMS AND CONDITIONS
How to Apply These Terms to Your New Programs
If you develop a new program , and you want it to be of the greatest
possible use to the public , the best way to achieve this is to make it
free software which everyone can redistribute and change under these terms .
To do so , attach the following notices to the program . It is safest
to attach them to the start of each source file to most effectively
state the exclusion of warranty ; and each file should have at least
the " copyright " line and a pointer to where the full notice is found .
Copyright ( C ) 2018 - 2024 Ruohang Feng , Author of Pigsty
This program is free software : you can redistribute it and/ or modify
it under the terms of the GNU Affero General Public License as published by
the Free Software Foundation , either version 3 of the License , or
( at your option ) any later version .
This program is distributed in the hope that it will be useful ,
but WITHOUT ANY WARRANTY ; without even the implied warranty of
MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE . See the
GNU Affero General Public License for more details .
You should have received a copy of the GNU Affero General Public License
along with this program . If not , see < https : //www.gnu.org/licenses/>.
Also add information on how to contact you by electronic and paper mail .
If your software can interact with users remotely through a computer
network , you should also make sure that it provides a way for users to
get its source . For example , if your program is a web application , its
interface could display a " Source " link that leads users to an archive
of the code . There are many ways you could offer source , and different
solutions will be better for different programs ; see section 13 for the
specific requirements .
You should also get your employer ( if you work as a programmer ) or school ,
if any , to sign a " copyright disclaimer " for the program , if necessary .
For more information on this , and how to apply and follow the GNU AGPL , see
< https : //www.gnu.org/licenses/>.
2.9 - 赞助我们
Pigsty 的赞助者,投资人名单,感谢你们对本项目的支持!
赞助我们
Pigsty 是一个开源免费的自由软件,由 PostgreSQL 社区成员用热情浇灌而成,旨在整合 PostgreSQL 生态的力量,推广 PostgreSQL 的普及。如果我们的工作帮到了您,请考虑赞助或者支持一下我们的项目:
直接打钱赞助我们,用最直接有力的鼓舞表达您的真挚支持!
考虑采购我们的技术支持服务 ,我们可以提供专业的 PostgreSQL 高可用集群部署与维护服务,让您的预算花得物有所值!
通过文章,讲座,视频分享您使用 Pigsty 的案例与经验。
允许我们在 “这些用户使用了Pigsty” 中提及您的组织。
向有需求的朋友,同事与客户提名/推荐我们的项目与服务。
关注我们的 微信公众号 并转发相关技术文章至群组与朋友圈。
天使投资人
Pigsty 是由 奇绩创坛 (原YC中国,MiraclePlus) S22 所投资的项目,感谢奇绩创坛与陆奇博士对本项目的支持!
2.10 - 行业案例
Pigsty 在各个领域与行业的客户/应用案例
如果您正在使用 Pigsty 并且愿意与我们分享,并提供一次的免费咨询支持。
互联网行业
探探:两百台+物理机,用于 PostgreSQL 与 Redis 服务
哔哩哔哩:用于支持 PostgreSQL 创新业务
金融行业
AirWallexr:监控 200+ GCP PostgreSQL 数据库
自动驾驶
Momenta:自动驾驶,管理自建 PostgreSQL 集群
科技创新
北京领雾科技:云上 PostgreSQL 下云自建
Motphys:自建 PostgreSQL 支持 Gitlab
赛陇生物科技:自建 Supabase
杭州零码科技:自建 PostgreSQL
ISV
制造业
华峰集团:使用 Pigsty 交付 PostgreSQL 集群作为数据仓库。
军工
军工
云厂商
OCI:使用 Pigsty 交付 PostgreSQL 集群。
2.11 - 订阅服务
Pigsty 专业版/企业版订阅服务:当您遇到与 PostgreSQL 和 Pigsty 有关的疑难杂症时,订阅服务可以为您兜底。
Pigsty 旨在聚集PG生态的扩展合力,并用数据库自动驾驶软件替代人肉数据库运维管理,帮助用户用好 PostgreSQL。
尽管 Pigsty 本身已经解决了 PG 使用中的诸多问题。
但想真正达到企业级服务的质量,原厂提供的专家支持与兜底服务不可或缺。
我们深知专业的商业支持服务对于企业客户的重要性,
因此,Pigsty 企业版在开源版本的基础上提供了一系列增值服务,
帮助用户更好地用好 PostgreSQL 与 Pigsty,供有需求的客户按需选用。
如果您有下列需求,欢迎考虑 Pigsty 订阅服务:
在关键场景中运行数据库,需要严格 SLA 保障兜底。
希望对 Pigsty 与 PostgreSQL 相关疑难杂症提供兜底。
希望获取关于 PostgreSQL / Pigsty 生产环境最佳实践的指导。
希望有专家帮助解读监控图表,分析定位性能瓶颈与故障根因,给出意见。
希望根据现有资源与业务需求,规划满足安全/容灾/合规要求的数据库架构。
需要将其他数据库迁移至 PostgreSQL 数据库,或对历史遗留实例迁移与改造。
建设基于Prometheus / Grafana 技术栈的可观测性体系,数据大盘,可视化应用。
希望支持国产信创操作系统/国产信创 ARM 芯片架构,提供中文/本地化界面支持。
下云并寻求 RDS for PostgreSQL 的开源替代 —— 云中立,无供应商锁定的解决方案。
希望获取关于 Redis / ETCD / MinIO / Greenplum / Citus / TimescaleDB 的专业技术支持。
希望规避 AGPL v3 协议对衍生作品强制使用同协议开源的的限制,进行二次开发与OEM贴牌。
希望将 Pigsty 作为 SaaS / PaaS / DBaaS 对外销售,或基于此发行版提供技术服务/咨询/云服务。
订阅计划
除了 开源版 之外,Pigsty 提供两种不同的订阅服务档位:专业版 与 企业版 ,您可以根据自身的实际情况与需求选购。
Pigsty 订阅的价格与部署 节点 数量成正比,即与系统复杂度规模绑定,节点可以是物理机,虚拟机,节点的 CPU 数量不影响定价。
节点(Node)数量的定义为: 一套 Pigsty 部署中,配置清单 里作为 Host 存在的独立 IP 地址个数,即由 Pigsty 所纳管的节点总数。
开源免费
无规模限制,无质保承诺
许可协议:AGPLv3
PG支持:17
架构支持:x86_64
OS支持:三系最新小版本
EL 9.4
Debian 12.7
Ubuntu 22.04.5
功能:核心模块
SLA:无 SLA 承诺
社区公益支持答疑:
支持:无人天支持选项
仓库:全球CF托管仓库
列表单价:30,000 ¥ / 节点·年
起步规模:4 节点 = 120,000 ¥ / 年
许可协议:商业许可证
PG支持:16, 17
架构支持:x86_64
OS支持:五系大小版本
EL 8 / 9 兼容
Debian 12
Ubuntu 22 / 24
功能:所有模块
SLA:工作日时效内响应
提供专家咨询服务:
支持:每年包含 1 人天
交付:离线安装软件包
仓库:中国大陆镜像站
列表单价:100,000 ¥ / 节点·年
起步规模:4 节点 = 400,000 ¥ / 年
许可协议:商业许可证
PG支持:12 - 18+
架构支持:x86_64,Arm64
OS支持:按需定制
EL, Debian, Ubuntu
云上 Linux 操作系统
国产操作系统与ARM
功能:所有模块
SLA:7 x 24 (< 1h)
提供企业级专家咨询服务:
软件缺陷修复
疑难杂症分析
专家答疑解惑
备份合规建议
升级路径支持
性能瓶颈定位
年度架构评估
扩展插件收录
支持:每年包含 2 人天
仓库:中国大陆镜像站
交付:离线安装软件包
信创:PolarDB-O 支持
Pigsty开源版
Pigsty 开源版使用 AGPLv3 许可证, 提供了完整核心功能,无需任何费用,但也不承诺任何质保服务。如果您发现了 Pigsty 的缺陷,我们非常欢迎您在 Github 上提出 Issue 。
如果您属于普通终端用户(即:公有云厂商,数据库厂商除外的用户),我们实际上执行更宽松的 Apache 2.0 许可证 —— 即使您对 Pigsty 进行二次开发,我们也不会对此进行追索。
针对开源版本,我们提供 PostgreSQL 17 在 EL 9.4,Debian 12.7,Ubuntu 22.04.5 三个精准操作系统发行版最新小版本的支持。
使用 Pigsty 开源版本,可以让初级研发工程师 / 运维工程师拥有一个专业 DBA 70% 的能力,在缺少数据库专家的情况下,也能够轻松搭建一个高可用,高性能,易维护,安全可靠的 PostgreSQL 数据库集群。
代号
操作系统发行版版本
x86_64
PG17
PG16
PG15
PG14
PG13
EL9
RHEL 9 / Rocky9 / Alma9
el9.x86_64
U22
Ubuntu 22.04 (jammy
)
u22.x86_64
D12
Debian 12 (bookworm
)
d12.x86_64
= 首要支持, = 选配支持
Pigsty专业版
专业版订阅价格: ¥ 30,000 / 节点·年,四节点起,起步价格 ¥ 120,000 / 年
Pigsty 专业版订阅提供了完整的功能模块,以及对于 Pigsty 本身的质保。关于 PostgreSQL 本身与扩展插件的缺陷,我们将尽最大努力通过 PostgreSQL 全球开发者社区进行反馈与修复。
Pigsty 专业版构建于开源版基础之上,完全兼容开源版本的所有功能,并提供额外的功能模块,与更为宽广的数据库 / 操作系统版本兼容选项:我们将针对五个主流操作系统发行版的所有小版本提供构建选项。
Pigsty 专业版包含了对最近两个 PostgreSQL 大版本(17,16)的支持,提供两个大版本中的所有可用的扩展插件,确保您可以通过滚动升级的方式,平滑迁移到最新的 PostgreSQL 大版本上。
Pigsty 专业版订阅允许您使用中国大陆镜像站点软件仓库,无需翻墙代理即可访问;同时我们将针对您使用的精准操作系统大小版本定制离线软件安装包,确保在断网环境下也能正常安装交付,真正做到运维自主可控。
Pigsty 专业版订阅提供了标准的专家咨询服务,包括疑难杂症分析,DBA 答疑解惑,备份合规建议等,我们承诺在工作日(5x8)内响应您的问题,并且每年提供 1 人天支持,以及可选的人天加购选项,用于解决各种更为棘手复杂耗时的问题。
Pigsty 专业版使用商业许可证,并提供书面合同承诺的 AGPLv3 开源义务豁免,即使您对 Pigsty 进行二次开发,并违反了 AGPLv3 协议没有开源,我们亦不会对此进行追索。
Pigsty 专业版的定价为 ¥30,000 / 节点·年 ,四节点 起售,最低总价 ¥120,000 / 年 ,相当于 7 vCPU 的 AWS RDS 或 30 vCPU 的阿里云 RDS,或月薪不足一万元 的初级运维工程师。
代号
操作系统发行版版本
x86_64
PG17
PG16
PG15
PG14
PG13
EL9
RHEL 9 / Rocky9 / Alma9
el9.x86_64
EL8
RHEL 8 / Rocky8 / Alma8 / Anolis8
el8.x86_64