Skip to content

Commit 120d926

Browse files
authored
PG-2384 - Add pg_tde warning note to use pg_tde_upgrade (17) (#984)
This PR adds a warning note informing the user they need to use pg_tde_upgrade instead of pg_upgrade in their distribution in case pg_tde is used to encrypt the cluster.
1 parent acf053d commit 120d926

1 file changed

Lines changed: 3 additions & 14 deletions

File tree

docs/major-upgrade.md

Lines changed: 3 additions & 14 deletions
Original file line numberDiff line numberDiff line change
@@ -2,25 +2,14 @@
22

33
This document describes the in-place upgrade of Percona Distribution for PostgreSQL using the `pg_upgrade` tool.
44

5-
!!! danger "pg_upgrade is not supported with encrypted tables (pg_tde)"
6-
7-
`pg_upgrade` is not supported for clusters with encrypted tables (`pg_tde`).
8-
9-
**You are affected if:**
10-
11-
- You are using `pg_tde`, or
12-
- Your cluster contains encrypted tables
13-
14-
It corrupts encryption metadata which results in:
15-
16-
- Missing or empty key files in the `pg_tde/` directory
17-
- Missing or incomplete provider metadata
18-
195
To ensure a smooth upgrade path, follow these steps:
206

217
* Upgrade to the latest minor version within your current major version (e.g., from 16.6 to 16.9).
228
* Then, perform the major upgrade to your desired version (e.g., from 16.9 to 17.5).
239

10+
!!! warning
11+
When doing a major version upgrade from Percona Distribution for PostgreSQL 17, if your cluster uses `pg_tde`, you **must** use [`pg_tde_upgrade` :octicons-link-external-16:](https://docs.percona.com/pg-tde/command-line-tools/pg-tde-upgrade.html) instead of `pg_upgrade`. Using `pg_upgrade` on an encrypted cluster is not supported and will result in data corruption. The server may start successfully but queries against encrypted tables will fail.
12+
2413
!!! note
2514
When running a major upgrade on **RHEL 8 and compatible derivatives**, consider the following:
2615

0 commit comments

Comments
 (0)