forked from postgres/postgres
-
Notifications
You must be signed in to change notification settings - Fork 9
Tde documentation updates for ga #251
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
Merged
Andriciuc
merged 31 commits into
TDE_REL_17_STABLE
from
TDE-documentation-updates-for-GA
May 8, 2025
Merged
Changes from 1 commit
Commits
Show all changes
31 commits
Select commit
Hold shift + click to select a range
fdd464b
Added and reorg files
Andriciuc f3d8379
Split Home and created TDE Overview
Andriciuc e2d4be2
Further refined and split into topics
Andriciuc f5db064
Renamed files and folders for better SEO
Andriciuc 4869f64
Merge remote-tracking branch 'origin/pg_tde_docs_updates_for_GA' into…
Andriciuc ed361e7
updated with Anders branch
Andriciuc b5c9e89
Small updates to yml and apt
Andriciuc d5a0629
updated index folder to reflect chapter name, overview
Andriciuc ef82b1f
updated overview doc to index again
Andriciuc cbd4017
updated links to reflect proper structure
Andriciuc 778851b
Setup.md and structure changes
Andriciuc 1e3c160
A handful of fixes
Andriciuc 043b44e
removed PG Community mentions
Andriciuc 0876d20
updated cli and kmip server code
Andriciuc 106856d
small fixes
Andriciuc 6dc7d79
Update functions.md
Andriciuc 9b8d6c2
updated toc
Andriciuc 9302f0f
small fixes to buttons added
Andriciuc 7d4b514
smaller updates
Andriciuc 6f1c3b8
smaller updates
Andriciuc 12230fe
Update requirements.txt
Andriciuc 31c0975
fixes part 1/2 from feedback review
Andriciuc dce23bd
updated features.md
Andriciuc 1e61a45
removed compliance/regulations
Andriciuc f636e82
fix for PG-1587
Andriciuc 45b470e
fixes for nastia 1/2 and for jz 2/2
Andriciuc 104710e
all fixes accounted for
Andriciuc a39e568
Resolve merge conflicts
Andriciuc 31bea87
fixes to titles
Andriciuc be6e6ef
fixed notes in features
Andriciuc 7b76758
updated function parameters
Andriciuc File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
removed PG Community mentions
removed PG community tde_heap_basic mentions and improved tde limitation and supported versions text, I kept the Release notes mentions though. Also added a note saying tde_heap_basic is deprecated
- Loading branch information
commit 043b44e3f9622fb3671dde676acc454e45ef5f18
There are no files selected for viewing
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
8000
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -1,5 +1,7 @@ | ||
# What is Transparent Data Encryption (TDE)? | ||
|
||
Transparent Data Encryption is a technology to protect data at rest. The encryption process happens transparently in the background, without affecting database operations. Data is automatically encrypted as it's written to the disk and decrypted as it's read, all in real-time. Users and applications interact with the data as usual without noticing any difference. | ||
Transparent Data Encryption (TDE) protects your data at rest by ensuring that even if the underlying storage is compromised, the data remains unreadable without the correct encryption keys. This is especially critical for environments handling sensitive, regulated, or high-value information. | ||
|
||
Encryption happens transparently in the background, with minimal impact on database operations. | ||
|
||
[How does TDE help?](how-tde-helps.md){.md-button} [Check the full feature list](../features.md){.md-button} [Get started](../install.md){.md-button} |
20 changes: 12 additions & 8 deletions
20
contrib/pg_tde/documentation/docs/index/supported-versions.md
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -1,17 +1,21 @@ | ||
# Versions and supported PostgreSQL deployments | ||
|
||
The `pg_tde` extension comes in two distinct versions with specific access methods to encrypt the data. These versions are database-specific and differ in terms of what they encrypt and with what access method. Each version is characterized by the database it supports, the access method it provides, and the scope of encryption it offers. | ||
The `pg_tde` extension is available for [Percona Server for PostgreSQL 17.x](https://docs.percona.com/postgresql/17/postgresql-server.html), an open source, drop-in replacement for PostgreSQL Community. This version provides the `tde_heap` access method and offers [full encryption capabilities](../features.md), including encryption of tables, indexes, WAL data, and support for logical replication. | ||
|
||
* **Version for Percona Server for PostgreSQL** | ||
The extension is tightly integrated with Percona Server for PostgreSQL to deliver enhanced encryption functionality that is not available in community builds. | ||
|
||
This `pg_tde` version is based on and supported for [Percona Server for PostgreSQL 17.x :octicons-link-external-16:](https://docs.percona.com/postgresql/17/postgresql-server.html) - an open source binary drop-in replacement for PostgreSQL Community. It provides the `tde_heap` access method and offers [full encryption capabilities](../features.md). | ||
## Why choose Percona Server for PostgreSQL? | ||
|
||
* **Community version** (deprecated) | ||
By using our PostgreSQL distribution, you get: | ||
|
||
This version is available with PostgreSQL Community 16 and 17, and Percona Distribution for PostgreSQL 16. It provides the `tde_heap_basic` access method, offering limited encryption features. The limitations are in encrypting WAL data only for tables created using the extension and no support of index encryption nor logical replication. | ||
- **Full encryption support** through the `tde_heap` access method, including tables, indexes, WAL data, and logical replication. | ||
- **Enhanced performance and enterprise-ready features** not available in community builds. | ||
- **Regular updates and security patches** backed by Percona’s expert support team. | ||
- **Professional support** and guidance for secure PostgreSQL deployments. | ||
|
||
## Which version to choose? | ||
!!! note | ||
Andriciuc marked this conversation as resolved.
Show resolved
Hide resolved
|
||
Support for earlier or limited versions of `pg_tde` (such as `tde_heap_basic`) has been deprecated. | ||
|
||
Enjoy full encryption with the Percona Server for PostgreSQL version and the `tde_heap` access method. The Community version is deprecated and is planned to be removed in future releases. | ||
Still unsure which deployment fits your needs? [Contact our experts](https://www.percona.com/about/contact) to find the best solution for your environment. | ||
|
||
Still not sure? [Contact our experts](https://www.percona.com/about/contact) to find the best solution for you. | ||
[Get Started: Install pg_tde :material-arrow-right:](../install.md){.md-button} |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -1,11 +1,11 @@ | ||
# What does TDE encrypt? | ||
|
||
`pg_tde` encrypts the following: | ||
`pg_tde` encrypts the following components: | ||
|
||
* User data in tables, including TOAST tables, that are created using the extension. The metadata of those tables is not encrypted. | ||
* Temporary tables created during the database operation for data tables created using the extension | ||
* Write-Ahead Log (WAL) data for the entire database cluster. This includes WAL data in encrypted and non-encrypted tables | ||
* Indexes on encrypted tables | ||
* Logical replication on encrypted tables | ||
* **User data** in tables using the extension, including associated TOAST data. The table metadata (column names, data types, etc.) is not encrypted. | ||
* **Temporary tables** created during the query execution, for data tables created using the extension. | ||
* **Write-Ahead Log (WAL) data** for the entire database cluster. This includes WAL data in encrypted and non-encrypted tables. | ||
* **Indexes** associated encrypted tables. | ||
* **Logical replication data** for encrypted tables (ensures encrypted content is preserved across replicas). | ||
|
||
[How TDE uses table access methods?](table-access-method.md){.md-button} |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -1,7 +1,9 @@ | ||
# Known limitations | ||
# Limitations of TDE | ||
Andriciuc marked this conversation as resolved.
Show resolved
Hide resolved
|
||
|
||
* Keys in the local keyfile are stored unencrypted. For better security we recommend using the Key management storage. | ||
* System tables are currently not encrypted. This means that statistics data and database metadata are currently not encrypted. | ||
|
||
* `pg_rewind` doesn't work with encrypted WAL for now. We plan to fix it in future releases. | ||
* `pb_tde` Release candidate is incompatible with `pg_tde`Beta2 due to significant changes in code. There is no direct upgrade flow from one version to another. You must [uninstall](../how-to/uninstall.md) `pg_tde` Beta2 first and then [install](../install.md) and configure the new Release Candidate version. | ||
|
||
[Versions and supported PostgreSQL deployments](table-access-method.md){.md-button} |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Uh oh!
There was an error while loading. Please reload this page.