Added GH action

Percona-Lab · Nov 29, 2023 · 0fb0f06 · 0fb0f06
1 parent 3af82a8
commit 0fb0f06
Show file tree

Hide file tree

Showing 6 changed files with 25 additions and 3 deletions.
diff --git 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
@@ -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`.
 
 <i warning>:material-alert: Warning:</i> 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
@@ -0,0 +1,2 @@
+# Streaming replication configuration
+
diff --git 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
@@ -0,0 +1,3 @@
+# Test Transparent Data Encryption
+
+To check if the data is encrypted, do the following
diff --git 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