Skip to content

Commit 78003d1

Browse files
committed
doc: update feature description
1 parent 8683724 commit 78003d1

File tree

6 files changed

+17
-16
lines changed

6 files changed

+17
-16
lines changed

docs/ARCH.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -3,7 +3,7 @@
33
> Modular Architecture and Declarative Interface!
44
55
* Pigsty deployment is described by config inventory and materialized with ansible playbooks.
6-
* Pigsty works on common nodes (x86_64 EL7/8/9), i.e., bare metals or virtual machines.
6+
* Pigsty works on [Linux](INSTALL#requirement) x86_64 common nodes, i.e., bare metals or virtual machines.
77
* Pigsty uses a modular design that can be freely composed for different scenarios.
88
* The config controls **where** & **how** to install modules with **parameters**
99
* The playbooks will adjust nodes into the desired status in an idempotent manner.

docs/FEATURE.md

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -2,9 +2,9 @@
22

33
Pigsty is a **Me-Better, Battery-Included, Open-Source RDS PG Alternative**:
44

5-
- [Battery-Included RDS](#battery-included-rds): Delivers production-ready PostgreSQL services from version 12-16 on EL7-9, spanning kernel to RDS distribution.
5+
- [Battery-Included RDS](#battery-included-rds): Delivers production-ready PostgreSQL services from version 12-16 on Linux x86, spanning kernel to RDS distribution.
66
- [Plentiful Extensions](#plentiful-extensions): Integrates 150+ extensions, providing turnkey capabilities for time-series, geospatial, full-text-search, vector and more!
7-
- [Flexible Architecture](#flexible-architecture): Compose Redis/Etcd/MinIO/Mongo modules on nodes, monitoring existing cluster and remote RDS.
7+
- [Flexible Architecture](#flexible-architecture): Compose Redis/Etcd/MinIO/Mongo modules on nodes, monitoring existing cluster and remote RDS, self hosting Supabase/PostgresML.
88
- [Stunning Observability](#stunning-observability): Leveraging the Prometheus/Grafana modern observability stack, and provides unmatched database insights.
99
- [Proven Reliability](#proven-reliability): Self-healing HA architecture with automatic failover and uninterrupted client access, and auto-configured PITR.
1010
- [Great Maintainability](#great-maintainability): Declarative API, GitOps ready, foolproof design, Database/Infra-as-Code, and management SOP seals complexity!
@@ -23,7 +23,7 @@ Pigsty is a **Me-Better, Battery-Included, Open-Source RDS PG Alternative**:
2323

2424
While PostgreSQL shines as a database kernel, it excels as a Relational Database [Service](PGSQL-SVC#service-overview) (RDS) with Pigsty's touch.
2525

26-
Pigsty is compatible with PostgreSQL 12-16 and runs seamlessly on EL 7, 8, 9, and similar OS distributions.
26+
Pigsty is compatible with PostgreSQL 12-16 and runs seamlessly on EL 7, 8, 9, Debian 11/12, Ubuntu 20/22 and similar [OS](README#compatibility) distributions.
2727
It integrates the kernel with a rich set of extensions, provides all the essentials for a production-ready RDS, an entire set of infrastructure runtime coupled with fully automated deployment playbooks.
2828
With everything bundled for offline installation without internet connectivity.
2929

@@ -40,13 +40,13 @@ All you need to do is run the command and connect with the given URL.
4040

4141
## Plentiful Extensions
4242

43-
**Harness the Might of the The World's Most Advanced Open-Source RDBMS!**
43+
**Harness the might of the most advanced Open-Source RDBMS or the world!**
4444

4545
PostgreSQL's has an unique [extension](PGSQL-EXTENSION#extension-list) ecosystem. Pigsty seamlessly integrates these powerful extensions, delivering turnkey distributed solutions for time-series, geospatial, and vector capabilities.
4646

4747
Pigsty boasts over **150** PostgreSQL extensions, and maintaining some not found in official PGDG repositories. Rigorous testing ensures flawless integration for **core** extensions: Leverage [PostGIS](https://postgis.net/) for geospatial data, [TimescaleDB](https://www.timescale.com/) for time-series analysis, [Citus](https://www.citusdata.com/) for horizontal scale out, [PGVector](https://github.com/pgvector/pgvector) for AI embeddings, [Apache AGE](https://age.apache.org/) for graph data, and [zhparser](https://github.com/amutu/zhparser) for Full-Text Search.
4848

49-
Additionally, Pigsty provides a robust compile environment which can be used for [building extension](PGSQL-EXTENSION#compile-extension) from source.
49+
You can also run self-hosted [Supabase](https://github.com/Vonng/pigsty/tree/master/app/supabase/README.md) & [PostgresML](https://github.com/Vonng/pigsty/tree/master/app/pgml) with Pigsty managed HA PostgreSQL. If you want to add your own extension, feel free to [suggest](https://github.com/Vonng/pigsty/discussions/333) or [compile](PGSQL-EXTENSION.md#compile-extension) it by yourself.
5050

5151
[![pigsty-distro.jpg](https://repo.pigsty.cc/img/pigsty-distro.jpg)](PGSQL-EXTENSION.md)
5252

docs/README.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -4,8 +4,6 @@
44
>
55
> —— **A battery-included, local-first, open-source RDS PG alternative.**
66
>
7-
> [PostgreSQL](https://www.postgresql.org/) + [PostGIS](https://postgis.net/) + [TimescaleDB](https://www.timescale.com/) + [Citus](https://www.citusdata.com/) + [PGVector](https://github.com/pgvector/pgvector) + [Age](https://age.apache.org/) + [Supabase](https://supabase.com/) + [PostgresML](https://postgresml.org/) + [...](PGSQL-EXTENSION.md)
8-
>
97
> Latest Release: [v2.5.0](https://github.com/Vonng/pigsty/releases/tag/v2.5.0) | [Repo](https://github.com/Vonng/pigsty) | [Demo](https://demo.pigsty.cc) | [Docs](https://doc.pigsty.cc/) | [Website](https://pigsty.cc/en/) | [Roadmap](https://github.com/users/Vonng/projects/2/views/3) | [Discuss](https://github.com/Vonng/pigsty/discussions) | [Discord](https://discord.gg/Mu2b6Wxr) | [中文文档](/zh/)
108
>
119
> [Get Started](INSTALL.md) with `curl -fsSL https://get.pigsty.cc/latest | bash`
@@ -56,6 +54,8 @@ Pigsty has over **150+** [extensions](PGSQL-EXTENSION.md) pre-compiled and packa
5654
- [FerretDB](https://github.com/Vonng/pigsty/tree/master/app/ferretdb): Open-Source MongoDB alternative based on PostgreSQL
5755
- [PostgresML](https://github.com/Vonng/pigsty/tree/master/app/pgml): Use machine learning algorithms and pretrained models with SQL
5856

57+
[PostgreSQL](https://www.postgresql.org/) + [PostGIS](https://postgis.net/) + [TimescaleDB](https://www.timescale.com/) + [Citus](https://www.citusdata.com/) + [PGVector](https://github.com/pgvector/pgvector) + [Age](https://age.apache.org/) +[Supabase](https://github.com/Vonng/pigsty/tree/master/app/supabase) + [PostgresML](https://github.com/Vonng/pigsty/tree/master/app/pgml) + [...](PGSQL-EXTENSION.md)
58+
5959
[![pigsty-extension.jpg](https://repo.pigsty.cc/img/pigsty-extension.jpg)](PGSQL-EXTENSION.md)
6060

6161
| name | version | source | type | comment |

docs/zh/ARCH.md

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -3,7 +3,7 @@
33
Pigsty 使用 **模块化架构****声明式接口**
44

55
* Pigsty 使用[配置清单](config)描述整套部署环境,并通过 ansible [剧本](playbook)实现。
6-
* Pigsty 在可以在任意节点上运行,无论是物理裸机还是虚拟机,只要操作系统兼容 EL 7-9 即可。
6+
* Pigsty 在可以在任意节点上运行,无论是物理裸机还是虚拟机,只要操作系统[兼容](INSTALL#要求)即可。
77
* Pigsty 的行为由配置参数控制,具有幂等性的剧本 会将节点调整到配置所描述的状态。
88
* Pigsty 采用模块化设计,可自由组合以适应不同场景。使用剧本将模块安装到配置指定的节点上。
99

@@ -85,14 +85,14 @@ $ bin/pgsql-add pg-test # 初始化集群 'pg-test'
8585
客户端无需修改配置重启应用:Haproxy 利用 patroni 健康检查进行流量分发,读写请求会自动分发到新的集群主库中,并避免脑裂的问题。
8686
这一过程十分丝滑,例如在从库故障,或主动切换(switchover)的情况下,客户端只有一瞬间的当前查询闪断,
8787

88-
软件故障、人为错误和 数据中心级灾难由 pgbackrest 和可选的 MinIO 集群来兜底。这为您提供了本地/云端的 PITR 能力,并在数据中心失效的情况下提供了跨地理区域复制,与异地容灾功能。
88+
软件故障、人为错误和 数据中心级灾难由 pgbackrest 和可选的 [MinIO](MINIO) 集群来兜底。这为您提供了本地/云端的 PITR 能力,并在数据中心失效的情况下提供了跨地理区域复制,与异地容灾功能。
8989

9090

9191
----------------
9292

9393
## 数据库即代码
9494

95-
Pigsty 遵循 IaC(基础设施即代码)与 GitOPS 理念:Pigsty 的部署由声明式的[配置清单](config#配置清单)描述,并通过幂等[剧本](playbook)来实现。
95+
Pigsty 遵循 IaC(基础设施即代码)与 GitOPS 理念:Pigsty 的部署由声明式的[配置清单](config#配置清单)描述,并通过幂等[剧本](PLAYBOOK)来实现。
9696

9797
用户用声明的方式通过[参数](param)来描述自己期望的状态,而剧本则以幂等的方式调整目标节点以达到这个状态。这就像 Kubernetes 的 CRD & Operator,但 Pigsty 在裸机和虚拟机上实现了这一点。
9898

docs/zh/FEATURE.md

Lines changed: 3 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -23,7 +23,7 @@ Pigsty 是一个更好的本地开源 RDS for PostgreSQL 替代:
2323

2424
PostgreSQL 是一个足够完美的数据库内核,但它需要更多工具与系统的配合才能成为一个足够好的数据库服务(RDS),而 Pigsty 帮助 PostgreSQL 完成这一步飞跃,帮助用户用好这个强大的数据库。
2525

26-
Pigsty 支持的数据库版本覆盖 PostgreSQL 12 ~ 16,可以运行于 EL 7,8,9 以及兼容操作系统发行版中
26+
Pigsty 支持的数据库版本覆盖 PostgreSQL 12 ~ 16,可以运行于 EL/Debian/Ubuntu 以及[兼容](INSTALL#要求)操作系统发行版中
2727
除了数据库内核与大量开箱即用的扩展插件以外,Pigsty更是提供了数据库服务所需的完整运行时基础设施,与本地沙箱/生产环境/IaaS全自动部署方案。
2828

2929
您无需依赖任何外部组件或互联网访问,便可以在任何环境中一键拉起生产级的 PostgreSQL RDS [服务](PGSQL-SVC#服务概述),10分钟从全新裸机进入生产可用状态。
@@ -45,7 +45,8 @@ Pigsty 收录了超过 150+ PostgreSQL 扩展插件,编译维护打包了一
4545
您可以使用 [PostGIS](https://postgis.net/) 处理地理空间数据,使用 [TimescaleDB](https://www.timescale.com/) 分析时序/事件流数据,使用 [Citus](https://www.citusdata.com/) 将单机数据库原地改造为水平扩展的分布式数据库集群,
4646
使用 [PGVector](https://github.com/pgvector/pgvector) 存储并搜索 AI 嵌入实现向量数据库的效果,使用 [Apache AGE](https://age.apache.org/) 进行图数据存储与检索实现 Neo4J 的效果,使用 [zhparser](https://github.com/amutu/zhparser) 进行中文分词实现 ElasticSearch 的效果。
4747

48-
Pigsty还包含了完整的编译环境与基础设施,允许您方便地自行[编译](PGSQL-EXTENSION#扩展编译)加装其他没有收录的扩展。
48+
Pigsty 还允许您在裸机高可用 PostgreSQL 集群上自行托管 [Supabase](https://github.com/Vonng/pigsty/tree/master/app/supabase/README.md)[PostgresML](https://github.com/Vonng/pigsty/tree/master/app/pgml) ,并与海量扩展组合使用。
49+
如果您想要的扩展没有被 Pigsty 收录,欢迎提出收录[建议](https://github.com/Vonng/pigsty/discussions/333) 或自行[编译](PGSQL-EXTENSION#扩展编译)加装。
4950

5051
[![pigsty-distro.jpg](https://repo.pigsty.cc/img/pigsty-distro.jpg)](PGSQL-EXTENSION.md)
5152

docs/zh/README.md

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -4,8 +4,6 @@
44
>
55
> —— **开箱即用,本地优先的 RDS PostgreSQL 开源替代**
66
>
7-
> [PostgreSQL](https://www.postgresql.org/) + [PostGIS](https://postgis.net/) + [TimescaleDB](https://www.timescale.com/) + [Citus](https://www.citusdata.com/) + [PGVector](https://github.com/pgvector/pgvector) + [Age](https://age.apache.org/) +[Supabase](https://github.com/Vonng/pigsty/tree/master/app/supabase) + [PostgresML](https://github.com/Vonng/pigsty/tree/master/app/pgml) + [...](PGSQL-EXTENSION.md)
8-
>
97
> 最新版本:[v2.5.0](https://github.com/Vonng/pigsty/releases/tag/v2.5.0) | [仓库](https://github.com/Vonng/pigsty) | [演示](https://demo.pigsty.cc) | [文档](https://doc.pigsty.cc/) | [网站](https://pigsty.cc/zh/) | [博客](https://pigsty.cc/zh/blog) | [论坛](https://github.com/Vonng/pigsty/discussions) | [微信公众号](https://mp.weixin.qq.com/s/-E_-HZ7LvOze5lmzy3QbQA) | [英文文档](/)
108
>
119
> [快速上手](INSTALL.md)`curl -fsSL https://get.pigsty.cc/latest | bash`
@@ -43,7 +41,7 @@ Pigsty 是一个更好的本地开源 RDS for PostgreSQL 替代,具有以下
4341

4442
<details><summary>生态组件与可用扩展列表</summary>
4543

46-
Pigsty has over **150+** [extensions](PGSQL-EXTENSION.md) pre-compiled and packaged, including some not included in the official PGDG repo. Some of the most potent extensions are:
44+
Pigsty 收录了超过 150 个预先编译好、开箱即用的 PostgreSQL [扩展插件](PGSQL-EXTENSION.md)。其中有一些非常强力的扩展:
4745

4846
- PostGIS:地理空间扩展,GIS 事实标准
4947
- TimescaleDB:添加时序/持续聚合/分布式/列存储/自动压缩的能力
@@ -56,6 +54,8 @@ Pigsty has over **150+** [extensions](PGSQL-EXTENSION.md) pre-compiled and packa
5654
- [FerretDB](https://github.com/Vonng/pigsty/tree/master/app/ferretdb):基于 PostgreSQL 的开源 MongoDB 替代。
5755
- [PostgresML](https://github.com/Vonng/pigsty/tree/master/app/pgml):使用SQL完成经典机器学习算法,调用大语言模型。
5856

57+
[PostgreSQL](https://www.postgresql.org/) + [PostGIS](https://postgis.net/) + [TimescaleDB](https://www.timescale.com/) + [Citus](https://www.citusdata.com/) + [PGVector](https://github.com/pgvector/pgvector) + [Age](https://age.apache.org/) +[Supabase](https://github.com/Vonng/pigsty/tree/master/app/supabase) + [PostgresML](https://github.com/Vonng/pigsty/tree/master/app/pgml) + [...](PGSQL-EXTENSION.md)
58+
5959
[![pigsty-extension.jpg](https://repo.pigsty.cc/img/pigsty-extension.jpg)](PGSQL-EXTENSION.md)
6060

6161
| 名称 | 版本 | 来源 | 类型 | 说明 |

0 commit comments

Comments
 (0)