Skip to content

Commit f2613f1

Browse files
authored
PG-2262 - Add banner and warning for pg_upgrade breaking with pg_tde (#932)
This PR adds a banner at the top of the PPG 17 documentation page warning the user that pg_upgrade is broken with encrypted tables. It also adds a warning in the Major upgrade chapter.
1 parent 619a89f commit f2613f1

2 files changed

Lines changed: 24 additions & 4 deletions

File tree

_resourcepdf/overrides/main.html

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -6,6 +6,12 @@
66
{# Import the theme's layout. #}
77
{% extends "base.html" %}
88

9+
{% block announce %}
10+
<div class="md-banner" style="background-color: #b71c1c; color: white;">
11+
⚠️ pg_upgrade is currently broken with encrypted tables (pg_tde). Do NOT use it for upgrades.
12+
</div>
13+
{% endblock %}
14+
915
{% block scripts %}
1016
<script src="https://cmp.osano.com/Azqe5vTyLOSbN3OuT/49ad85b5-0418-4794-ab81-7599dddd534c/osano.js"></script>
1117
{{ super() }}

docs/major-upgrade.md

Lines changed: 18 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -2,6 +2,20 @@
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+
519
To ensure a smooth upgrade path, follow these steps:
620

721
* Upgrade to the latest minor version within your current major version (e.g., from 16.6 to 16.9).
@@ -12,13 +26,13 @@ To ensure a smooth upgrade path, follow these steps:
1226

1327
Percona Distribution for PostgreSQL 16.3, 15.7, 14.12, 13.15 and 12.18 include `llvm` packages 16.0.6, while its previous versions 16.2, 15.6, 14.11, 13.14, and 12.17 include `llvm` 12.0.1. Since `llvm` libraries differ and are not compatible, the direct major version upgrade from 15.6 to 16.3 may cause issues.
1428

15-
The in-place upgrade means installing a new version without removing the old version and keeping the data files on the server.
29+
An in-place upgrade installs a new version alongside the existing one while reusing the data directory.
1630

1731
!!! admonition "See also"
1832

1933
[`pg_upgrade` Documentation :octicons-link-external-16:](https://www.postgresql.org/docs/{{pgversion}}/pgupgrade.html)
2034

21-
Similar to installing, we recommend you to upgrade Percona Distribution for PostgreSQL from Percona repositories.
35+
Similar to installation, we recommend upgrading Percona Distribution for PostgreSQL using Percona repositories.
2236

2337
!!! important
2438

@@ -183,7 +197,7 @@ Run **all** commands as root or via **sudo**:
183197
```
184198
</details>
185199

186-
4. Start the `postgreqsl` service.
200+
4. Start the `postgresql` service.
187201

188202
```{.bash data-prompt="$"}
189203
$ sudo systemctl start postgresql.service
@@ -327,7 +341,7 @@ Run **all** commands as root or via **sudo**:
327341
$ systemctl status postgresql-{{pgversion}}
328342
```
329343
330-
7. After the upgrade, the Optimizer statistics are not transferred to the new cluster. Run the `vaccumdb` command to analyze the new cluster:
344+
7. After the upgrade, the Optimizer statistics are not transferred to the new cluster. Run the `vacuumdb` command to analyze the new cluster:
331345
332346
* Log in as the postgres user
333347

0 commit comments

Comments
 (0)