PG-1567-Release-notes-17.5.1 (#792)

Andriciuc · web-flow · commit 2085d45ed582 · 2025-05-29T10:12:53.000+03:00
* Created release notes 17.5.1 file

* small fixes and updates to ver nr

* Updated with latest version and dates

updated versions for 17.5.1 and toc

* Update variables.yml

* updated release and major upgrade

added in release notes a note that major upgrade got upgraded, and added the updates from pg-1599 for the major upgrade chapter

* small fix

fixed the version nr for the topic

* updated date of release and tarball preconditions

Updated preconditions with Naeem's feedback

* Update release-notes-v17.5.md

added more details to pg_tde for RC2 release
diff --git a/docs/major-upgrade.md b/docs/major-upgrade.md
diff --git a/docs/release-notes-v17.5.md b/docs/release-notes-v17.5.md
@@ -0,0 +1,59 @@
+# Percona Distribution for PostgreSQL 17.5.1 ({{date.17_5}})
+
+--8<-- "release-notes-intro.md"
+
+This release of Percona Distribution for PostgreSQL is based on Percona Server for PostgreSQL 17.5.1 - a binary compatible, open source drop in replacement of [PostgreSQL Community 17.5](https://www.postgresql.org/docs/17/release-17-5.html).
+
+## Release Highlights
+
+This release fixes [CVE-2025-1094](https://www.postgresql.org/support/security/CVE-2025-1094/), which closed a vulnerability in the `libpq` PostgreSQL client library but introduced a regression related to string handling for non-null terminated strings. The error would be visible based on how a PostgreSQL client implemented this behavior. This regression affects versions 17.3, 16.7, 15.11, 14.16, and 13.19. For this reason, version 17.3 was skipped.
+
+### A new version of `pg_tde`
+
+Percona Distribution for PostgreSQL includes the Release Candidate 2 (RC2) of `pg_tde` extension that brings in Transparent Data Encryption. This version of `pg_tde` provides a bunch of improvements, among which is WAL encryption now supporting Vault, automatic WAL internal key generation at server startup, new visibility and verification functions for default principal keys, and more. Learn about these features in the [`pg_tde` release notes :octicons-link-external-16:](https://docs.percona.com/pg-tde/release-notes/rc2.html).  
+
+### Improved security and user experience for Docker images
+
+* Percona Distribution for PostgreSQL Docker image is now based on Universal Base Image (UBI) version 9, which includes the latest security fixes. This makes the image compliant with the Red Hat certification and ensures the seamless work of containers on Red Hat OpenShift Container Platform.
+
+* You no longer have to specify the `{{dockertag}}-multi` tag when you run Percona Distribution for PostgreSQL in Docker. Instead, use the `percona/percona-distribution-postgresql:{{dockertag}}`. Docker automatically identifies the architecture of your operating system and pulls the corresponding image. Refer to [Run in Docker](docker.md) for how to get started.
+
+### PostGIS is included into tarballs
+
+We have extended Percona Distribution for PostgreSQL tarballs with PostGIS - an open-source extension to handle spacial data. This way you can install and run PostgreSQL as a geospatial database on hosts without a direct access to the Internet. Learn more about [installing from tarballs](tarball.md) and [Spacial data manipulation](solutions/postgis.md).
+
+### Deprecation of meta packages
+
+[Meta-packages for Percona Distribution for PostgreSQL](repo-overview.md#repository-contents) are deprecated and will be removed in future releases.
+
+### Updated Major upgrade topic in documentation
+
+The [Upgrading Percona Distribution for PostgreSQL from 16 to 17](major-upgrade.md) guide has been updated with revised steps for the [On Debian and Ubuntu using `apt`](major-upgrade.md/#on-debian-and-ubuntu-using-apt) section, improving clarity and reliability of the upgrade process.
+
+## Supplied third-party extensions
+
+Review each extension’s release notes for What’s new, improvements, or bug fixes. The following is the list of extensions available in Percona Distribution for PostgreSQL.
+
+| Extension                                                                            | Version   | Description                                                                                                          |
+|--------------------------------------------------------------------------------------|-----------|----------------------------------------------------------------------------------------------------------------------|
+| [etcd :octicons-link-external-16:](https://etcd.io/)                                                             | 3.5.21    | A distributed, reliable key-value store for setting up high available Patroni clusters                              |
+| [HAProxy :octicons-link-external-16:](http://www.haproxy.org/)                       | 2.8.15    | A high-availability and load-balancing solution                                                                     |
+| [Patroni :octicons-link-external-16:](https://patroni.readthedocs.io/en/latest/)     | 4.0.5     | A HA (High Availability) solution for PostgreSQL                                                                    |
+| [PgAudit :octicons-link-external-16:](https://www.pgaudit.org/)                      | 17.1      | Provides detailed session or object audit logging via the standard logging facility provided by PostgreSQL          |
+| [pgAudit set_user :octicons-link-external-16:](https://github.com/pgaudit/set_user)  | 4.1.0     | Provides an additional layer of logging and control when unprivileged users must escalate roles for maintenance.     |
+| [pgBackRest :octicons-link-external-16:](https://pgbackrest.org/)                    | 2.55.0    | A backup and restore solution for PostgreSQL                                                                        |
+| [pgBadger :octicons-link-external-16:](https://github.com/darold/pgbadger)           | 13.1      | A fast PostgreSQL Log Analyzer                                                                                      |
+| [PgBouncer :octicons-link-external-16:](https://www.pgbouncer.org/)                  | 1.24.1    | A lightweight connection pooler for PostgreSQL                                                                      |
+| [pg_gather :octicons-link-external-16:](https://github.com/jobinau/pg_gather)        | v30       | An SQL script for running the diagnostics of the health of a PostgreSQL cluster                                     |
+| [pgpool2 :octicons-link-external-16:](https://git.postgresql.org/gitweb/?p=pgpool2.git;a=summary) | 4.6.0 | A middleware between PostgreSQL server and client for high availability, connection pooling, and load balancing      |
+| [pg_repack :octicons-link-external-16:](https://github.com/reorg/pg_repack)          | 1.5.2     | Rebuilds PostgreSQL database objects                                                                                |
+| [pgvector :octicons-link-external-16:](https://github.com/pgvector/pgvector)         | v0.8.0    | A vector similarity search for PostgreSQL                                                                           |
+| [PostGIS :octicons-link-external-16:](https://github.com/postgis/postgis)            | 3.3.8     | A spatial extension for PostgreSQL                                                                                  |
+| [PostgreSQL Common :octicons-link-external-16:](https://salsa.debian.org/postgresql/postgresql-common) | 277 | PostgreSQL database-cluster manager. Supports multiple PostgreSQL versions and clusters simultaneously              |
+| [wal2json :octicons-link-external-16:](https://github.com/eulerto/wal2json)          | 2.6       | A PostgreSQL logical decoding JSON output plugin                                                                    |
+
+For Red Hat Enterprise Linux 8 and compatible derivatives, Percona Distribution for PostgreSQL also includes the  supplemental `python3-etcd` 0.4.5 packages, which are used for setting up Patroni clusters.
+
+Percona Distribution for PostgreSQL is also shipped with the [libpq](https://www.postgresql.org/docs/17/libpq.html) library. It contains "a set of
+library functions that allow client programs to pass queries to the PostgreSQL
+backend server and to receive the results of these queries."
diff --git a/docs/release-notes.md b/docs/release-notes.md
@@ -1,5 +1,6 @@
-# Percona Distribution for PostgreSQL release notes 
+# Percona Distribution for PostgreSQL release notes
 
+* [Percona Distribution for PostgreSQL 17.5.1](release-notes-v17.5.md) ({{date.17_5}})
 * [Percona Distribution for PostgreSQL 17.4.1](release-notes-v17.4.md) ({{date.17_4}})
 * [Percona Distribution for PostgreSQL 17.2.1](release-notes-v17.2.md) ({{date.17_2}})
 * [Percona Distribution for PostgreSQL 17.0.1](release-notes-v17.0.md) ({{date.17_0}})
diff --git a/docs/tarball.md b/docs/tarball.md
@@ -44,7 +44,13 @@ The tarballs include the following components:
 === "Debian and Ubuntu"
 
     1. Uninstall the upstream PostgreSQL package.
-    2. Create the user to own the PostgreSQL process. For example, `mypguser`. Run the following command:
+    2. Ensure that the `libreadline` is present on the system, as it is **required** for tarballs to work correctly:
+
+        ```{.bash data-prompt="$"}
+        $ sudo apt install -y libreadline-dev
+        ```
+
+    3. Create the user to own the PostgreSQL process. For example, `mypguser`. Run the following command:
 
         ```{.bash data-prompt="$"}
         $ sudo useradd -m mypguser
@@ -58,6 +64,12 @@ The tarballs include the following components:
     
 === "RHEL and derivatives"
 
+    Ensure that the `libreadline` is present on the system, as it is **required** for tarballs to work correctly:
+
+    ```{.bash data-prompt="$"}
+    $ sudo yum install -y readline-devel
+    ```
+
     Create the user to own the PostgreSQL process. For example, `mypguser`, Run the following command:
         
     ```{.bash data-prompt="$"}
diff --git a/docs/templates/pdf_cover_page.tpl b/docs/templates/pdf_cover_page.tpl
@@ -7,6 +7,6 @@
 {% if config.site_description %}
 <h1>{{ config.site_description }}</h1>
 {% endif %} 
-<h2>17.4 (March 27, 2025)</h2>
+<h2>17.5.1 (May , 2025)</h2>
 <!--<h3>Percona Technical Documentation Team</h3>-->
 
diff --git a/mkdocs-base.yml b/mkdocs-base.yml
@@ -221,6 +221,7 @@ nav:
   - troubleshooting.md
   - uninstalling.md
   - release-notes.md
+  - release-notes-v17.5.md
   - release-notes-v17.4.md
   - release-notes-v17.2.md
   - release-notes-v17.0.md
diff --git a/mkdocs.yml b/mkdocs.yml
@@ -75,6 +75,7 @@ nav:
   - Uninstall: uninstalling.md
   - Release Notes:
       - "Release notes index": "release-notes.md"
+      - release-notes-v17.5.md
       - release-notes-v17.4.md
       - release-notes-v17.2.md
       - release-notes-v17.0.md
diff --git a/variables.yml b/variables.yml
@@ -1,15 +1,15 @@
 # PG Variables set for HTML output
 # See also mkdocs.yml plugins.with-pdf.cover_subtitle and output_path
 
-release: 'release-notes-v17.4'
-dockertag: '17.4'
+release: 'release-notes-v17.5'
+dockertag: '17.5'
 pgversion: '17'
-pgsmversion: '2.1.1'
-pspgversion: '17.4.1'
+pspgversion: '17.5.1'
 
 
 
 date:
+  17_5: 2025-05-28
   17_4: 2025-03-27
   17_2: 2024-12-26
   17_0: 2024-10-03
