From 309fbb8587513ffae022fdc222bd46171350346a Mon Sep 17 00:00:00 2001 From: Anastasia Alexandrova Date: Wed, 14 Aug 2024 10:35:23 +0300 Subject: [PATCH] Added clear statement that PG is in the distro (#627) * Added clear statement that PG is in the distro modified: docs/extensions.md modified: docs/index.md modified: docs/installing.md modified: docs/release-notes-v16.1.md modified: docs/release-notes-v16.1.upd.md modified: docs/release-notes-v16.2.md modified: docs/release-notes-v16.3.md new file: snippets/release-notes-intro.md --- docs/extensions.md | 4 ++-- docs/index.md | 33 ++++----------------------------- docs/installing.md | 4 ++-- docs/release-notes-v16.1.md | 2 +- docs/release-notes-v16.1.upd.md | 2 +- docs/release-notes-v16.2.md | 2 +- docs/release-notes-v16.3.md | 2 +- snippets/release-notes-intro.md | 3 +++ 8 files changed, 15 insertions(+), 37 deletions(-) create mode 100644 snippets/release-notes-intro.md diff --git a/docs/extensions.md b/docs/extensions.md index d808073c3..4c7dd7d87 100644 --- a/docs/extensions.md +++ b/docs/extensions.md @@ -1,8 +1,8 @@ # Extensions -PostgreSQL extensions are add-ons that enhance the functionality of PostgreSQL databases. By installing these extensions, you can modify and extend your database system with new features, functions, and data types. +Percona Distribution for PostgreSQL is not only the PostgreSQL server. It also includes extensions - the add-ons that enhance the functionality of PostgreSQL database. By installing these extensions, you can modify and extend your database server with new features, functions, and data types. -Percona Distribution for PostgreSQL includes extensions that have been tested to work together. These extensions encompass the following: +Percona Distribution for PostgreSQL includes the extensions that have been tested to work together. These extensions encompass the following: * [PostgreSQL contrib modules and utilities](contrib.md) * Extensions authored by Percona: diff --git a/docs/index.md b/docs/index.md index 45e37d1ad..1a9085ceb 100644 --- a/docs/index.md +++ b/docs/index.md @@ -1,6 +1,8 @@ # Percona Distribution for PostgreSQL 16 Documentation - Percona Distribution for PostgreSQL is a suite of open source software, tools and services required to deploy and maintain a reliable production cluster for PostgreSQL. It includes native PostgreSQL server, enhanced with extensions from open source community that are certified and tested to work together for high availability, backups, security, and monitoring that help ensure the cluster's peak performance. + Percona Distribution for PostgreSQL is a suite of open source software, tools and services required to deploy and maintain a reliable production cluster for PostgreSQL. + + Percona Distribution for PostgreSQL includes [PostgreSQL server :octicons-link-external-16:](https://www.postgresql.org/docs/16/index.html), packaged with extensions from open source community that are certified and tested to work together for high availability, backups, security, and monitoring that help ensure the cluster's peak performance. Part of the solution, Percona Operator for PostgreSQL, makes it easy to orchestrate the cluster reliably and repeatably in Kubernetes. @@ -13,7 +15,7 @@ - Freely available reference architectures for solutions like high-availability, backups and disaster recovery - Spatial data handling support via PostGIS - Monitoring of the database health, performance and infrastructure usage via open source [Percona Management and Monitoring :octicons-link-external-16:](https://www.percona.com/doc/percona-monitoring-and-management/2.x/index.html) with PostgreSQL-specific dashboards -- Run PostgreSQL on Kubernetes using open source [Percona Operator for PostgreSQL:octicons-link-external-16:](https://docs.percona.com/percona-operator-for-postgresql/2.0/index.html). It not only automates deployment and management of PostgreSQL clusters on Kubernetes, but also includes enterprise-ready features for high-availability, backup and restore, replication, logging, and more +- Run PostgreSQL on Kubernetes using open source [Percona Operator for PostgreSQL :octicons-link-external-16:](https://docs.percona.com/percona-operator-for-postgresql/2.0/index.html). It not only automates deployment and management of PostgreSQL clusters on Kubernetes, but also includes enterprise-ready features for high-availability, backup and restore, replication, logging, and more
@@ -49,34 +51,7 @@ Learn about the releases and changes in the Distribution.
-* [Patroni](https://patroni.readthedocs.io/en/latest/) is an HA (High Availability) solution for PostgreSQL. - -* [pgaudit](https://www.pgaudit.org/) provides detailed session or object -audit logging via the standard PostgreSQL logging facility - -* [pgaudit set_user](https://github.com/pgaudit/set_user) - The `set_user` part of `pgAudit` extension provides an additional layer of logging and control when unprivileged users must escalate themselves to superuser or object owner roles in order to perform needed maintenance tasks. - -* [pgBackRest](https://pgbackrest.org/) is a backup and restore solution for -PostgreSQL - -* [pgBadger](https://github.com/darold/pgbadger) - a fast PostgreSQL Log Analyzer. - -* [PgBouncer](https://www.pgbouncer.org/) - a lightweight connection pooler for PostgreSQL - -* [pg_gather](https://github.com/jobinau/pg_gather) - an SQL script to assess the health of PostgreSQL cluster by gathering performance and configuration data from PostgreSQL databases. - -* [pgpool2](https://www.pgpool.net/mediawiki/index.php/Main_Page) - a middleware between PostgreSQL server and client for high availability, connection pooling and load balancing. - -* [pg_repack](https://github.com/reorg/pg_repack) rebuilds -PostgreSQL database objects - -* [pg_stat_monitor](https://github.com/percona/pg_stat_monitor) collects and aggregates statistics for PostgreSQL and provides histogram information. - -* [PostGIS](http://postgis.net/) allows storing and manipulating spacial data in PostgreSQL. - -* [wal2json](https://github.com/eulerto/wal2json) - a PostgreSQL logical decoding JSON output plugin. -* A collection of [additional PostgreSQL contrib extensions](https://www.postgresql.org/docs/{{pgversion}}/contrib.html) diff --git a/docs/installing.md b/docs/installing.md index ca33e4b09..738877148 100644 --- a/docs/installing.md +++ b/docs/installing.md @@ -1,6 +1,6 @@ # Quickstart guide -Percona Distribution for PostgreSQL is the solution with the collection of tools from PostgreSQL community that are tested to work together and serve to assist you in deploying and managing PostgreSQL. [Read more](index.md). +Percona Distribution for PostgreSQL is the PostgreSQL server with the collection of tools from PostgreSQL community that are tested to work together and serve to assist you in deploying and managing PostgreSQL. [Read more](index.md). This document aims to guide database application developers and DevOps engineer in getting started with Percona Distribution for PostgreSQL. Upon completion of this guide, you’ll have Percona Distribution for PostgreSQL installed and operational, and you’ll be able to: @@ -13,7 +13,7 @@ This document aims to guide database application developers and DevOps engineer You can select from multiple easy-to-follow installation options, but **we recommend using a Package Manager** for a convenient and quick way to try the software first. -=== ":simple-windowsterminal: Package manager" +=== ":octicons-terminal-16: Package manager" Percona provides installation packages in `DEB` and `RPM` format for 64-bit Linux distributions. Find the full list of supported platforms and versions on the [Percona Software and Platform Lifecycle page :octicons-link-external-16:](https://www.percona.com/services/policies/percona-software-support-lifecycle#pgsql). diff --git a/docs/release-notes-v16.1.md b/docs/release-notes-v16.1.md index 0f159ec00..900f15e4d 100644 --- a/docs/release-notes-v16.1.md +++ b/docs/release-notes-v16.1.md @@ -2,7 +2,7 @@ [Installation](installing.md){.md-button} -Percona Distribution for PostgreSQL is a solution with the collection of tools from PostgreSQL community that are tested to work together and serve to assist you in deploying and managing PostgreSQL. The aim of Percona Distribution for PostgreSQL is to address the operational issues like High-Availability, Disaster Recovery, Security, Observability, Spatial data handling, Performance and Scalability and others that enterprises are facing. +--8<-- "release-notes-intro.md" This release of Percona Distribution for PostgreSQL is based on [PostgreSQL 16.1 :octicons-link-external-16:](https://www.postgresql.org/docs/16/release-16-1.html). diff --git a/docs/release-notes-v16.1.upd.md b/docs/release-notes-v16.1.upd.md index 1eaf3a84c..6f6788c68 100644 --- a/docs/release-notes-v16.1.upd.md +++ b/docs/release-notes-v16.1.upd.md @@ -2,6 +2,6 @@ [Installation](installing.md){.md-button} -Percona Distribution for PostgreSQL is a solution with the collection of tools from PostgreSQL community that are tested to work together and serve to assist you in deploying and managing PostgreSQL. The aim of Percona Distribution for PostgreSQL is to address the operational issues like High-Availability, Disaster Recovery, Security, Observability, Spatial data handling, Performance and Scalability and others that enterprises are facing. +--8<-- "release-notes-intro.md" This update of Percona Distribution for PostgreSQL includes the new version of [`pg_stat_monitor` 2.0.4 :octicons-link-external-16:](https://docs.percona.com/pg-stat-monitor/release-notes/2.0.4.html) that fixes the issue with the extension causing the deadlock in the Percona Operator for PostgreSQL when executing the `pgsm_store` function. diff --git a/docs/release-notes-v16.2.md b/docs/release-notes-v16.2.md index 00ce5a5de..d8ce16b83 100644 --- a/docs/release-notes-v16.2.md +++ b/docs/release-notes-v16.2.md @@ -2,7 +2,7 @@ [Installation](installing.md){.md-button} -Percona Distribution for PostgreSQL is a solution with the collection of tools from PostgreSQL community that are tested to work together and serve to assist you in deploying and managing PostgreSQL. The aim of Percona Distribution for PostgreSQL is to address the operational issues like High-Availability, Disaster Recovery, Security, Observability, Spatial data handling, Performance and Scalability and others that enterprises are facing. +--8<-- "release-notes-intro.md" This release of Percona Distribution for PostgreSQL is based on [PostgreSQL 16.2 :octicons-link-external-16:](https://www.postgresql.org/docs/16/release-16-2.html). diff --git a/docs/release-notes-v16.3.md b/docs/release-notes-v16.3.md index 7b0d83e13..790949c67 100644 --- a/docs/release-notes-v16.3.md +++ b/docs/release-notes-v16.3.md @@ -2,7 +2,7 @@ [Installation](installing.md){.md-button} -Percona Distribution for PostgreSQL is a solution with the collection of tools from PostgreSQL community that are tested to work together and serve to assist you in deploying and managing PostgreSQL. The aim of Percona Distribution for PostgreSQL is to address the operational issues like High-Availability, Disaster Recovery, Security, Observability, Spatial data handling, Performance and Scalability and others that enterprises are facing. +--8<-- "release-notes-intro.md" This release of Percona Distribution for PostgreSQL is based on [PostgreSQL 16.3](https://www.postgresql.org/docs/16/release-16-3.html). diff --git a/snippets/release-notes-intro.md b/snippets/release-notes-intro.md new file mode 100644 index 000000000..bb0513a20 --- /dev/null +++ b/snippets/release-notes-intro.md @@ -0,0 +1,3 @@ +Percona Distribution for PostgreSQL is a solution that includes PostgreSQL server and the collection of tools from PostgreSQL community. These tools are tested to work together and serve to assist you in deploying and managing PostgreSQL. + +The aim of Percona Distribution for PostgreSQL is to address the operational issues like High-Availability, Disaster Recovery, Security, Observability, Spatial data handling, Performance and Scalability, and others that enterprises are facing. \ No newline at end of file