PG-1197 Drop tde_heap_basic and as such beta from Percona docs (#332)

* drop tde_heap_basic and as such beta from Percona docs

Signed-off-by: Kai Wagner <kai.wagner@percona.com>

* fixed formatting

Signed-off-by: Kai Wagner <kai.wagner@percona.com>

* cosmetics and Ubuntu 24.04 support

Signed-off-by: Kai Wagner <kai.wagner@percona.com>

* added missing step to configure the main repo

Signed-off-by: Kai Wagner <kai.wagner@percona.com>

* more cosmetics

Signed-off-by: Kai Wagner <kai.wagner@percona.com>

* added smaller enhancements for users

Signed-off-by: Kai Wagner <kai.wagner@percona.com>

* with the setup upfront, the only would drop the main repos

Signed-off-by: Kai Wagner <kai.wagner@percona.com>

---------

Signed-off-by: Kai Wagner <kai.wagner@percona.com>
pull/209/head
Kai Wagner 10 months ago committed by GitHub
parent 5f95c34096
commit 2f31c0ed45
No known key found for this signature in database
GPG Key ID: B5690EEEBB952194
  1. 55
      documentation/docs/apt.md
  2. 1
      documentation/docs/install.md
  3. 14
      documentation/docs/setup.md
  4. 25
      documentation/docs/test.md
  5. 2
      documentation/docs/uninstall.md
  6. 50
      documentation/docs/yum.md

@ -1,7 +1,5 @@
# Install `pg_tde` on Debian or Ubuntu # Install `pg_tde` on Debian or Ubuntu
The packages for `pg_tde` {{release}} are available in the testing repository for Percona Distribution for PostgreSQL 16.
The packages for the tech preview `pg_tde` are available in the experimental repository for Percona Distribution for PostgreSQL 17. The packages for the tech preview `pg_tde` are available in the experimental repository for Percona Distribution for PostgreSQL 17.
Check the [list of supported platforms](install.md#__tabbed_1_2). Check the [list of supported platforms](install.md#__tabbed_1_2).
@ -39,19 +37,19 @@ You need the `percona-release` repository management tool that enables the desir
4. Enable the Percona Distribution for PostgreSQL repository 4. Enable the Percona Distribution for PostgreSQL repository
=== "pg_tde Beta" Percona provides [two repositories](repo-overview.md) for Percona Distribution for PostgreSQL. We recommend enabling the Major release repository to timely receive the latest updates.
```bash ```{.bash data-prompt="$"}
sudo percona-release enable-only ppg-{{pgversion16}} testing $ sudo percona-release setup ppg-17
``` ```
=== "pg_tde Tech preview" 5. Enable the experimental Percona Distribution for PostgreSQL repository that contains the pg_tde package
```bash ```bash
sudo percona-release enable-only ppg-{{pgversion17}} experimental sudo percona-release enable ppg-{{pgversion17}} experimental
``` ```
5. Update the local cache 6. Update the local cache
```bash ```bash
sudo apt-get update sudo apt-get update
@ -59,37 +57,20 @@ You need the `percona-release` repository management tool that enables the desir
## Install `pg_tde` ## Install `pg_tde`
=== "pg_tde Beta"
1. Install Percona Distribution for PostgreSQL.
Run the following command to install Percona Distribution for PostgreSQL and the required packages:
```bash
sudo apt-get install -y percona-postgresql-16 percona-postgresql-contrib percona-postgresql-server-dev-all
```
2. Install `pg_tde` packages 1. Install Percona Distribution for PostgreSQL.
```bash Run the following command to install Percona Distribution for PostgreSQL and the required packages:
sudo apt-get install percona-postgresql-16-pg-tde
```
=== "pg_tde Tech preview" ```bash
sudo apt-get install -y percona-postgresql-17 percona-postgresql-contrib percona-postgresql-server-dev-all
1. Install Percona Distribution for PostgreSQL. ```
Run the following command to install Percona Distribution for PostgreSQL and the required packages:
```bash
sudo apt-get install -y percona-postgresql-17 percona-postgresql-contrib percona-postgresql-server-dev-all
```
2. Install `pg_tde` packages 2. Install `pg_tde` packages
```bash ```bash
sudo apt-get install percona-postgresql-17-pg-tde sudo apt-get install percona-postgresql-17-pg-tde
``` ```
## Next step ## Next step

@ -25,6 +25,7 @@ Install `pg_tde` using one of available installation methods:
- Red Hat Enterprise Linux 9 and compatible derivatives - Red Hat Enterprise Linux 9 and compatible derivatives
- Ubuntu 20.04 (Focal Fossa) - Ubuntu 20.04 (Focal Fossa)
- Ubuntu 22.04 (Jammy Jellyfish) - Ubuntu 22.04 (Jammy Jellyfish)
- Ubuntu 24.04 (Noble Numbat)
- Debian 11 (Bullseye) - Debian 11 (Bullseye)
- Debian 12 (Bookworm) - Debian 12 (Bookworm)

@ -66,6 +66,12 @@ Load the `pg_tde` at the start time. The extension requires additional shared me
SELECT pg_tde_add_key_provider_file('provider-name','/path/to/the/keyring/data.file'); SELECT pg_tde_add_key_provider_file('provider-name','/path/to/the/keyring/data.file');
``` ```
<i warning>:material-information: Warning:</i> Example for testing purposes only:
```sql
SELECT pg_tde_add_key_provider_file('file-vault','/tmp/pg_tde_test_local_keyring.per');
```
2. Add a principal key 2. Add a principal key
@ -73,6 +79,12 @@ Load the `pg_tde` at the start time. The extension requires additional shared me
SELECT pg_tde_set_principal_key('name-of-the-principal-key', 'provider-name'); SELECT pg_tde_set_principal_key('name-of-the-principal-key', 'provider-name');
``` ```
<i warning>:material-information: Warning:</i> Example for testing purposes only:
```sql
SELECT pg_tde_set_principal_key('test-db-master-key','file-vault');
```
<i info>:material-information: Info:</i> The key provider configuration is stored in the database catalog in an unencrypted table. See [how to use external reference to parameters](external-parameters.md) to add an extra security layer to your setup. <i info>:material-information: Info:</i> The key provider configuration is stored in the database catalog in an unencrypted table. See [how to use external reference to parameters](external-parameters.md) to add an extra security layer to your setup.
@ -104,7 +116,7 @@ After you [enabled `pg_tde`](#enable-extension) and started the Percona Server f
Set up the key provider for WAL encryption Set up the key provider for WAL encryption
=== "With HashiCorp Vault" === "With HashiCorp Vault"
```sql ```sql
SELECT pg_tde_add_key_provider_vault_v2('PG_TDE_GLOBAL','provider-name',:'secret_token','url','mount','ca_path'); SELECT pg_tde_add_key_provider_vault_v2('PG_TDE_GLOBAL','provider-name',:'secret_token','url','mount','ca_path');

@ -1,8 +1,12 @@
# Test Transparent Data Encryption # Test Transparent Data Encryption
!!! warning To check if the data is encrypted, do the following:
=== "pg_tde Tech preview"
!!! warning
This is the tech preview functionality. Its scope is not yet finalized and can change anytime.** Use it only for testing purposes.** This is the tech preview functionality. Its scope is not yet finalized and can change anytime.** Use it only for testing purposes.**
To check if the data is encrypted, do the following: To check if the data is encrypted, do the following:
@ -12,6 +16,17 @@ To check if the data is encrypted, do the following:
CREATE TABLE <table_name> (<field> <datatype>) USING tde_heap; CREATE TABLE <table_name> (<field> <datatype>) USING tde_heap;
``` ```
<i warning>:material-information: Warning:</i> Example for testing purposes only:
```sql
CREATE TABLE albums (
album_id INTEGER GENERATED ALWAYS AS IDENTITY PRIMARY KEY,
artist_id INTEGER,
title TEXT NOT NULL,
released DATE NOT NULL
) USING tde_heap;
```
2. Run the following function: 2. Run the following function:
```sql ```sql
@ -30,6 +45,12 @@ To check if the data is encrypted, do the following:
SELECT pg_tde_rotate_principal_key('new-principal-key', 'new-provider'); -- changeprovider SELECT pg_tde_rotate_principal_key('new-principal-key', 'new-provider'); -- changeprovider
``` ```
4. You can encrypt existing table. It requires rewriting the table, so for large tables, it might take a considerable amount of time.
```sql
ALTER TABLE table_name SET access method tde_heap;
```
!!! hint !!! hint
If you no longer wish to use `pg_tde` or wish to switch to using the `tde_heap_basic` access method, see how you can [decrypt your data](decrypt.md). If you no longer wish to use `pg_tde` or wish to switch to using the `tde_heap_basic` access method, see how you can [decrypt your data](decrypt.md).

@ -27,5 +27,5 @@ Here's how to do it:
* On RHEL and derivatives * On RHEL and derivatives
```sh ```sh
sudo systemctl restart postgresql-16 sudo systemctl restart postgresql-17
``` ```

@ -1,7 +1,5 @@
# Install `pg_tde` on Red Hat Enterprise Linux and derivatives # Install `pg_tde` on Red Hat Enterprise Linux and derivatives
The packages for `pg_tde` {{release}} are available in the testing repository for Percona Distribution for PostgreSQL 16.
The packages for the tech preview `pg_tde` are available in the experimental repository for Percona Distribution for PostgreSQL 17. The packages for the tech preview `pg_tde` are available in the experimental repository for Percona Distribution for PostgreSQL 17.
Check the [list of supported platforms](install.md#__tabbed_1_2). Check the [list of supported platforms](install.md#__tabbed_1_2).
@ -30,49 +28,23 @@ You need the `percona-release` repository management tool that enables the desir
2. Enable the repository 2. Enable the repository
Enable the Percona Distribution for PostgreSQL repository ```bash
sudo percona-release enable-only ppg-{{pgversion17}} experimental
=== "pg_tde Beta" ```
```bash
sudo percona-release enable-only ppg-{{pgversion16}} testing
```
=== "pg_tde Tech preview"
```bash
sudo percona-release enable-only ppg-{{pgversion17}} experimental
```
## Install `pg_tde` ## Install `pg_tde`
=== "pg_tde Beta" 1. Install Percona Distribution for PostgreSQL 17 and the required packages, run the following command:
1. Install Percona Distribution for PostgreSQL 16 and the required packages, run the following command:
```bash
sudo yum -y install percona-postgresql-client-common percona-postgresql-common percona-postgresql-server-dev-all percona-postgresql16 percona-postgresql16-contrib percona-postgresql16-devel percona-postgresql16-libs
```
2. Install `pg_tde` packages ```bash
sudo yum -y install percona-postgresql-client-common percona-postgresql-common percona-postgresql-server-dev-all percona-postgresql17 percona-postgresql17-contrib percona-postgresql17-devel percona-postgresql17-libs
```bash ```
sudo yum install percona-pg_tde_16
```
=== "pg_tde Tech preview"
1. Install Percona Distribution for PostgreSQL 16 and the required packages, run the following command:
```bash
sudo yum -y install percona-postgresql-client-common percona-postgresql-common percona-postgresql-server-dev-all percona-postgresql17 percona-postgresql17-contrib percona-postgresql17-devel percona-postgresql17-libs
```
2. Install `pg_tde` packages 2. Install `pg_tde` packages
```bash ```bash
sudo yum install percona-pg_tde_17 sudo yum install percona-pg_tde_17
``` ```
## Next steps ## Next steps

Loading…
Cancel
Save