Skip to content
Draft
Show file tree
Hide file tree
Changes from all commits
Commits
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
3 changes: 2 additions & 1 deletion contrib/pg_tde/documentation/docs/apt.md
Original file line number Diff line number Diff line change
Expand Up @@ -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

Expand Down
Empty file.
42 changes: 21 additions & 21 deletions contrib/pg_tde/documentation/docs/install.md
Original file line number Diff line number Diff line change
@@ -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}
Expand All @@ -25,18 +20,23 @@ 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/17/docker.html#enable-encryption){.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.

[Install from tarballs :material-arrow-right:](https://docs.percona.com/postgresql/17/tarball.html){.md-button}
=== ":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)
3 changes: 2 additions & 1 deletion contrib/pg_tde/documentation/docs/yum.md
Original file line number Diff line number Diff line change
Expand Up @@ -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}

Expand Down
3 changes: 2 additions & 1 deletion contrib/pg_tde/documentation/mkdocs.yml
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down
1 change: 1 addition & 0 deletions contrib/pg_tde/documentation/variables.yml
Original file line number Diff line number Diff line change
Expand Up @@ -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:
Expand Down