Skip to content

Commit a1ec6b3

Browse files
committed
Improved readability
1 parent c446c65 commit a1ec6b3

File tree

6 files changed

+105
-95
lines changed

6 files changed

+105
-95
lines changed

contrib/pg_tde/documentation/docs/architecture.md

+96-86
Large diffs are not rendered by default.

contrib/pg_tde/documentation/docs/faq.md

+3-3
Original file line numberDiff line numberDiff line change
@@ -77,17 +77,17 @@ HashiCorp Vault can also act as the KMIP server, managing cryptographic keys for
7777

7878
Here’s how encryption of data files works:
7979

80-
First, data files are encrypted with internal keys. Each file that has a different OID, has an internal key. For example, a table with 4 indexes will have 5 internal keys - one for the table and one for each index.
80+
First, data files are encrypted with internal keys. Each file that has a different [Object Identifier (OID)](https://www.postgresql.org/docs/current/datatype-oid.html) has an internal key. For example, a table with 4 indexes will have 5 internal keys - one for the table and one for each index.
8181

82-
The initial decision on what file to encrypt is based on the table access method in PostgreSQL. When you run a `CREATE` or `ALTER TABLE` statement with the `USING tde_heap` clause, the newly created data files are marked as encrypted, and then file operations encrypt/decrypt the data. Later, if an initial file is re-created as a result of a `TRUNCATE` or `VACUUM FULL` command, the newly created file inherits the encryption information and is either encrypted or not.
82+
The initial decision on what file to encrypt is based on the table access method in PostgreSQL. When you run a `CREATE` or `ALTER TABLE` statement with the `USING tde_heap` clause, the newly created data files are marked as encrypted, and then file operations encrypt or decrypt the data. Later, if an initial file is re-created as a result of a `TRUNCATE` or `VACUUM FULL` command, the newly created file inherits the encryption information and is either encrypted or not.
8383

8484
The principal key is used to encrypt the internal keys. The principal key is stored in the key management store. When you query the table, the principal key is retrieved from the key store to decrypt the table. Then the internal key for that table is used to decrypt the data.
8585

8686
WAL encryption is done globally for the entire database cluster. All modifications to any database within a PostgreSQL cluster are written to the same WAL to maintain data consistency and integrity and ensure that PostgreSQL cluster can be restored to a consistent state. Therefore, WAL is encrypted globally.
8787

8888
When you turn on WAL encryption, `pg_tde` encrypts entire WAL files starting from the first WAL write after the server was started with the encryption turned on.
8989

90-
The same 2-tier approach is used with WAL as with the table data: WAL pages are first encrypted with the internal key. Then the internal key is encrypted with the global principal key.
90+
The same 2-key approach is used with WAL as with the table data: WAL pages are first encrypted with the internal key. Then the internal key is encrypted with the global principal key.
9191

9292
You can turn WAL encryption on and off so WAL can contain both encrypted and unencrypted data. The WAL encryption GUC variable influences only writes.
9393

contrib/pg_tde/documentation/docs/functions.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -264,7 +264,7 @@ You can also verify if the table in a custom schema is encrypted. Pass the schem
264264
SELECT pg_tde_is_encrypted('schema.table_name');
265265
```
266266

267-
This can additoonally be used the verify that indexes and sequences are encrypted.
267+
This can additionally be used the verify that indexes and sequences are encrypted.
268268

269269
### pg_tde_principal_key_info
270270

contrib/pg_tde/documentation/docs/index.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -2,7 +2,7 @@
22

33
`pg_tde` is the open source PostgreSQL extension that provides Transparent Data Encryption (TDE) to protect data at rest. This ensures that the data stored on disk is encrypted, and no one can read it without the proper encryption keys, even if they gain access to the physical storage media.
44

5-
Learn more [what is Transparent Data Encryption](tde.md#how-does-it-work) and [why you need it](tde.md#why-do-you-need-tde).
5+
Learn more [what Transparent Data Encryption is](tde.md#how-does-it-work) and [why you need it](tde.md#why-do-you-need-tde).
66

77
!!! important
88

contrib/pg_tde/documentation/docs/install.md

+2-2
Original file line numberDiff line numberDiff line change
@@ -21,13 +21,13 @@ Install `pg_tde` using one of the available installation methods:
2121

2222
`pg_tde` is a part of the Percona Distribution for PostgreSQL Docker image. Use this image to enjoy full encryption capabilities. Check below to get access to a detailed step-by-step guide.
2323

24-
[Run in Docker :material-arrow-right:](https://docs.percona.com/postgresql/latest/docker.html)
24+
[Run in Docker :material-arrow-right:](https://docs.percona.com/postgresql/latest/docker.html){.md-button}
2525

2626
=== ":octicons-download-16: Manual download"
2727

2828
`pg_tde` is included in the Percona Distribution for PostgreSQL tarball. Check below to get access to a detailed step-by-step guide.
2929

30-
[Install from tarballs](https://docs.percona.com/postgresql/17/tarball.html) guide for instructions.
30+
[Install from tarballs :material-arrow-right:](https://docs.percona.com/postgresql/17/tarball.html){.md-button}
3131

3232

3333
## Next steps

contrib/pg_tde/documentation/mkdocs.yml

+2-2
Original file line numberDiff line numberDiff line change
@@ -52,6 +52,7 @@ theme:
5252
- content.tabs.link
5353
- navigation.top
5454
- navigation.tracking
55+
- navigation.indexes
5556

5657

5758

@@ -92,8 +93,6 @@ markdown_extensions:
9293
linenums: false
9394
- pymdownx.snippets:
9495
base_path: ["snippets"]
95-
# auto_append:
96-
# - services-banner.md
9796
- pymdownx.emoji:
9897
emoji_index: !!python/name:material.extensions.emoji.twemoji
9998
emoji_generator: !!python/name:material.extensions.emoji.to_svg
@@ -169,6 +168,7 @@ nav:
169168
- Concepts:
170169
- "What is TDE": tde.md
171170
- table-access-method.md
171+
- architecture.md
172172
- How to:
173173
- Set up multi-tenancy: multi-tenant-setup.md
174174
- Use reference to external parameters: external-parameters.md

0 commit comments

Comments
 (0)