Merge pull request #6029 from EnterpriseDB/TDE/pg_to_pge_upgrade

TDE: pg to pge tutorial while enabling TDE

product_docs/docs/tde/15/enabling_tde_epas.mdx

@@ -28,13 +28,17 @@ and use `pg_upgrade` to transfer data from the existing source cluster to the ne
 
 ## Worked example
 
+This example enables Transparent Data Encryption on an EDB Postgres Advanced Server version 16 running on an Ubuntu 22.04 machine. 
+
+A similar workflow applies to other versions of EDB Postgres Advanced Server and EDB Postgres Extended Server. Note that the location of the BIN and CONFIG directories differs depending on your operating system and the Postgres version.
+
 ### Preparing your upgrade 
 
 Use [pg_dumpall](https://www.postgresql.org/docs/current/app-pg-dumpall.html), [pgBackRest](/supported-open-source/pgbackrest/), or [Barman](/supported-open-source/barman/) to create a backup of your unencrypted source server. 
 
 ### Creating an encrypted server 
 
-1.  Create an empty directory for the new server: 
+1.  Create an empty directory for the new server. In this example, the directory name is **TDE**. 
 
     ```
     mkdir /var/lib/edb-as/16/TDE 

product_docs/docs/tde/15/index.mdx

@@ -13,7 +13,7 @@ navigation:
 - troubleshooting
 - backups
 - "#Upgrading"
-- upgrade_overview
+- upgrade_use_cases
 - pg_upgrade_arguments
 - "#Testing"
 - single_user

product_docs/docs/tde/15/pg_upgrade_arguments.mdx

@@ -15,7 +15,7 @@ For added certainty, if the old cluster is encrypted and the new cluster was ini
 
 See the description of the [initdb --copy-key-from=<file> option](enabling_tde/#using-initdb-tde-options) for information on copying a key from an existing cluster when preparing a new cluster as a target for `pg_upgrade`.
 
-See [Tutorials](upgrade_overview/#tutorials) for `--copy-by-block` usage examples. 
+See [Tutorials](upgrade_use_cases/#tutorials) for `--copy-by-block` usage examples. 
 
 ## `--key-unwrap-command=<command>`
 

product_docs/docs/tde/15/upgrade_overview.mdx → product_docs/docs/tde/15/upgrade_use_cases/index.mdx

@@ -3,7 +3,7 @@ title: "TDE pg_upgrade use cases"
 navTitle: TDE pg_upgrade use cases
 ---
 
-EDB supports using [pg_upgrade](https://www.postgresql.org/docs/current/pgupgrade.html) with additional [EDB upgrade arguments](pg_upgrade_arguments) to add encryption to unencrypted systems. 
+EDB supports using [pg_upgrade](https://www.postgresql.org/docs/current/pgupgrade.html) with additional [EDB upgrade arguments](../pg_upgrade_arguments) to add encryption to unencrypted systems. 
 This table provides an overview of supported use cases.
 
 | Use case                                                      | Source unencrypted server                     | Target encrypted server                                            |
@@ -27,4 +27,5 @@ To enable encryption:
 
 ## Tutorials 
 
-* [Enable TDE on an existing EDB Postgres Advanced Server database cluster](enabling_tde_epas).
+* [Enable TDE on an existing EDB Postgres Advanced Server database cluster](../enabling_tde_epas).
+* [Upgrade a PostgreSQL database server to EDB Postgres Extended Server while enabling TDE](postgres_to_extended).

product_docs/docs/tde/15/upgrade_use_cases/postgres_to_extended.mdx

@@ -0,0 +1,160 @@
+---
+title: "Upgrading PostgreSQL to EDB Postgres Extended Server while enabling TDE"
+navTitle: Upgrading PostgreSQL to EDB Postgres Extended Server
+deepToC: true
+---
+
+Create a new EDB Postgres Extended Server cluster with TDE enabled and use `pg_upgrade` to transfer data from the existing PostgreSQL cluster to the new encrypted cluster. 
+
+- [Prepare your upgrade](#preparing-your-upgrade) by performing a backup of the existing instance. 
+- [Create a new database server](#creating-an-encrypted-server)
+    - Create an empty directory for the new server and ensure `postgres` owns it.
+    - Set the environment variables to export the `wrap` and `unwrap` commands for encryption. 
+    - Initialize a server with encryption enabled.
+    - Change the default port, so the new server is available at another port. 
+    - Start the database server.
+    - Connect to the database server and ensure it is functioning.
+- [Upgrade to the encrypted server](#upgrading-to-the-encrypted-server)
+    - Stop both the source and the new server. 
+    - Use `pg_upgrade` with `--copy-by-block` option to copy data from the source server to the new server. Specify the source and target bin and data directories. 
+    - Start the new encrypted databaser server. 
+    - Connect to the encrypted database server and ensure the data was transfered. 
+- [Clean up and delete the source server](#cleaning-up-after-upgrade)
+    - Clean up the database and its statistics. 
+    - Remove the source PostgreSQL cluster with the script provided by `pg_upgrade`. 
+
+## Worked example
+
+This example upgrades a PostgreSQL 16 instance to EDB Postgres Extended Server 16 while enabling Transparent Data Encryption on an Ubuntu 22.04 machine. The location of the BIN and CONFIG directories differs depending on your operating system and Postgres versions.
+
+### Preparing your upgrade
+
+-   Install EDB Postgres Extended Server from the [EDB repository](https://www.enterprisedb.com/repos-downloads). Ensure the version you install has the same major version than the source server. `pg_upgrade` supports upgrades between minor and patch versions, but not between different major versions.
+
+-   Use [pg_dumpall](https://www.postgresql.org/docs/current/app-pg-dumpall.html), [pgBackRest](/supported-open-source/pgbackrest/), or [Barman](/supported-open-source/barman/) to create a backup of your unencrypted source server. 
+
+### Creating an encrypted server 
+
+1.  Create an empty directory for the new server. In this example, the directory name is **TDE**.
+
+    ```
+    mkdir /var/lib/edb-pge/16/TDE 
+    ```
+
+1.  Ensure the `postgres` user owns the directory:
+
+    ```
+    sudo chown postgres /var/lib/edb-pge/16/TDE
+    sudo chgrp /var/lib/edb-pge/16/TDE
+    ```
+
+1.  Set environment variables to export the `wrap` and `unwrap` commands:
+
+    ```
+    export PGDATAKEYWRAPCMD='openssl enc -e -aes-128-cbc -pass pass:ok -out %p'
+    export PGDATAKEYUNWRAPCMD='openssl enc -d -aes-128-cbc -pass pass:ok -in %p'
+    ```
+
+    !!!note
+       Alternatively, use the `--key-unwrap-command=<command>` and `--key-wrap-command=<command>` arguments when initializing the encrypted server to include the `wrap` and `unwrap` commands.
+
+       See [Using initdb TDE options](../enabling_tde/#using-initdb-tde-options) for more information on possible configurations.
+
+1.  Initialize the new server with encryption: 
+
+    ```
+    /usr/lib/edb-pge/16/bin/initdb --data-encryption -D /var/lib/edb-pge/16/TDE
+    ```
+
+    This command initializes a CONFIG directory with all configuration files for the encrypted server.
+
+1.  Modify the default port number in the configuration file of the encrypted instance. Uncomment the line with `#port` and change the port number. For example:
+
+    ```
+    port                    5590
+    ```
+
+1.  Start the encrypted server: 
+
+    ```
+    /usr/lib/edb-pge/16/bin/pg_ctl -D /var/lib/edb-pge/16/TDE start
+    ```
+
+1.  Connect to the server: 
+
+    ```
+    /usr/lib/edb-pge/16/bin/psql -p 5590
+    ```
+
+    !!!note
+       If you're using two different Postgres versions, use the psql utility of the encrypted server. Otherwise, the system will attempt to use psql from the previous instance.
+
+1.  To ensure the new server is encrypted, [check for TDE presence](../enabling_tde/#checking-for-tde-presence-using-sql). 
+
+### Upgrading to the encrypted server
+
+1.  Stop both servers:
+
+    ```
+    /usr/lib/postgresql/16/bin/pg_ctl -D /var/lib/postgresql/16/non-TDE stop
+    /usr/lib/edb-pge/16/bin/pg_ctl -D /var/lib/edb-pge/16/TDE stop
+    ```
+
+1.  To test for incompatibilities, run the `pg_upgrade` command in check mode. 
+
+    With `-b` and `-B`, specify the source and target BIN directories. With `-d` and `-D`, specify the source and target CONFIG directories.
+    Include the `--copy-by-block` option. 
+
+    ```  
+    /usr/lib/edb-pge/16/bin/pg_upgrade -b /usr/lib/postgresql/16/bin -B /usr/lib/edb-pge/16/bin -d /var/lib/postgresql/16/non-TDE -D /var/lib/edb-pge/16/TDE --copy-by-block --check
+    ```
+
+    !!!note
+       The `--check` mode performs preliminary checks without executing the command.
+
+1.  To copy data from the source server to the target server, run the `pg_upgrade` command in normal mode: 
+
+    ```
+    /usr/lib/edb-pge/16/bin/pg_upgrade -b /usr/lib/postgresql/16/bin -B /usr/lib/edb-pge/16/bin -d /var/lib/postgresql/16/non-TDE -D /var/lib/edb-pge/16/TDE --copy-by-block
+    ```
+
+1.  Restart the encrypted server: 
+
+    ```
+    /usr/lib/edb-pge/16/bin/pg_ctl -D /var/lib/edb-pge/16/TDE start
+    ```
+
+1.  Connect to the encrypted database server:
+
+    ```
+    /usr/lib/edb-pge/16/bin/psql -p 5590
+    ```
+
+1.  Perform a spot check to ensure the databases, tables, schemas, and resources you had in the unencrypted server are available in the new server. For example, list all databases:
+
+    ```
+    \l
+    ```
+
+    Connect to a database, for example `hr`, and search for existing tables: 
+
+    ```
+    \c hr 
+    SELECT * FROM dept;
+    ```
+
+### Cleaning up after upgrade 
+
+After you verify that `pg_upgrade` encrypted the data successfully, perform a cleanup. 
+
+1.  As the `postgres` user, clean up the database and its statistics: 
+
+    ```
+    /usr/lib/edb-pge/16/bin/vacuumdb --all --analyze-in-stages
+    ```
+
+1.  Remove all data files of the unencrypted server with the script generated by `pg_upgrade`:
+
+    ```
+    ./delete_old_cluster.sh
+    ```