Skip to content

Commit d77258f

Browse files
author
Jonathan S. Katz
committed
Add a list of included components
This makes it easier to identify which PostgreSQL software and extensions are included with the PostgreSQL Operator. A future commit will also add, to an extent, which versions of each software component are included with the PostgreSQL Operator.
1 parent 35718a5 commit d77258f

File tree

2 files changed

+80
-0
lines changed

2 files changed

+80
-0
lines changed

README.md

Lines changed: 40 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -182,6 +182,46 @@ If you have the PostgreSQL Operator installed in your environment, and are inter
182182

183183
There is also a `pgo-client` container if you wish to deploy the client directly to your Kubernetes environment.
184184

185+
### Included Components
186+
187+
[PostgreSQL containers](https://github.com/CrunchyData/crunchy-containers) deployed with the PostgreSQL Operator include the following components:
188+
189+
- [PostgreSQL](https://www.postgresql.org)
190+
- [PostgreSQL Contrib Modules](https://www.postgresql.org/docs/current/contrib.html)
191+
- [PL/Python + PL/Python 3](https://www.postgresql.org/docs/current/plpython.html)
192+
- [pgAudit](https://www.pgaudit.org/)
193+
- [pgAudit Analyze](https://github.com/pgaudit/pgaudit_analyze)
194+
- [pgnodemx](https://github.com/CrunchyData/pgnodemx)
195+
- [set_user](https://github.com/pgaudit/set_user)
196+
- [wal2json](https://github.com/eulerto/wal2json)
197+
- [pgBackRest](https://pgbackrest.org/)
198+
- [pgBouncer](http://pgbouncer.github.io/)
199+
- [pgAdmin 4](https://www.pgadmin.org/)
200+
- [pgMonitor](https://github.com/CrunchyData/pgmonitor)
201+
- [Patroni](https://patroni.readthedocs.io/)
202+
- [LLVM](https://llvm.org/) (for [JIT compilation](https://www.postgresql.org/docs/current/jit.html))
203+
204+
In addition to the above, the geospatially enhanced PostgreSQL + PostGIS container adds the following components:
205+
206+
- [PostGIS](http://postgis.net/)
207+
- [pgRouting](https://pgrouting.org/)
208+
- [PL/R](https://github.com/postgres-plr/plr)
209+
210+
[PostgreSQL Operator Monitoring](https://crunchydata.github.io/postgres-operator/latest/architecture/monitoring/) uses the following components:
211+
212+
- [pgMonitor](https://github.com/CrunchyData/pgmonitor)
213+
- [Prometheus](https://github.com/prometheus/prometheus)
214+
- [Grafana](https://github.com/grafana/grafana)
215+
- [Alertmanager](https://github.com/prometheus/alertmanager)
216+
217+
Additional containers that are not directly integrated with the PostgreSQL Operator but can work alongside it include:
218+
219+
- [pgPool II](https://access.crunchydata.com/documentation/crunchy-postgres-containers/latest/container-specifications/crunchy-pgpool/)
220+
- [pg_upgrade](https://access.crunchydata.com/documentation/crunchy-postgres-containers/latest/container-specifications/crunchy-upgrade/)
221+
- [pgBench](https://access.crunchydata.com/documentation/crunchy-postgres-containers/latest/container-specifications/crunchy-pgbench/)
222+
223+
For more information about which versions of the PostgreSQL Operator include which components, please visit the [compatibility](https://access.crunchydata.com/documentation/postgres-operator/latest/configuration/compatibility/) section of the documentation.
224+
185225
## Using the PostgreSQL Operator
186226

187227
If you have the PostgreSQL and Client Interface installed in your environment and are interested in guidance on the use of the Crunchy PostgreSQL Operator, please start here:

docs/content/_index.md

Lines changed: 40 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -97,6 +97,46 @@ The Crunchy PostgreSQL Operator makes it easy to get your own PostgreSQL-as-a-Se
9797
The Crunchy PostgreSQL Operator extends Kubernetes to provide a higher-level abstraction for rapid creation and management of PostgreSQL clusters. The Crunchy PostgreSQL Operator leverages a Kubernetes concept referred to as "[Custom Resources](https://kubernetes.io/docs/concepts/extend-kubernetes/api-extension/custom-resources/)” to create several [custom resource definitions (CRDs)](https://kubernetes.io/docs/concepts/extend-kubernetes/api-extension/custom-resources/#customresourcedefinitions) that allow for the management of PostgreSQL clusters.
9898

9999

100+
# Included Components
101+
102+
[PostgreSQL containers](https://github.com/CrunchyData/crunchy-containers) deployed with the PostgreSQL Operator include the following components:
103+
104+
- [PostgreSQL](https://www.postgresql.org)
105+
- [PostgreSQL Contrib Modules](https://www.postgresql.org/docs/current/contrib.html)
106+
- [PL/Python + PL/Python 3](https://www.postgresql.org/docs/current/plpython.html)
107+
- [pgAudit](https://www.pgaudit.org/)
108+
- [pgAudit Analyze](https://github.com/pgaudit/pgaudit_analyze)
109+
- [pgnodemx](https://github.com/CrunchyData/pgnodemx)
110+
- [set_user](https://github.com/pgaudit/set_user)
111+
- [wal2json](https://github.com/eulerto/wal2json)
112+
- [pgBackRest](https://pgbackrest.org/)
113+
- [pgBouncer](http://pgbouncer.github.io/)
114+
- [pgAdmin 4](https://www.pgadmin.org/)
115+
- [pgMonitor](https://github.com/CrunchyData/pgmonitor)
116+
- [Patroni](https://patroni.readthedocs.io/)
117+
- [LLVM](https://llvm.org/) (for [JIT compilation](https://www.postgresql.org/docs/current/jit.html))
118+
119+
In addition to the above, the geospatially enhanced PostgreSQL + PostGIS container adds the following components:
120+
121+
- [PostGIS](http://postgis.net/)
122+
- [pgRouting](https://pgrouting.org/)
123+
- [PL/R](https://github.com/postgres-plr/plr)
124+
125+
[PostgreSQL Operator Monitoring]({{< relref "architecture/monitoring/_index.md" >}}) uses the following components:
126+
127+
- [pgMonitor](https://github.com/CrunchyData/pgmonitor)
128+
- [Prometheus](https://github.com/prometheus/prometheus)
129+
- [Grafana](https://github.com/grafana/grafana)
130+
- [Alertmanager](https://github.com/prometheus/alertmanager)
131+
132+
Additional containers that are not directly integrated with the PostgreSQL Operator but can work alongside it include:
133+
134+
- [pgPool II](https://access.crunchydata.com/documentation/crunchy-postgres-containers/latest/container-specifications/crunchy-pgpool/)
135+
- [pg_upgrade](https://access.crunchydata.com/documentation/crunchy-postgres-containers/latest/container-specifications/crunchy-upgrade/)
136+
- [pgBench](https://access.crunchydata.com/documentation/crunchy-postgres-containers/latest/container-specifications/crunchy-pgbench/)
137+
138+
For more information about which versions of the PostgreSQL Operator include which components, please visit the [compatibility]({{< relref "configuration/compatibility.md" >}}) section of the documentation.
139+
100140
# Supported Platforms
101141

102142
The Crunchy PostgreSQL Operator is tested on the following Platforms:

0 commit comments

Comments
 (0)