From 0fb0f06a4d8a1a386dddb8206a2915a8fd121da9 Mon Sep 17 00:00:00 2001 From: Anastasia Alexadrova Date: Tue, 28 Nov 2023 18:03:06 +0100 Subject: [PATCH] Added GH action --- .github/workflows/doc-build.yaml | 1 + documentation/docs/index.md | 17 ++++++++++++++--- documentation/docs/replication.md | 2 ++ documentation/docs/setup.md | 3 +++ documentation/docs/test.md | 3 +++ documentation/mkdocs.yml | 2 ++ 6 files changed, 25 insertions(+), 3 deletions(-) create mode 100644 documentation/docs/replication.md create mode 100644 documentation/docs/test.md diff --git a/.github/workflows/doc-build.yaml b/.github/workflows/doc-build.yaml index c7afc717..f1199ed6 100644 --- a/.github/workflows/doc-build.yaml +++ b/.github/workflows/doc-build.yaml @@ -50,6 +50,7 @@ jobs: cd documentation mike deploy main -p mike set-default main -p + mike retitle main "MVP" -p # - name: Install Node.js 14.x diff --git a/documentation/docs/index.md b/documentation/docs/index.md index 9325f891..65044a72 100644 --- a/documentation/docs/index.md +++ b/documentation/docs/index.md @@ -6,13 +6,24 @@ This is the MVP version of the extension. +## What's encrypted + `pg_tde` encrypts the following: -* user data in tables, including TOAST tables, that are created using the extension. Metadata of those tables is not encrypted. +* User data in tables, including TOAST tables, that are created using the extension. Metadata of those tables is not encrypted. * Write-Ahead Log (WAL) data for tables created using the extension * Temporary tables created during the database operation for data tables created using the extension -The encryption of indexes is planned for the next releases of `pg_tde`. +## What's not encrypted + +In the MVP version of `pg_tde`, the following remains unencrypted: + +* Indexes +* Logical replication +* `NULL` bitmaps of tuples +* Keys in the keyring file + +Their encryption is planned for the next releases of `pg_tde`. :material-alert: Warning: Note that introducing encryption/decryption affects performance. Our benchmark tests show appr. 10% performance overhead. @@ -23,7 +34,7 @@ The encryption of indexes is planned for the next releases of `pg_tde`. `pg_tde` is currently supported for Percona Distribution for PostgreSQL 16 and PostgreSQL 16. -## Useful links: +## Useful links * [What is Transparent Data Encryption](tde.md) diff --git a/documentation/docs/replication.md b/documentation/docs/replication.md new file mode 100644 index 00000000..f0e505df --- /dev/null +++ b/documentation/docs/replication.md @@ -0,0 +1,2 @@ +# Streaming replication configuration + diff --git a/documentation/docs/setup.md b/documentation/docs/setup.md index bc645b1f..c48199c7 100644 --- a/documentation/docs/setup.md +++ b/documentation/docs/setup.md @@ -27,7 +27,10 @@ Load the `pg_tde` at the start time. The extension requires additional shared me ```sql CREATE EXTENSION pg_tde; ``` + + By default, the `pg_tde` extension is created for the + 4. Set the location of the keyring configuration file in postgresql.conf: `pg_tde.keyringConfigFile = '/where/to/put/the/keyring.json'` 5. Create the [keyring configuration file](#keyring-configuration) 6. Start or restart the `postgresql` instance to apply the changes. diff --git a/documentation/docs/test.md b/documentation/docs/test.md new file mode 100644 index 00000000..9c36ff96 --- /dev/null +++ b/documentation/docs/test.md @@ -0,0 +1,3 @@ +# Test Transparent Data Encryption + +To check if the data is encrypted, do the following \ No newline at end of file diff --git a/documentation/mkdocs.yml b/documentation/mkdocs.yml index 1d3323f2..36f6cc93 100644 --- a/documentation/mkdocs.yml +++ b/documentation/mkdocs.yml @@ -123,6 +123,8 @@ nav: - Get started: - "Install": "install.md" - "Set up": "setup.md" + - Test TDE: "test.md" + - How to: - Configure streaming replication: replication.md - contributing.md