Skip to content

Commit 85037c4

Browse files
authored
Create Release Notes for 1.0 (#432)
Added initial files and modifications to include 1.0 release notes to the TOC and variables. Updates: * updated the ToC names to make them in line with style guide * updated variable with new release branch and fixed small release note name * updated ## Release Highlights with topics: * Added tickets * Updated Upgrade considerations
1 parent b6c1305 commit 85037c4

File tree

4 files changed

+77
-11
lines changed

4 files changed

+77
-11
lines changed
Lines changed: 61 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,61 @@
1+
# pg_tde 1.0 ({{date.GA10}})
2+
3+
The `pg_tde` by Percona extension brings in [Transparent Data Encryption (TDE)](../index/index.md) to PostgreSQL and enables you to keep sensitive data safe and secure.
4+
5+
[Get Started](../install.md){.md-button}
6+
7+
## Release Highlights
8+
9+
* **`pg_tde` 1.0 is now GA (Generally Available)**
10+
11+
And **stable** for encrypting relational data in PostgreSQL using [Transparent Data Encryption (TDE)](../index/index.md). This milestone brings production-level data protection to PostgreSQL workloads.
12+
13+
* **WAL encryption is still in Beta**
14+
15+
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.
16+
17+
## Upgrade considerations
18+
19+
`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`.
20+
21+
## Known issues
22+
23+
* 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.
24+
25+
To prevent this, you can change the `mlock` limit to be at least twice bigger than the memory page size:
26+
27+
* temporarily for the current session using the `ulimit -l <value>` command.
28+
* set a new hard limit in the `/etc/security/limits.conf` file. To do so, you require the superuser privileges.
29+
30+
Adjust the limits with caution since it affects other processes running in your system.
31+
32+
## Changelog
33+
34+
### New Features
35+
36+
- [PG-1257](https://perconadev.atlassian.net/browse/PG-1257) – Added SQL function to remove the current principal key
37+
38+
### Improvements
39+
40+
- [PG-1617](https://perconadev.atlassian.net/browse/PG-1617) – Removed relation key cache
41+
- [PG-1635](https://perconadev.atlassian.net/browse/PG-1635) – User-facing TDE functions now return void
42+
- [PG-1605](https://perconadev.atlassian.net/browse/PG-1605) – Removed undeclared dependencies for `pg_tde_grant_database_key_management_to_role()`
43+
44+
### Bugs Fixed
45+
46+
- [PG-1581](https://perconadev.atlassian.net/browse/PG-1581) – Fixed PostgreSQL crashes on table access when KMIP key is unavailable after restart
47+
- [PG-1583](https://perconadev.atlassian.net/browse/PG-1583) – Fixed a crash when dropping the `pg_tde` extension with CASCADE after changing the key provider file
48+
- [PG-1585](https://perconadev.atlassian.net/browse/PG-1585) – Fixed the vault provider re-addition that failed after server restart with a new token
49+
- [PG-1592](https://perconadev.atlassian.net/browse/PG-1592) – Improve error logs when Server Key Info is requested without being created
50+
- [PG-1593](https://perconadev.atlassian.net/browse/PG-1593) – Fixed runtime failures when invalid Vault tokens are allowed during key provider creation
51+
- [PG-1600](https://perconadev.atlassian.net/browse/PG-1600) – Fixed Postmaster error when dropping a table with an unavailable key provider
52+
- [PG-1606](https://perconadev.atlassian.net/browse/PG-1606) – Fixed missing superuser check in role grant function leads to misleading errors
53+
- [PG-1607](https://perconadev.atlassian.net/browse/PG-1607) – Improved CA parameter order and surrounding documentation for clearer interpretation
54+
- [PG-1608](https://perconadev.atlassian.net/browse/PG-1608) – Updated and fixed global key configuration parameters in documentation
55+
- [PG-1613](https://perconadev.atlassian.net/browse/PG-1613) – Tested and improved the `pg_tde_change_key_provider` CLI utility
56+
- [PG-1637](https://perconadev.atlassian.net/browse/PG-1637) – Fixed unused keys in key files which caused issues after OID wraparound
57+
- [PG-1651](https://perconadev.atlassian.net/browse/PG-1651) – Fixed the CLI tool when working with Vault key export/import
58+
- [PG-1652](https://perconadev.atlassian.net/browse/PG-1652) – Fixed when the server fails to find encryption keys after CLI-based provider change
59+
- [PG-1662](https://perconadev.atlassian.net/browse/PG-1662) – Fixed the creation of inconsistent encryption status when altering partitioned tables
60+
- [PG-1663](https://perconadev.atlassian.net/browse/PG-1663) – Fixed the indexes on partitioned tables which were not encrypted
61+
- [PG-1700](https://perconadev.atlassian.net/browse/PG-1700) – Fixed the error hint when the principal key is missing

contrib/pg_tde/documentation/docs/release-notes/release-notes.md

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -2,6 +2,8 @@
22

33
`pg_tde` extension brings in [Transparent Data Encryption (TDE)](../index/index.md) to PostgreSQL and enables you to keep sensitive data safe and secure.
44

5+
* [Percona Transparent Database Encryption for PostgreSQL 1.0 ({{date.GA10}})](release-notes-v1.0.md)
6+
* [pg_tde Release Candidate 2 (RC2) ({{date.RC2}})](rc2.md)
57
* [pg_tde Release Candidate 2 (RC2) ({{date.RC2}})](rc2.md)
68
* [pg_tde Release Candidate ({{date.RC}})](rc.md)
79
* [pg_tde Beta2 (2024-12-16)](beta2.md)

contrib/pg_tde/documentation/mkdocs.yml

Lines changed: 10 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -163,14 +163,14 @@ nav:
163163
- "Features": features.md
164164
- "Overview":
165165
- "What is Transparent Data Encryption (TDE)?":
166-
- "TDE Overview": index/index.md
167-
- "TDE Benefits": index/how-tde-helps.md
168-
- "How TDE Works": index/how-does-tde-work.md
169-
- "Encrypted Data Scope": index/tde-encrypts.md
170-
- "Table Access Methods and TDE": index/table-access-method.md
166+
- "TDE overview": index/index.md
167+
- "TDE benefits": index/how-tde-helps.md
168+
- "How TDE works": index/how-does-tde-work.md
169+
- "Encrypted data scope": index/tde-encrypts.md
170+
- "Table access methods and TDE": index/table-access-method.md
171171
- "Limitations of TDE": index/tde-limitations.md
172-
- "Versions and Supported PostgreSQL Deployments": index/supported-versions.md
173-
- "Get Started":
172+
- "Versions and supported PostgreSQL deployments": index/supported-versions.md
173+
- "Get started":
174174
- "1. Install pg_tde": install.md
175175
- "1.1 Via apt": apt.md
176176
- "1.2 Via yum": yum.md
@@ -189,7 +189,7 @@ nav:
189189
- "Technical Reference":
190190
- "Overview": advanced-topics/index.md
191191
- "Architecture": architecture/index.md
192-
- "GUC Variables": variables.md
192+
- "GUC variables": variables.md
193193
- "Functions": functions.md
194194
- "Streaming Replication with tde_heap": replication.md
195195
- "TDE Operations":
@@ -204,8 +204,9 @@ nav:
204204
- "Decrypt an Encrypted Table": how-to/decrypt.md
205205
- "Restore an encrypted pg_tde backup": how-to/restore-backups.md
206206
- faq.md
207-
- "Release Notes":
207+
- "Release notes":
208208
- "pg_tde release notes": release-notes/release-notes.md
209+
- release-notes/release-notes-v1.0.md
209210
- release-notes/rc2.md
210211
- release-notes/rc.md
211212
- release-notes/beta2.md
Lines changed: 4 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,9 +1,11 @@
11
#Variables used throughout the docs
22

3-
release: 'RC2'
3+
tdeversion: '1.0'
4+
release: '1.0'
45
pgversion17: '17.5'
5-
tdebranch: TDE_REL_17_STABLE
6+
tdebranch: release-17.5.2
67

78
date:
9+
GA10: '2025-06-30'
810
RC2: '2025-05-29'
911
RC: '2025-03-27'

0 commit comments

Comments
 (0)