Skip to content

Commit 5161291

Browse files
authored
Reorganize toc / overview chapter / update topic headings (#468)
Reorganized how the ToC website interaction is done by renaming index.md from CLI, architecture, advanced topics, KMS and Overview (index folder). This meant updating links in multiple other files as index files needed to be renamed for the structure to work. Reorganized how Overview is displayed, removed RC2 mention in Limitations, removed important note as it is no longer needed since it was an RC2 mention. Reworded the button texts for better interaction and user expectation in the Overview chapter topics. Added a short intro for Benefits of pg_tde topic, rewrote admonition. Updated KMS titles to reflect Percona Style Guide.
1 parent 96e4944 commit 5161291

33 files changed

+86
-82
lines changed
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
1-
# Technical Reference
1+
# Overview of technical capabilities
22

33
This section covers the internal components and tools that power `pg_tde`.
44

55
Use it to understand how encryption is implemented, fine-tune a configuration, leverage advanced CLI tools and functions for diagnostics and customization.
66

7-
[Architecture](../architecture/index.md){.md-button} [GUC Variables](../variables.md){.md-button} [Functions](../functions.md){.md-button}
7+
[Architecture](../architecture/architecture.md){.md-button} [GUC Variables](../variables.md){.md-button} [Functions](../functions.md){.md-button}

contrib/pg_tde/documentation/docs/architecture/index.md renamed to contrib/pg_tde/documentation/docs/architecture/architecture.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -167,7 +167,7 @@ Key provider configuration or location may change. For example, a service is mov
167167

168168
In certain cases you can't use SQL functions to manage key providers. For example, if the key provider changed while the server wasn't running and is therefore unaware of these changes. The startup can fail if it needs to access the encryption keys.
169169

170-
For such situations, `pg_tde` also provides [command line tools](../command-line-tools/index.md) to recover the database.
170+
For such situations, `pg_tde` also provides [command line tools](../command-line-tools/cli-tools.md) to recover the database.
171171

172172
### Sensitive key provider information
173173

contrib/pg_tde/documentation/docs/command-line-tools/index.md renamed to contrib/pg_tde/documentation/docs/command-line-tools/cli-tools.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
1-
# pg_tde CLI Tools
1+
# Overview of pg_tde CLI tools
22

33
The `pg_tde` extension introduces new command-line utilities and extends some existing PostgreSQL tools to support encrypted WAL and tables. These include:
44

contrib/pg_tde/documentation/docs/faq.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -142,7 +142,7 @@ You must restart the database in the following cases to apply the changes:
142142
* after you enabled the `pg_tde` extension
143143
* when enabling WAL encryption, which is currently in beta. **Do not enable this feature in production environments**.
144144

145-
After that, no database restart is required. When you create or alter the table using the `tde_heap` access method, the files are marked as those that require encryption. The encryption happens at the storage manager level, before a transaction is written to disk. Read more about [how tde_heap works](index/table-access-method.md#how-tde_heap-works).
145+
After that, no database restart is required. When you create or alter the table using the `tde_heap` access method, the files are marked as those that require encryption. The encryption happens at the storage manager level, before a transaction is written to disk. Read more about [how tde_heap works](index/table-access-method.md#how-tde_heap-works-with-pg_tde).
146146

147147
## What happens to my data if I lose a principal key?
148148

contrib/pg_tde/documentation/docs/features.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -19,4 +19,4 @@ The following features are available for the extension:
1919
* Table-level granularity for encryption and access control
2020
* Multiple [Key management options](global-key-provider-configuration/index.md)
2121

22-
[What is Transparent Data Encryption (TDE)?](index/index.md){.md-button} [Install pg_tde to get started](install.md){.md-button}
22+
[Learn more about TDE and pg_tde :material-arrow-right:](index/about-tde.md){.md-button} [Get started with installation :material-arrow-right:](install.md){.md-button}

contrib/pg_tde/documentation/docs/global-key-provider-configuration/keyring.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
1-
# Keyring File Configuration
1+
# Keyring file configuration
22

33
This setup is intended for development and stores the keys unencrypted in the specified data file.
44

contrib/pg_tde/documentation/docs/global-key-provider-configuration/kmip-fortanix.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
1-
# Fortanix KMIP Server Configuration
1+
# Fortanix KMIP server configuration
22

33
`pg_tde` is compatible with Fortanix Data Security Manager (DSM) via the KMIP protocol. For a full setup guide, see [the Fortanix KMIP documentation here](https://support.fortanix.com/docs/users-guide-account-client-configurations?highlight=KMIP#23-kmip-clients).
44

contrib/pg_tde/documentation/docs/global-key-provider-configuration/kmip-openbao.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
1-
# Using OpenBao as a Key Provider
1+
# Using OpenBao as a key provider
22

33
You can configure `pg_tde` to use OpenBao as a global key provider for managing encryption keys securely.
44

contrib/pg_tde/documentation/docs/global-key-provider-configuration/kmip-server.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
1-
# KMIP Configuration
1+
# KMIP configuration
22

33
To use a Key Management Interoperability Protocol (KMIP) server with `pg_tde`, you must configure it as a global key provider. This setup enables `pg_tde` to securely fetch and manage encryption keys from a centralized key management appliance.
44

contrib/pg_tde/documentation/docs/global-key-provider-configuration/kmip-thales.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
1-
# Thales KMIP Server Configuration
1+
# Thales KMIP server configuration
22

33
`pg_tde` is compatible with the Thales CipherTrust Manager via the KMIP protocol. For a full setup guide, see [the Thales documentation](https://thalesdocs.com/ctp/cm/2.19/reference/kmip-ref/index.html?).
44

0 commit comments

Comments
 (0)