Skip to content

Add WAL content for 2.0 release #499

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 20 commits into
base: TDE_REL_17_STABLE
Choose a base branch
from
Open

Conversation

Andriciuc
Copy link
Collaborator

@Andriciuc Andriciuc commented Aug 5, 2025

  • remove (tech preview)
  • remove mentions of WAL being BETA and warning notes

…graph for Global Principal key config

- fix a small space in functions and add * to pg_tde_set_
- reworded introductory paragraph in Global Principal Key configuration, added descriptions for the two functions used to config the global principal key
- added explanatory paragraph to Next steps for clarity
Co-authored-by: Anastasia Alexandrova <anastasia.alexandrova@percona.com>
@nastena1606 nastena1606 temporarily deployed to wal-2.0-update - INTERNAL-pg_tde docs PR #499 August 18, 2025 10:32 — with Render Destroyed
…for user

* add  table for user to select preferred KMS config
@dutow dutow force-pushed the TDE_REL_17_STABLE branch from b3b7e89 to 415cb8d Compare August 20, 2025 08:59

??? note "Click to expand"
* Patroni
* `pg_basebackup` (with `--wal-method=stream`)
Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Also with --wal-method=none but maybe too obvious?

Copy link
Collaborator Author

@Andriciuc Andriciuc Aug 20, 2025

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

never a bad thing to add more info! Saves the user a question they would have for our support, but since we're talking about WAL encryption specifically, would --wal-method=none be useful here?

Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Yes! You use --wal-method=none if you want to build your own pgBackRest. The idea is that you set archive_command to somehting and start archiving WAL and then run pg_basebackup with --wal-method=none that way you can restore the backup by combining it with the archived WAL files.

Copy link
Collaborator Author

@Andriciuc Andriciuc Aug 21, 2025

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Great explanation, thank you, now I get it!

I added the none method and a link to our basebackup topic if the user wants more info:

Note: the link doesn't 'work' because we didn't merge yet but it's the correct path.

The following tools and extensions in Percona Distribution for PostgreSQL have been tested and verified to work with `pg_tde` WAL encryption:

??? note "Click to expand"
* Patroni
Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Maybe we should explain which configs because we certainly do not support all.

Disliked how in Limitations we put tool support so I rewrote the title to better reflect the limitation chapter scope
This ensures that the user has a configuration example for Patroni, at least offered by us.

Select your prefered configuration from the links below:
`pg_tde` has been tested and approved with the following key providers:
Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I think we could remove approved.

Copy link
Collaborator

@jeltz jeltz left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I want to change some things but I prefer this to be merged now.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Improvements or additions to documentation
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants