8000 Tde documentation updates for ga by Andriciuc · Pull Request #251 · percona/postgres · GitHub
[go: up one dir, main page]

Skip to content

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
merged 31 commits into from
May 8, 2025
Merged
Show file tree
Hide file tree
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 Apr 17, 2025
f3d8379
Split Home and created TDE Overview
Andriciuc Apr 17, 2025
e2d4be2
Further refined and split into topics
Andriciuc Apr 22, 2025
f5db064
Renamed files and folders for better SEO
Andriciuc Apr 23, 2025
4869f64
Merge remote-tracking branch 'origin/pg_tde_docs_updates_for_GA' into…
Andriciuc Apr 23, 2025
ed361e7
updated with Anders branch
Andriciuc Apr 24, 2025
b5c9e89
Small updates to yml and apt
Andriciuc Apr 28, 2025
d5a0629
updated index folder to reflect chapter name, overview
Andriciuc Apr 28, 2025
ef82b1f
updated overview doc to index again
Andriciuc Apr 28, 2025
cbd4017
updated links to reflect proper structure
Andriciuc Apr 28, 2025
778851b
Setup.md and structure changes
Andriciuc Apr 28, 2025
1e3c160
A handful of fixes
Andriciuc May 1, 2025
043b44e
removed PG Community mentions
Andriciuc May 1, 2025
0876d20
updated cli and kmip server code
Andriciuc May 5, 2025
106856d
small fixes
Andriciuc May 5, 2025
6dc7d79
Update functions.md
Andriciuc May 5, 2025
9b8d6c2
updated toc
Andriciuc May 5, 2025
9302f0f
small fixes to buttons added
Andriciuc May 5, 2025
7d4b514
smaller updates
Andriciuc May 6, 2025
6f1c3b8
smaller updates
Andriciuc May 6, 2025
12230fe
Update requirements.txt
Andriciuc May 6, 2025
31c0975
fixes part 1/2 from feedback review
Andriciuc May 6, 2025
dce23bd
updated features.md
Andriciuc May 7, 2025
1e61a45
removed compliance/regulations
Andriciuc May 7, 2025
f636e82
fix for PG-1587
Andriciuc May 7, 2025
45b470e
fixes for nastia 1/2 and for jz 2/2
Andriciuc May 7, 2025
104710e
all fixes accounted for
Andriciuc May 7, 2025
a39e568
Resolve merge conflicts
Andriciuc May 7, 2025
31bea87
fixes to titles
Andriciuc May 8, 2025
be6e6ef
fixed notes in features
Andriciuc May 8, 2025
7b76758
updated function parameters
Andriciuc May 8, 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
Prev Previous commit
Next Next commit
smaller updates
improved doc for test.md and get-help.md fixed heading title for key providers.
  • Loading branch information
Andriciuc committed May 6, 2025
commit 7d4b5148c83c087d23ce74b16ceee875d89bdf81
3 changes: 1 addition & 2 deletions contrib/pg_tde/documentation/docs/get-help.md
Original file line number Diff line number Diff line change
Expand Up @@ -17,12 +17,11 @@ Percona experts bring years of experience in tackling tough database performance
<div data-tf-live="01JKGYHB4DKYX1CC6KNF0VHP1A"></div><script src="//embed.typeform.com/next/embed.js"></script>
We understand your challenges when managing complex database environments. That's why we offer various services to help you simplify your operations and achieve your goals.


| Service | Description |
|----------------------------|-----------------------------------------------------------------------------------------------------------------------------------------------------------------------|
| 24/7 Expert Support | Our dedicated team of database experts is available 24/7 to assist you with any database issues. We provide flexible support plans tailored to your specific needs. |
| Hands-On Database Management | Our managed services team can take over the day-to-day management of your database infrastructure, freeing up your time to focus on other priorities. |
| Expert Consulting | Our experienced consultants provide guidance on database topics like architecture design, migration planning, performance optimization, and security best practices. |
| Comprehensive Training | Our training programs help your team develop skills to manage databases effectively, offering virtual and in-person courses. |

We're here to help you every step of the way. Whether you need a quick fix or a long-term partnership, we're ready to provide your expertise and support.
We're here to help you every step of the way. Whether you need a quick fix or a long-term partnership, we're ready to provide your expertise and support.
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
# Configure local keyring file
# Keyring File Configuration

This setup is intended for development and stores the keys unencrypted in the specified data file. See [how to use external reference to parameters](../how-to/external-parameters.md) to add an extra security layer to your setup.

Expand Down
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
# Configure KMIP server
# KMIP Configuration

To use a Key Management Interoperability Protocol (KMIP) server with `pg_tde`, you must configure it as a global key provider. This setup enables `pg_tde` to securely fetch and manage encryption keys from a centralized key management appliance.

Expand Down
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
# Configure HashiCorp Vault
# Vault Configuration

You can configure `pg_tde` to use HashiCorp Vault as a global key provider for managing encryption keys securely.

Expand Down
17 changes: 11 additions & 6 deletions contrib/pg_tde/documentation/docs/test.md
Original file line number Diff line number Diff line change
Expand Up @@ -31,7 +31,9 @@ After enabling the `pg_tde` extension for a database, you can begin encrypting d

The function returns `t` if the table is encrypted and `f` - if not.

3. Rotate the principal key when needed, see [Principal key management](functions.md#principal-key-management))
3. (Optional) Rotate the principal key.

To re-encrypt the data using a new key, see [Principal key management](functions.md#principal-key-management)

## Encrypt existing table

Expand All @@ -43,11 +45,14 @@ Run the following command:
ALTER TABLE table_name SET ACCESS METHOD tde_heap;
```

Note that the `SET ACCESS METHOD` command drops hint bits and this may affect the performance. Running a plain `SELECT count(*)` or `VACUUM` commands on the entire table will check every tuple for visibility and set its hint bits. Therefore, after executing the `ALTER TABLE` command, run a simple `count(*)` on your tables:
!!! important
Using `SET ACCESS METHOD` drops hint bits which can impact query performance. To restore performance, run:

```sql
SELECT count(*) FROM table_name;
```
```sql
SELECT count(*) FROM table_name;
```

This forces PostgreSQL to check every tuple for visibility and reset the hint bits.

!!! hint
If you no longer wish to use `pg_tde` or wish to switch the access method, see how you can [decrypt your data](how-to/decrypt.md).
Want to remove encryption later? See how to [decrypt your data](how-to/decrypt.md).
0