Skip to content
Open
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
26 changes: 20 additions & 6 deletions docs/percona-ext.md
Original file line number Diff line number Diff line change
@@ -1,24 +1,38 @@
# Percona-authored extensions

Percona-authored extensions provide additional capabilities that go beyond upstream PostgreSQL, enabling advanced observability and data-at-rest encryption. These extensions are developed and maintained by Percona and are designed to integrate seamlessly with Percona Server for PostgreSQL and Percona Distribution for PostgreSQL.

This page provides a high-level overview of the available Percona-authored extensions and the problems they are intended to solve. For detailed configuration and usage instructions, follow the documentation links provided for each extension below.

<div data-grid markdown>
<div data-banner markdown>

### :octicons-graph-16: pg_stat_monitor
## :octicons-graph-16: pg_stat_monitor

A query performance monitoring tool for PostgreSQL that brings more insight and details around query performance, planning statistics and metadata. It improves observability, enabling users to debug and tune query performance with precision.
An open-source query performance monitoring tool for PostgreSQL that brings more insight and details around query performance, planning statistics and metadata. It improves observability, enabling users to debug and tune query performance with precision.

[pg_stat_monitor documentation :octicons-link-external-16:](https://docs.percona.com/pg-stat-monitor/index.html){.md-button}
[See the pg_stat_monitor documentation :octicons-link-external-16:](https://docs.percona.com/pg-stat-monitor/index.html){.md-button}
</div>

<div data-banner markdown>

### :material-file-key-outline: pg_tde
## :material-file-key-outline: pg_tde

An open-source extension designed to enhance PostgreSQL security by encrypting data files on disk. `pg_tde` protects data at rest by ensuring that database files cannot be read without the appropriate encryption keys. Encryption is transparent to applications and users at the SQL level, while key management is configured separately.

[See the pg_tde documentation :octicons-link-external-16:](https://docs.percona.com/pg-tde/index.html){.md-button}

</div>

<div data-banner markdown>

An open-source extension designed to enhance PostgreSQL’s security by encrypting data files on disk. The encryption is transparent for users allowing them to access and manipulate the data and not to worry about the encryption process.
## :material-file-key-outline: pg_oidc_validator

An **experimental** OAuth validator library for PostgreSQL 18 that validates OpenID Connect (OIDC) JWT access tokens. It integrates with PostgreSQL’s OAuth framework to verify tokens issued by compliant OIDC providers.

[pg_tde documentation :octicons-link-external-16:](https://docs.percona.com/pg-tde/index.html){.md-button}
**NOTE:** This library is still experimental and not intended for production use.

[Check the pg_oidc_validator GitHub repository :octicons-link-external-16:](https://github.com/Percona-Lab/pg_oidc_validator){.md-button}

</div>
</div>
16 changes: 10 additions & 6 deletions docs/postgresql-server.md
Original file line number Diff line number Diff line change
@@ -1,12 +1,16 @@
# Percona Server for PostgreSQL

Percona Server for PostgreSQL is a binary-compatible, open source drop-in replacement for PostgreSQL {{pgversion}}. It introduces additional features to the upstream server, including:
Percona Server for PostgreSQL is a binary-compatible, open source drop-in replacement for PostgreSQL {{pgversion}}. It functions identically to upstream PostgreSQL, allowing you to [migrate](migration.md) seamlessly between the two.

* Storage Manager (SMGR) API Exposure: Allows PostgreSQL extensions to integrate custom storage managers. This change was inspired by the [patchset](https://www.postgresql.org/message-id/flat/CAJ7c6TOqqrzjYsU6LgDkcJ0yVgzdkx2juJjgAjzP2jPOpZ1qUA%40mail.gmail.com#8e68cfc57fcac14c8e24b00b41e61baf) introduced to the community.
* WAL Read/Write API Exposure to hook into WAL read and write functions.
In addition to upstream functionality, Percona Server includes enhancements that enable advanced extension capabilities.

These modifications have no impact on existing use cases and operation of PostgreSQL. They are required to enable additional encryption capabilities such as index-level and Write-Ahead Logging (WAL) encryption of indexes through the [`pg_tde` :octicons-link-external-16:](https://docs.percona.com/pg-tde/index.html) extension. These encryption features provided by the `pg_tde` are still under active development and are planned for future releases.
## Enhancements

Percona Server and upstream PostgreSQL function identically enabling you to migrate from one to another.
* Storage Manager (SMGR) API exposure, which allows PostgreSQL extensions to integrate custom storage managers. This change was inspired by the following [patchset :octicons-link-external-16:](https://www.postgresql.org/message-id/flat/CAJ7c6TOqqrzjYsU6LgDkcJ0yVgzdkx2juJjgAjzP2jPOpZ1qUA%40mail.gmail.com#8e68cfc57fcac14c8e24b00b41e61baf) introduced to the community.
* WAL Read/Write API exposure, which allows extensions to hook into WAL read and write operations.

[Get started :material-arrow-right:](installing.md){.md-button}
These enhancements serve as the foundation for Percona-authored extensions, such as [`pg_tde`](https://docs.percona.com/pg-tde/index.html), which enables data-at-rest encryption.

For details about available extensions, see the [Percona-authored extensions topic](percona-ext.md).

For a broader overview of integrated tooling and deployment guidance, start with the [Percona Distribution for PostgreSQL Quickstart guide](installing.md).
20 changes: 15 additions & 5 deletions docs/solutions.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,8 @@
# Percona Distribution for PostgreSQL solutions

Find the right solution to help you achieve your organization's goals.
Find the right solution to help you achieve your organization's goals, such as high availability, backup and disaster recovery, spatial data handling, authentication, and [data-at-rest encryption :octicons-link-external-16:](https://docs.percona.com/pg-tde/index.html).

Explore the available solutions below:

<div data-grid markdown><div data-banner markdown>

Expand All @@ -12,6 +14,14 @@ Check out how you can ensure continuous access to your database.

</div><div data-banner markdown>

### :material-backup-restore: Backup and disaster recovery

Protect your database against accidental or malicious data loss or data corruption.

[Backup and disaster recovery :material-arrow-right:](solutions/backup-recovery.md){.md-button}

</div><div data-banner markdown>

### :octicons-globe-24: Spatial data handling

Dealing with spatial data? Learn how you can store and manipulate it.
Expand All @@ -20,11 +30,11 @@ Dealing with spatial data? Learn how you can store and manipulate it.

</div><div data-banner markdown>

### :material-backup-restore: Backup and disaster recovery
### :material-account-lock: LDAP authentication

Protect your database against accidental or malicious data loss or data corruption.
Need a central authentication solution? Learn how you can manage users and access control using LDAP directories.

[Backup and disaster recovery :material-arrow-right:](solutions/backup-recovery.md){.md-button}
[LDAP authentication :material-arrow-right:](ldap.md){.md-button}

</div>
</div>
</div>