Skip to content

Update warnings for basebackup #558

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.

Sign up for GitHub

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 2 commits into from
Aug 29, 2025
Merged

Update warnings for basebackup #558

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
0f7aca0
update warnings for basebackup
Andriciuc Aug 28, 2025
836c0f6
update with more corrupt data info to warnings
Andriciuc Aug 28, 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
4 changes: 2 additions & 2 deletions contrib/pg_tde/documentation/docs/how-to/backup-wal-enabled.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -24,9 +24,9 @@ Also copy any external files referenced by your providers configuration (such as
## Key rotation during backups

!!! warning
Do not rotate SMGR or WAL encryption keys while `pg_basebackup` is running. Standbys or standalone clusters created from such backups may fail to start during WAL replay.
Do not create, change, or rotate global key providers (or their keys) while `pg_basebackup` is running. Standbys or standalone clusters created from such backups may fail to start during WAL replay and may also lead to the corruption of encrypted data (tables, indexes, and other relations).

Rotations during a base backup can leave the standby in an inconsistent state where it cannot retrieve the correct key history.
Creating, changing, or rotating global key providers (or their keys) during a base backup can leave the standby in an inconsistent state where it cannot retrieve the correct key history.

For example, you may see errors such as:

Expand Down
4 changes: 2 additions & 2 deletions contrib/pg_tde/documentation/docs/release-notes/release-notes-v2.0.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -30,9 +30,9 @@ Clusters that did not use WAL encryption in beta can be upgraded normally.

## Known issues

* Rotating encryption keys while `pg_basebackup` is running may cause standbys or standalone clusters initialized from the backup to fail during WAL replay.
* Creating, changing, or rotating global key providers (or their keys) while `pg_basebackup` is running may cause standbys or standalone clusters initialized from the backup to fail during WAL replay and may also lead to the corruption of encrypted data (tables, indexes, and other relations).

Avoid key rotations during backups. Run a new full backup after completing a rotation.
Avoid making these actions during backup windows. Run a new full backup after completing a rotation or provider update.

* Using `pg_basebackup` with `--wal-method=fetch` produces warnings.

Expand Down