Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
19 commits
Select commit Hold shift + click to select a range
b3e4113
add 2.0 release note - initial document
Andriciuc Jul 22, 2025
e9b8012
add more information in features, improvements and bug fixes, update …
Andriciuc Jul 29, 2025
3f515e3
Merge branch 'TDE_REL_17_STABLE' into wal-release-notes
Andriciuc Jul 29, 2025
f0d5fa1
Merge branch 'TDE_REL_17_STABLE' into wal-release-notes
Andriciuc Aug 5, 2025
fe915eb
Merge branch 'TDE_REL_17_STABLE' into wal-release-notes
Andriciuc Aug 7, 2025
9df7b23
Merge branch 'TDE_REL_17_STABLE' into wal-release-notes
Andriciuc Aug 12, 2025
3ab0b53
Merge branch 'TDE_REL_17_STABLE' into wal-release-notes
Andriciuc Aug 13, 2025
c58f4a7
add links to rn 2.0
Andriciuc Aug 14, 2025
6b32eeb
move current release notes from 2025 out of 2025 folder in toc (folde…
Andriciuc Aug 19, 2025
b3b7e89
Update the Features topic buttons for better clarity (#508)
Andriciuc Aug 20, 2025
2713091
Merge branch 'TDE_REL_17_STABLE' into wal-release-notes
Andriciuc Aug 20, 2025
88b6b07
Merge branch 'release-17.5.3' into wal-release-notes
Andriciuc Aug 20, 2025
95e9c4e
add WAL encryption jira to new features and remove a misplaced word
Andriciuc Aug 20, 2025
6add445
add upgrade limitation warning
Andriciuc Aug 21, 2025
d84fe1e
Merge branch 'release-17.5.3' into wal-release-notes
Andriciuc Aug 22, 2025
9cf5c08
Merge branch 'release-17.5.3' into wal-release-notes
Andriciuc Aug 22, 2025
d51b495
populate the release notes with features, improvements, bug fixes, do…
Andriciuc Aug 22, 2025
acc435b
add first round of feedback, remove superfluous information and unnee…
Andriciuc Aug 22, 2025
3ace8da
remove two unrequired PG's and fixed New Features list
Andriciuc Aug 25, 2025
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,74 @@
# pg_tde 2.0 ({{date.GA20}})

The `pg_tde` by Percona extension brings [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 write-ahead 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.

### WAL encryption upgrade limitation

Clusters that used WAL encryption in the beta release (`pg_tde` 1.0 or older) cannot be upgraded to `pg_tde` 2.0. The following error indicates that WAL encryption was enabled:

```sql
FATAL: principal key not configured
HINT: Use pg_tde_set_server_key_using_global_key_provider() to configure one.
```

Clusters that did not use WAL encryption in beta can be upgraded normally.

### Documentation updates

* Updated the [Limitations](../index/tde-limitations.md) topic, it now includes WAL encryption limitations and both supported and unsupported WAL tools
* [PG-1858 :octicons-link-external-16:](https://perconadev.atlassian.net/browse/PG-1858) - Added a new topic for [Backup with WAL encryption enabled](../how-to/backup-wal-enabled.md) that includes restoring a backup created with WAL encryption
* [PG-1832 :octicons-link-external-16:](https://perconadev.atlassian.net/browse/PG-1858) - Added documentation for using the `pg_tde_archive_decrypt` and `pg_tde_restore_encrypt` utilities. These tools are now covered in [CLI Tools](../command-line-tools/cli-tools.md) to guide users on how to archive and restore encrypted WAL segments securely
* [PG-1740 :octicons-link-external-16:](https://perconadev.atlassian.net/browse/PG-1740) - Updated documentation for [uninstalling `pg_tde`](../how-to/uninstall.md) with WAL encryption enabled and improved the uninstall instructions to cover cases where TDE is disabled while WAL encryption remains active

## 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-1497 :octicons-link-external-16:](https://perconadev.atlassian.net/browse/PG-1497) WAL encryption is now generally available (GA)
* [PG-1037 :octicons-link-external-16:](https://perconadev.atlassian.net/browse/PG-1037) - Added support for `pg_rewind` with encrypted WAL
* [PG-1411 :octicons-link-external-16:](https://perconadev.atlassian.net/browse/PG-1497) - Added support for `pg_resetwal` with encrypted WAL
* [PG-1603 :octicons-link-external-16:](https://perconadev.atlassian.net/browse/PG-1603) - Added support for `pg_basebackup` with encrypted WAL
* [PG-1710 :octicons-link-external-16:](https://perconadev.atlassian.net/browse/PG-1710) - Added support for WAL archiving with encrypted WAL
* [PG-1711 :octicons-link-external-16:](https://perconadev.atlassian.net/browse/PG-1711) - Added support for incremental backups with encrypted WAL, compatibility has been verified with `pg_combinebackup` and the WAL summarizer tool.
* [PG-1712 :octicons-link-external-16:](https://perconadev.atlassian.net/browse/PG-1712) - Added support for `pg_createsubscriber` with encrypted WAL
* [PG-1833 :octicons-link-external-16:](https://perconadev.atlassian.net/browse/PG-1833) - Added verified support for using `pg_waldump` with encrypted WAL
* [PG-1834 :octicons-link-external-16:](https://perconadev.atlassian.net/browse/PG-1834) - Verified `pg_upgrade` with encryption

### Improvements

* [PG-1661 :octicons-link-external-16:](https://perconadev.atlassian.net/browse/PG-1661) - Added validation for key material received from providers
* [PG-1667 :octicons-link-external-16:](https://perconadev.atlassian.net/browse/PG-1667) - Validated Vault keyring engine type

### Bugs Fixed

* [PG-1391 :octicons-link-external-16:](https://perconadev.atlassian.net/browse/PG-1391) - Fixed unencrypted checkpoint segment on replica with encrypted key
* [PG-1412 :octicons-link-external-16:](https://perconadev.atlassian.net/browse/PG-1412) – Fixed an issue where `XLogFileCopy` failed with encrypted WAL during PITR and `pg_rewind`
* [PG-1452 :octicons-link-external-16:](https://perconadev.atlassian.net/browse/PG-1452) - Fixed an issue where `pg_tde_change_key_provider` did not work without the `-D` flag even if `PGDATA` was set
* [PG-1485 :octicons-link-external-16:](https://perconadev.atlassian.net/browse/PG-1485) - Fixed an issue where streaming replication failed with an invalid magic number in WAL when `wal_encryption` was enabled
* [PG-1604 :octicons-link-external-16:](https://perconadev.atlassian.net/browse/PG-1604) - Fixed a crash during standby promotion caused by an invalid magic number when replaying two-phase transactions from WAL
* [PG-1658 :octicons-link-external-16:](https://perconadev.atlassian.net/browse/PG-1658) - Fixed an issue where the global key provider could not be deleted after server restart
* [PG-1835 :octicons-link-external-16:](https://perconadev.atlassian.net/browse/PG-1835) - Fixed an issue where `pg_resetwal` corrupted encrypted WAL, causing PostgreSQL to fail at startup with an invalid checkpoint
* [PG-1842 :octicons-link-external-16:](https://perconadev.atlassian.net/browse/PG-1842) - Fixed a delay in replica startup with encrypted tables in streaming replication setups
* [PG-1843 :octicons-link-external-16:](https://perconadev.atlassian.net/browse/PG-1843) - Fixed performance issues when creating encrypted tables
* [PG-1863 :octicons-link-external-16:](https://perconadev.atlassian.net/browse/PG-1863) - Fixed an issue where unnecessary WAL was generated when creating temporary tables
* [PG-1866 :octicons-link-external-16:](https://perconadev.atlassian.net/browse/PG-1866) - Fixed an issue where automatic restart after crash sometimes failed with WAL encryption enabled
* [PG-1867 :octicons-link-external-16:](https://perconadev.atlassian.net/browse/PG-1867) - Fixed archive recovery with encrypted WAL
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>-->
8 changes: 4 additions & 4 deletions contrib/pg_tde/documentation/mkdocs.yml
Original file line number Diff line number Diff line change
Expand Up @@ -209,10 +209,10 @@ nav:
- faq.md
- "Release notes":
- "Release notes index": release-notes/release-notes.md
- "2025":
- "1.0": release-notes/release-notes-v1.0.md
- "Release Candidate 2": release-notes/rc2.md
- "Release Candidate 1": release-notes/rc.md
- "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
- "2024 (Alpha 1 - Beta 2)":
- "Beta 2": release-notes/beta2.md
- "Beta": release-notes/beta.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'