Skip to content

Commit

Permalink
Added GH action
Browse files Browse the repository at this point in the history
  • Loading branch information
nastena1606 committed Nov 29, 2023
1 parent 3af82a8 commit 5922cb1
Show file tree
Hide file tree
Showing 7 changed files with 46 additions and 6 deletions.
1 change: 1 addition & 0 deletions .github/workflows/doc-build.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down
23 changes: 17 additions & 6 deletions documentation/docs/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,26 +4,37 @@

!!! important

This is the MVP version of the extension.
This is the MVP version of the extension and is not meant for production use yet.

## 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.
<i warning>:material-alert: Warning:</i> Note that introducing encryption/decryption affects performance. Our benchmark tests show less than 10% performance overhead.

[Get started](install.md){.md-button}

## Supported PostgreSQL versions

`pg_tde` is currently supported for Percona Distribution for PostgreSQL 16 and PostgreSQL 16.
`pg_tde` is currently supported for Percona Distribution for PostgreSQL 16 and upstream PostgreSQL 16.


## Useful links:
## Useful links

* [What is Transparent Data Encryption](tde.md)

2 changes: 2 additions & 0 deletions documentation/docs/replication.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,2 @@
# Streaming replication configuration

10 changes: 10 additions & 0 deletions documentation/docs/setup.md
Original file line number Diff line number Diff line change
Expand Up @@ -27,6 +27,16 @@ 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 `postgres` database or the database which your user owns. To encrypt the data in other databases, you must explicitly run the `CREATE EXTENSION` command for them.

!!! tip

You can have the `pg_tde` extension automatically enabled for every newly created database. Modify the template `template1` database as follows:

```
psql -d template1 -c 'CREATE EXTENSION pg_tde;'
```

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)
Expand Down
13 changes: 13 additions & 0 deletions documentation/docs/test.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,13 @@
# Test Transparent Data Encryption

To check if the data is encrypted, do the following:

1. Create a table in the database for which you have [enabled `pg_tde`](setup.md)
2. Insert some test data
3. Run the following function:

```sql
select pgtde_is_encrypted('table_name');
```

The function returns `t` if the table is encrypted and `f` - if not.
1 change: 1 addition & 0 deletions documentation/docs/uninstall.md
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
uninstall.md
2 changes: 2 additions & 0 deletions documentation/mkdocs.yml
Original file line number Diff line number Diff line change
Expand Up @@ -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

Expand Down

0 comments on commit 5922cb1

Please sign in to comment.