From 72e8e16e9bbeada6b26389395102fe436e87b05f Mon Sep 17 00:00:00 2001 From: Dragos Andriciuc Date: Tue, 7 Oct 2025 12:51:06 +0300 Subject: [PATCH 1/3] Update installation chapter for improved flow and kubernetes topic Initial changes: - removed RC to GA warning - Removed The packages are available for the following operating systems and replaced with link to Perconas Software Lifecycle page as a note - standardized tip for supported platforms for yum and apt install pages - added Everest and Kubernetes tabs for installation and populated with link to new topics for both in the install pg_tde chapter --- contrib/pg_tde/documentation/docs/apt.md | 3 +- .../documentation/docs/install-kubernetes.md | 0 contrib/pg_tde/documentation/docs/install.md | 46 ++++++++++--------- contrib/pg_tde/documentation/docs/yum.md | 3 +- contrib/pg_tde/documentation/mkdocs.yml | 3 +- contrib/pg_tde/documentation/variables.yml | 1 + 6 files changed, 32 insertions(+), 24 deletions(-) create mode 100644 contrib/pg_tde/documentation/docs/install-kubernetes.md diff --git a/contrib/pg_tde/documentation/docs/apt.md b/contrib/pg_tde/documentation/docs/apt.md index 2751eb89e7d2d..1e6a869e7a20a 100644 --- a/contrib/pg_tde/documentation/docs/apt.md +++ b/contrib/pg_tde/documentation/docs/apt.md @@ -2,7 +2,8 @@ This page explains how to install `pg_tde` with [Percona Distribution for PostgreSQL :octicons-link-external-16:](https://docs.percona.com/postgresql/latest/index.html). -Check the [list of supported platforms](install.md#__tabbed_1_1) before continuing. +!!! tip + Check the [list of supported platforms :octicons-link-external-16:](https://www.percona.com/services/policies/percona-software-support-lifecycle) before continuing. ## Preconditions diff --git a/contrib/pg_tde/documentation/docs/install-kubernetes.md b/contrib/pg_tde/documentation/docs/install-kubernetes.md new file mode 100644 index 0000000000000..e69de29bb2d1d diff --git a/contrib/pg_tde/documentation/docs/install.md b/contrib/pg_tde/documentation/docs/install.md index 542c876c2726b..4e38de86ca591 100644 --- a/contrib/pg_tde/documentation/docs/install.md +++ b/contrib/pg_tde/documentation/docs/install.md @@ -1,22 +1,17 @@ # Install pg_tde -!!! warning "No upgrade path from RC to GA" - There is no safe upgrade path from the previous versions, such as Release Candidate 2, to the General Availability (GA) version of `pg_tde`. - We recommend starting with a **clean installation** for GA deployments. Avoid using RC environments in production. +You can select from multiple easy-to-follow installation options to install `pg_tde`, however **we strongly recommend using a Package Manager** for a convenient and quick installation. -To install `pg_tde`, use one of the following methods: +!!! note + Specific information on the supported platforms, products, and versions is described in the [Percona Software and Platform Lifecycle :octicons-link-external-16:](https://www.percona.com/services/policies/percona-software-support-lifecycle) page. === ":octicons-terminal-16: Package manager" - The packages are available for the following operating systems: - - - Red Hat Enterprise Linux 8 and compatible derivatives - - Red Hat Enterprise Linux 9 and compatible derivatives - - Ubuntu 20.04 (Focal Fossa) - - Ubuntu 22.04 (Jammy Jellyfish) - - Ubuntu 24.04 (Noble Numbat) - - Debian 11 (Bullseye) - - Debian 12 (Bookworm) + Percona provides installation packages in `DEB` and `RPM` formats for 64-bit Linux distributions. + + If you are on Debian or Ubuntu, use `apt` for installation. + + If you are on Red Hat Enterprise Linux or compatible derivatives, use `yum` for installation. [Install on Debian or Ubuntu :material-arrow-right:](apt.md){.md-button} [Install on RHEL or derivatives :material-arrow-right:](yum.md){.md-button} @@ -25,18 +20,27 @@ To install `pg_tde`, use one of the following methods: `pg_tde` is a part of the Percona Distribution for PostgreSQL Docker image. Use this image to enjoy full encryption capabilities. Check below to get access to a detailed step-by-step guide. - [Run in Docker :material-arrow-right:](https://docs.percona.com/postgresql/latest/docker.html){.md-button} + [Run in Docker :octicons-link-external-16:](https://docs.percona.com/postgresql/latest/docker.html){.md-button} -=== ":octicons-download-16: Tar download" +=== ":simple-kubernetes: Kubernetes" - `pg_tde` is included in the Percona Distribution for PostgreSQL tarball. Select the below link to access the step-by-step guide. + You can enable `pg_tde` when deploying Percona Server for PostgreSQL in Kubernetes using the Percona Operator. + +=== ":simple-everest: Everest" - [Install from tarballs :material-arrow-right:](https://docs.percona.com/postgresql/17/tarball.html){.md-button} + test + +=== ":octicons-download-16: Tar download (not recommended)" + + `pg_tde` is included in the Percona Distribution for PostgreSQL tarball. Select the below link to access the step-by-step guide. -Follow the configuration steps below to continue: + [Install from tarballs :material-arrow-right:](https://docs.percona.com/postgresql/{{pgversion}}/tarball.html){.md-button} -[Configure pg_tde :material-arrow-right:](setup.md){.md-button} +## Next steps -If you’ve already completed these steps, feel free to skip ahead to a later section: +After finishing the installation, proceed with: - [Configure Key Management (KMS)](global-key-provider-configuration/overview.md){.md-button} [Validate Encryption with pg_tde](test.md){.md-button} [Configure WAL encryption](wal-encryption.md){.md-button} +- [Set up `pg_tde`](setup.md) +- [Learn about key management](global-key-provider-configuration/overview.md) +- [Validate your encryption setup](test.md) +- [Enable WAL encryption](wal-encryption.md) diff --git a/contrib/pg_tde/documentation/docs/yum.md b/contrib/pg_tde/documentation/docs/yum.md index e627833f34c60..53ebd74a7a793 100644 --- a/contrib/pg_tde/documentation/docs/yum.md +++ b/contrib/pg_tde/documentation/docs/yum.md @@ -2,7 +2,8 @@ This tutorial shows how to install `pg_tde` with [Percona Distribution for PostgreSQL](https://docs.percona.com/postgresql/latest/index.html). -Make sure you check the [list of supported platforms](install.md#__tabbed_1_1) before continuing. +!!! tip + Check the [list of supported platforms :octicons-link-external-16:](https://www.percona.com/services/policies/percona-software-support-lifecycle) before continuing. ## Install percona-release {.power-number} diff --git a/contrib/pg_tde/documentation/mkdocs.yml b/contrib/pg_tde/documentation/mkdocs.yml index bdb43ccb5ed75..65b6e91244fa6 100644 --- a/contrib/pg_tde/documentation/mkdocs.yml +++ b/contrib/pg_tde/documentation/mkdocs.yml @@ -173,7 +173,8 @@ nav: - "Get started": - "1. Install pg_tde": install.md - "1.1 Via apt": apt.md - - "1.2 Via yum": yum.md + - "1.2 Via yum": yum.md + - "1.3 kubernetes": install-kubernetes.md - "2. Configure pg_tde": setup.md - "2.1 Configure Key Management (KMS)": - "Key management overview": global-key-provider-configuration/overview.md diff --git a/contrib/pg_tde/documentation/variables.yml b/contrib/pg_tde/documentation/variables.yml index 1427a44065327..b1a7f0aa853e7 100644 --- a/contrib/pg_tde/documentation/variables.yml +++ b/contrib/pg_tde/documentation/variables.yml @@ -4,6 +4,7 @@ latestreleasenotes: 'release-notes-v2.0' tdeversion: '2.0' release: '2.0' pgversion17: '17.5' +pgversion: '17' tdebranch: release-17.5.3 date: From 005f317f75fd86824ad2d6b84a8e9b6e5d3a5544 Mon Sep 17 00:00:00 2001 From: Dragos Andriciuc Date: Wed, 8 Oct 2025 14:38:17 +0300 Subject: [PATCH 2/3] Update install.md --- contrib/pg_tde/documentation/docs/install.md | 4 ---- 1 file changed, 4 deletions(-) diff --git a/contrib/pg_tde/documentation/docs/install.md b/contrib/pg_tde/documentation/docs/install.md index 4e38de86ca591..d66bd489cbf20 100644 --- a/contrib/pg_tde/documentation/docs/install.md +++ b/contrib/pg_tde/documentation/docs/install.md @@ -26,10 +26,6 @@ You can select from multiple easy-to-follow installation options to install `pg_ You can enable `pg_tde` when deploying Percona Server for PostgreSQL in Kubernetes using the Percona Operator. -=== ":simple-everest: Everest" - - test - === ":octicons-download-16: Tar download (not recommended)" `pg_tde` is included in the Percona Distribution for PostgreSQL tarball. Select the below link to access the step-by-step guide. From ccf0f7b18fbb1fa44957d82fd393354469363418 Mon Sep 17 00:00:00 2001 From: Dragos Andriciuc Date: Wed, 8 Oct 2025 15:09:07 +0300 Subject: [PATCH 3/3] update link to proper encryption subtopic --- contrib/pg_tde/documentation/docs/install.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/contrib/pg_tde/documentation/docs/install.md b/contrib/pg_tde/documentation/docs/install.md index d66bd489cbf20..652423b95a5c2 100644 --- a/contrib/pg_tde/documentation/docs/install.md +++ b/contrib/pg_tde/documentation/docs/install.md @@ -20,7 +20,7 @@ You can select from multiple easy-to-follow installation options to install `pg_ `pg_tde` is a part of the Percona Distribution for PostgreSQL Docker image. Use this image to enjoy full encryption capabilities. Check below to get access to a detailed step-by-step guide. - [Run in Docker :octicons-link-external-16:](https://docs.percona.com/postgresql/latest/docker.html){.md-button} + [Run in Docker :octicons-link-external-16:](https://docs.percona.com/postgresql/17/docker.html#enable-encryption){.md-button} === ":simple-kubernetes: Kubernetes"