Skip to content

Commit 07cc267

Browse files
nastena1606nastena1606
authored
PG-1409 Release notes 17.4.1 (#775)
PG-1409 Release notes 17.4.1 modified: .github/workflows/main.yml modified: docs/apt.md modified: docs/contrib.md modified: docs/enable-extensions.md modified: docs/release-notes-v17.2.md new file: docs/release-notes-v17.4.md modified: docs/release-notes.md modified: docs/telemetry.md modified: mkdocs-base.yml modified: mkdocs-pdf.yml modified: variables.yml * Separated spell checking into a separate GH action * Updated components versions and date * Updated pg_tde highlight
1 parent 0485645 commit 07cc267

12 files changed

+140
-26
lines changed

‎.github/workflows/main.yml

+3-15
Original file line numberDiff line numberDiff line change
@@ -12,12 +12,12 @@ jobs:
1212
steps:
1313
#Pull the latest changes
1414
- name: Chekout code
15-
uses: actions/checkout@v2
15+
uses: actions/checkout@11bd71901bbe5b1630ceea73d27597364c9af683 # v4.2.2
1616
with:
1717
fetch-depth: 0
1818
#Prepare the env
1919
- name: Set up Python
20-
uses: actions/setup-python@v2
20+
uses: actions/setup-python@0b93645e9fea7318ecaed2b359559ac225c90a2b # v5.3.0
2121
with:
2222
python-version: '3.x'
2323

@@ -46,18 +46,6 @@ jobs:
4646
mike set-default 17 -b publish -p
4747
mike retitle 17 "17 (LATEST)" -b publish -p
4848
49-
# - name: Install Node.js 14.x
50-
# uses: percona-platform/setup-node@v2
51-
# with:
52-
# node-version: "14"
53-
#
54-
# - name: Spelling
55-
# run: |
56-
# npx markdown-spellcheck --report --en-us --ignore-acronyms --ignore-numbers "docs/**/*.md" || true
57-
# Ignore errors, just inspect results
58-
# - name: Grammar
59-
# run: |
60-
# npx write-good --no-passive docs/**/*.md || true
61-
# # Ignore errors, just inspect results
49+
6250

6351

‎.github/workflows/spellcheck.yml

+48
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,48 @@
1+
name: Check spelling in Percona Distribution PostgreSQL 17 docs
2+
on:
3+
pull_request:
4+
branches:
5+
- 17
6+
7+
jobs:
8+
build:
9+
name: Check spelling
10+
runs-on: ubuntu-latest
11+
12+
steps:
13+
#Pull the latest changes
14+
- name: Chekout code
15+
uses: actions/checkout@11bd71901bbe5b1630ceea73d27597364c9af683 # v4.2.2
16+
with:
17+
fetch-depth: 0
18+
#Prepare the env
19+
- name: Set up Python
20+
uses: actions/setup-python@0b93645e9fea7318ecaed2b359559ac225c90a2b # v5.3.0
21+
with:
22+
python-version: '3.x'
23+
24+
#Configure git
25+
- name: Configure git
26+
env:
27+
ROBOT_TOKEN: ${{ secrets.ROBOT_TOKEN }}
28+
run: |
29+
git config --global url."https://percona-platform-robot:${ROBOT_TOKEN}@github.com".insteadOf "https://github.com"
30+
git config user.name "GitHub Action"
31+
git config user.email "[email protected]"
32+
git config user.password "${ROBOT_TOKEN}"
33+
echo "GIT_USER=percona-platform-robot:${ROBOT_TOKEN}" >> $GITHUB_ENV
34+
35+
- name: Install Node.js 14.x
36+
uses: percona-platform/setup-node@v2
37+
with:
38+
node-version: "14"
39+
40+
- name: Spelling
41+
run: |
42+
npx markdown-spellcheck --report --en-us --ignore-acronyms --ignore-numbers "docs/**/*.md" || true
43+
# Ignore errors, just inspect results
44+
45+
- name: Grammar
46+
run: |
47+
npx write-good --no-passive docs/**/*.md || true
48+
# Ignore errors, just inspect results

‎docs/apt.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -48,7 +48,7 @@ Run all the commands in the following sections as root or using the `sudo` comma
4848

4949
### Install packages
5050

51-
=== "Install using meta-package"
51+
=== "Install using meta-package (deprecated)"
5252

5353
The [meta package](repo-overview.md#percona-ppg-server){:target=”_blank”} enables you to install several components of the distribution in one go.
5454

‎docs/contrib.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -33,7 +33,7 @@ Find the list of controb modules and extensions included in Percona Distribution
3333
|[pg_freespacemap](https://www.postgresql.org/docs/{{pgversion}}/pgfreespacemap.html) |Required |Provides a means of examining the free space map (FSM), which PostgreSQL uses to track the locations of available space in tables and indexes. This can be useful for understanding space utilization and planning for maintenance operations. |
3434
|[pg_prewarm](https://www.postgresql.org/docs/{{pgversion}}/pgprewarm.html) | | Provides a convenient way to load relation data into either the operating system buffer cache or the PostgreSQL buffer cache. This can be useful for reducing the time needed for a newly started database to reach its full performance potential by preloading frequently accessed data.|
3535
|[pgrowlocks](https://www.postgresql.org/docs/{{pgversion}}/pgrowlocks.html) | Required |Provides a function to show row locking information for a specified table. |
36-
|[pg_stat_statements](https://www.postgresql.org/docs/{{pgversion}}/pgstatstatements.html) | Required |A module for tracking planning and execution statistics of all SQL statements executed by a server. Consider using an advanced version of `pg_stat_statements` - [pg_stat_monitor :octicons-link-external-16:](https://github.com/percona/pg_stat_monitor) |
36+
|[pg_stat_statements](https://www.postgresql.org/docs/{{pgversion}}/pgstatstatements.html) | Required |A module for tracking planning and execution statistics of all SQL statements executed by a server. Consider using an advanced version of `pg_stat_statements` - [pg_stat_monitor :octicons-link-external-16:](https://github.com/percona/pg_stat_monitor/index.html) |
3737
|[pgstattuple](https://www.postgresql.org/docs/{{pgversion}}/pgstattuple.html) | Required |Povides various functions to obtain tuple-level statistics. It offers detailed information about tables and indexes, such as the amount of free space and the number of live and dead tuples. |
3838
|[pg_surgery](https://www.postgresql.org/docs/{{pgversion}}/pgsurgery.html) | Required | Provides various functions to perform surgery on a damaged relation. These functions are unsafe by design and using them may corrupt (or further corrupt) your database. Use them with caution and only as a last resort|
3939
|[pg_trgm](https://www.postgresql.org/docs/{{pgversion}}/pgtrgm.html) | |Provides functions and operators for determining the similarity of alphanumeric text based on trigram matching. A trigram is a contiguous sequence of three characters. The extension can be used for text search and pattern matching operations. |

‎docs/release-notes-v17.2.md

+2-2
Original file line numberDiff line numberDiff line change
@@ -7,8 +7,8 @@ This release of Percona Distribution for PostgreSQL is based on Percona Server f
77
## Release Highlights
88

99
* This release includes fixes for [CVE-2024-10978](https://www.postgresql.org/support/security/CVE-2024-10978/) and for certain PostgreSQL extensions that break because they depend on the modified Application Binary Interface (ABI). These regressions were introduced in PostgreSQL 17.1, 16.5, 15.9, 14.14, 13.17, and 12.21. For this reason, the release of Percona Distribution for PostgreSQL 17.1.1 has been skipped.
10-
* Percona Distribution for PostgreSQL includes [`pgvector` :octicons-link-external-16](https://github.com/pgvector/pgvector) - an open source extension that enables you to use PostgreSQL as a vector database. It brings vector data type and vector operations (mainly similarity search) to PostgreSQL. You can install `pgvector` from repositories, tarballs, and it is also available as a Docker image.
11-
* The new version of `pg_tde` extension features index encryption and the support of storing encryption keys in KMIP-compatible servers. These feature come with the Beta version of the `tde_heap` access method. Learn more in the [pg_tde release notes :octicons-link-external-16:](https://docs.percona.com/pg-tde/release-notes/release-notes.html)
10+
* Percona Distribution for PostgreSQL includes [`pgvector` :octicons-link-external-16:](https://github.com/pgvector/pgvector) - an open source extension that enables you to use PostgreSQL as a vector database. It brings vector data type and vector operations (mainly similarity search) to PostgreSQL. You can install `pgvector` from repositories, tarballs, and it is also available as a Docker image.
11+
* The new version of `pg_tde` extension features index encryption and the support of storing encryption keys in KMIP-compatible servers. These feature come with the Beta version of the `tde_heap` access method. Learn more in the [pg_tde release notes :octicons-link-external-16:](https://docs.percona.com/pg-tde/release-notes/beta2.html)
1212
* The `pg_tde` extension itself is now a part of the Percona Server for PostgreSQL server package and a Docker image. If you installed the extension before, from its individual package, uninstall it first to avoid conflicts during the upgrade. See the [Minor Upgrade of Percona Distribution for PostgreSQL](minor-upgrade.md#before-you-start) for details.
1313
For how to run `pg_tde` in Docker, check the [Enable encryption](docker.md#enable-encryption) section in the documentation.
1414
* Percona Distribution for PostgreSQL now statically links `llvmjit.so` library for Red Hat Enterprise Linux 8 and 9 and compatible derivatives. This resolves the conflict between the LLVM version required by Percona Distribution for PostgreSQL and the one supplied with the operating system. This also enables you to use the LLVM modules supplied with the operating system for other software you require.

‎docs/release-notes-v17.4.md

+57
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,57 @@
1+
# Percona Distribution for PostgreSQL 17.4.1 ({{date.17_4}})
2+
3+
--8<-- "release-notes-intro.md"
4+
5+
This release of Percona Distribution for PostgreSQL is based on Percona Server for PostgreSQL 17.4.1 - a binary compatible, open source drop in replacement of [PostgreSQL Community 17.4](https://www.postgresql.org/docs/17/release-17-4.html).
6+
7+
## Release Highlights
8+
9+
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.
10+
11+
### A new version of `pg_tde`
12+
13+
Percona Distribution for PostgreSQL includes the Release Candidate of `pg_tde` extension that brings in Transparent Data Encryption. This version of `pg_tde` provides a bunch of improvements, among which is the redesigned WAL encryption, simplified configuration for single-tenant environments, the ability to change key provider configuration offline, and more. Learn about these features in the [`pg_tde` release notes :octicons-link-external-16:](https://docs.percona.com/pg-tde/release-notes/rc.html).
14+
15+
### Improved security and user experience for Docker images
16+
17+
* 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.
18+
19+
* 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.
20+
21+
### PostGIS is included into tarballs
22+
23+
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).
24+
25+
### Deprecation of meta packages
26+
27+
[Meta-packages for Percona Distribution for PostgreSQL](repo-overview.md#repository-contents) are deprecated and will be removed in future releases.
28+
29+
## Supplied third-party extensions
30+
31+
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.
32+
33+
| Extension | Version | Description |
34+
|--------------------------------------------------------------------------------------|-----------|----------------------------------------------------------------------------------------------------------------------|
35+
| [etcd :octicons-link-external-16:](https://etcd.io/) | 3.5.18 | A distributed, reliable key-value store for setting up high available Patroni clusters |
36+
| [HAProxy :octicons-link-external-16:](http://www.haproxy.org/) | 2.8.13 | A high-availability and load-balancing solution |
37+
| [Patroni :octicons-link-external-16:](https://patroni.readthedocs.io/en/latest/) | 4.0.5 | A HA (High Availability) solution for PostgreSQL |
38+
| [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 |
39+
| [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. |
40+
| [pgBackRest :octicons-link-external-16:](https://pgbackrest.org/) | 2.54.2 | A backup and restore solution for PostgreSQL |
41+
| [pgBadger :octicons-link-external-16:](https://github.com/darold/pgbadger) | 13.1 | A fast PostgreSQL Log Analyzer |
42+
| [PgBouncer :octicons-link-external-16:](https://www.pgbouncer.org/) | 1.24.0 | A lightweight connection pooler for PostgreSQL |
43+
| [pg_gather :octicons-link-external-16:](https://github.com/jobinau/pg_gather) | v29 | An SQL script for running the diagnostics of the health of a PostgreSQL cluster |
44+
| [pgpool2 :octicons-link-external-16:](https://git.postgresql.org/gitweb/?p=pgpool2.git;a=summary) | 4.5.5 | A middleware between PostgreSQL server and client for high availability, connection pooling, and load balancing |
45+
| [pg_repack :octicons-link-external-16:](https://github.com/reorg/pg_repack) | 1.5.2 | Rebuilds PostgreSQL database objects |
46+
| [pg_stat_monitor :octicons-link-external-16:](https://github.com/percona/pg_stat_monitor) | {{pgsmversion}} | Collects and aggregates statistics for PostgreSQL and provides histogram information |
47+
| [pgvector :octicons-link-external-16:](https://github.com/pgvector/pgvector) | v0.8.0 | A vector similarity search for PostgreSQL |
48+
| [PostGIS :octicons-link-external-16:](https://github.com/postgis/postgis) | 3.3.8 | A spatial extension for PostgreSQL |
49+
| [PostgreSQL Common :octicons-link-external-16:](https://salsa.debian.org/postgresql/postgresql-common) | 267 | PostgreSQL database-cluster manager. Supports multiple PostgreSQL versions and clusters simultaneously |
50+
| [wal2json :octicons-link-external-16:](https://github.com/eulerto/wal2json) | 2.6 | A PostgreSQL logical decoding JSON output plugin |
51+
52+
53+
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.
54+
55+
Percona Distribution for PostgreSQL is also shipped with the [libpq](https://www.postgresql.org/docs/17/libpq.html) library. It contains "a set of
56+
library functions that allow client programs to pass queries to the PostgreSQL
57+
backend server and to receive the results of these queries."

‎docs/release-notes.md

+1
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,5 @@
11
# Percona Distribution for PostgreSQL release notes
22

3+
* [Percona Distribution for PostgreSQL 17.4.1](release-notes-v17.4.md) ({{date.17_4}})
34
* [Percona Distribution for PostgreSQL 17.2.1](release-notes-v17.2.md) ({{date.17_2}})
45
* [Percona Distribution for PostgreSQL 17.0.1](release-notes-v17.0.md) ({{date.17_0}})

‎docs/solutions/postgis-deploy.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -68,7 +68,7 @@ The following document provides guidelines how to install PostGIS and how to run
6868

6969
=== ":octicons-download-16: From tarballs"
7070

71-
PostGIS is included into binary tarball and is a part of the `percona-postgresql{{pgversion}}` binary. Use the [install from tarballs](../tarball/.md) tutorial to install it.
71+
PostGIS is included into binary tarball and is a part of the `percona-postgresql{{pgversion}}` binary. Use the [install from tarballs](../tarball.md) tutorial to install it.
7272

7373

7474
## Enable PostGIS extension

‎docs/templates/pdf_cover_page.tpl

+1-1
Original file line numberDiff line numberDiff line change
@@ -7,6 +7,6 @@
77
{% if config.site_description %}
88
<h1>{{ config.site_description }}</h1>
99
{% endif %}
10-
<h2>17.4 (March 26, 2025)</h2>
10+
<h2>17.4 (March 27, 2025)</h2>
1111
<!--<h3>Percona Technical Documentation Team</h3>-->
1212

‎mkdocs-pdf.yml

+17
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,17 @@
1+
# MkDocs configuration for PDF builds
2+
# Usage: ENABLE_PDF_EXPORT=1 mkdocs build -f mkdocs-pdf.yml
3+
4+
INHERIT: mkdocs-base.yml
5+
6+
copyright: Percona LLC, &#169; 2025
7+
8+
extra_css:
9+
- https://unicons.iconscout.com/release/v3.0.3/css/line.css
10+
- https://cdnjs.cloudflare.com/ajax/libs/font-awesome/4.4.0/css/font-awesome.min.css
11+
- css/percona.css
12+
- css/extra.css
13+
- css/osano.css
14+
15+
markdown_extensions:
16+
pymdownx.tabbed: {}
17+
admonition: {}

‎mkdocs.yml

+1
Original file line numberDiff line numberDiff line change
@@ -75,6 +75,7 @@ nav:
7575
- Uninstall: uninstalling.md
7676
- Release Notes:
7777
- "Release notes index": "release-notes.md"
78+
- release-notes-v17.4.md
7879
- release-notes-v17.2.md
7980
- release-notes-v17.0.md
8081
- Reference:

‎variables.yml

+7-5
Original file line numberDiff line numberDiff line change
@@ -1,15 +1,17 @@
11
# PG Variables set for HTML output
22
# See also mkdocs.yml plugins.with-pdf.cover_subtitle and output_path
33

4-
release: 'release-notes-v17.2'
5-
dockertag: '17.2'
4+
release: 'release-notes-v17.4'
5+
dockertag: '17.4'
66
pgversion: '17'
7-
pgsmversion: '2.1.0'
8-
pspgversion: '17.2.1'
7+
pgsmversion: '2.1.1'
8+
pspgversion: '17.4.1'
99

1010

1111

1212
date:
13-
17_0: 2024-10-03
13+
17_4: 2025-03-27
1414
17_2: 2024-12-26
15+
17_0: 2024-10-03
16+
1517

0 commit comments

Comments
 (0)