Skip to content

Add WAL release note for 2.0 release #482

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
wants to merge 8 commits into
base: TDE_REL_17_STABLE
Choose a base branch
from
Open
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
Original file line number Diff line number Diff line change
@@ -1,22 +1,22 @@
# pg_tde 1.0 ({{date.GA10}})

The `pg_tde` by Percona extension brings in [Transparent Data Encryption (TDE) :octicons-link-external-16:](../index/index.md) to PostgreSQL and enables you to keep sensitive data safe and secure.
The `pg_tde` by Percona extension brings in [Transparent Data Encryption (TDE) :octicons-link-external-16:](../index/about-tde.md) to PostgreSQL and enables you to keep sensitive data safe and secure.

[Get Started](../install.md){.md-button}

## Release Highlights

* **`pg_tde` 1.0 is now GA (Generally Available)**

And **stable** for encrypting relational data in PostgreSQL using [Transparent Data Encryption (TDE) :octicons-link-external-16:](../index/index.md). This milestone brings production-level data protection to PostgreSQL workloads.
And **stable** for encrypting relational data in PostgreSQL using [Transparent Data Encryption (TDE) :octicons-link-external-16:](../index/about-tde.md). This milestone brings production-level data protection to PostgreSQL workloads.

* **WAL encryption is still in Beta**

The WAL encryption feature is currently still in beta and is not effective unless explicitly enabled. **It is not yet production ready.** Do **not** enable this feature in production environments.

## Upgrade considerations

`pg_tde` ({{tdeversion}}) is **not** backward compatible with previous `pg_tde` versions, like Release Candidate 2, due to significant changes in code. This means you **cannot** directly upgrade from one version to another. You must do **a clean installation** of `pg_tde`.
`pg_tde` 1.0 is **not** backward compatible with previous `pg_tde` versions, like Release Candidate 2, due to significant changes in code. This means you **cannot** directly upgrade from one version to another. You must do **a clean installation** of `pg_tde`.

## Known issues

Expand Down
Original file line number Diff line number Diff line change
@@ -0,0 +1,39 @@
# pg_tde 2.0 ({{date.GA20}})

The `pg_tde` by Percona extension brings in [Transparent Data Encryption (TDE)](../index/about-tde.md) to PostgreSQL and enables you to keep sensitive data safe and secure.

[Get Started](../install.md){.md-button}

## Release Highlights

### WAL encryption is now generally available

The WAL (Write-Ahead Logging) encryption feature is now fully supported and production-ready, it adds secure logging to `pg_tde`, expanding Percona's PostgreSQL encryption coverage by enabling secure, transparent encryption of write-ahead logs using the same key infrastructure as data encryption.

### Documentation updates

* Updated the [Limitations](../index/tde-limitations.md) topic to include WAL encryption limitations and supported tools.

## Known issues

* The default `mlock` limit on Rocky Linux 8 for ARM64-based architectures equals the memory page size and is 64 Kb. This results in the child process with `pg_tde` failing to allocate another memory page because the max memory limit is reached by the parent process.

To prevent this, you can change the `mlock` limit to be at least twice bigger than the memory page size:

* temporarily for the current session using the `ulimit -l <value>` command.
* set a new hard limit in the `/etc/security/limits.conf` file. To do so, you require the superuser privileges.

Adjust the limits with caution since it affects other processes running in your system.

## Changelog

### New Features

- [PG-1037](https://perconadev.atlassian.net/browse/PG-1037) Make `pg_rewind` work with encrypted WAL

### Improvements

### Bugs Fixed

- [PG-1391](https://perconadev.atlassian.net/browse/PG-1391) Prevent WAL key mismatches on replicas after `pg_basebackup`
- [PG-1452](https://perconadev.atlassian.net/browse/PG-1452) `pg_tde_change_key_provider` did not work without `-D` flag even if `PGDATA` was set
Original file line number Diff line number Diff line change
Expand Up @@ -4,6 +4,7 @@ This page lists all release notes for `pg_tde`, organized by year and version. U

## 2025

* [2.0](release-notes-v2.0.md) ({{date.GA20}})
* [1.0](release-notes-v1.0.md) ({{date.GA10}})
* [Release Candidate 2 (RC2)](rc2.md) ({{date.RC2}})
* [Release Candidate 1 (RC1)](rc.md) ({{date.RC}})
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -7,5 +7,5 @@
{% if config.site_description %}
<h1>{{ config.site_description }}</h1>
{% endif %}
<h2> 1.0 (2025-06-30)</h2>
<h2> 2.0 (2025-08-30)</h2>
<!--<h3>Percona Technical Documentation Team</h3>-->
1 change: 1 addition & 0 deletions contrib/pg_tde/documentation/mkdocs.yml
Original file line number Diff line number Diff line change
Expand Up @@ -207,6 +207,7 @@ nav:
- "Release notes":
- "Release notes index": release-notes/release-notes.md
- "2025":
- "2.0": release-notes/release-notes-v2.0.md
- "1.0": release-notes/release-notes-v1.0.md
- "Release Candidate 2": release-notes/rc2.md
- "Release Candidate 1": release-notes/rc.md
Expand Down
7 changes: 4 additions & 3 deletions contrib/pg_tde/documentation/variables.yml
Original file line number Diff line number Diff line change
@@ -1,12 +1,13 @@
#Variables used throughout the docs

latestreleasenotes: 'release-notes-v1.0'
tdeversion: '1.0'
release: '1.0'
latestreleasenotes: 'release-notes-v2.0'
tdeversion: '2.0'
release: '2.0'
pgversion17: '17.5'
tdebranch: release-17.5.2

date:
GA20: '2025-08-30'
GA10: '2025-06-30'
RC2: '2025-05-29'
RC: '2025-03-27'