Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

PG-1025 Doc update for PG 17 and release notes #664

Open
wants to merge 9 commits into
base: 17
Choose a base branch
from
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
10 changes: 5 additions & 5 deletions .github/workflows/main.yml
Original file line number Diff line number Diff line change
@@ -1,8 +1,8 @@
name: Build Percona Distribution PostgreSQL 16 docs
name: Build Percona Distribution PostgreSQL 17 docs
on:
push:
branches:
- 16
- 17

jobs:
build:
Expand Down Expand Up @@ -42,9 +42,9 @@ jobs:
# Deploy docs
- name: Deploy docs
run: |
mike deploy 16 -b publish -p
mike set-default 16 -b publish -p
mike retitle 16 "16 (LATEST)" -b publish -p
mike deploy 17 -b publish -p
mike set-default 17 -b publish -p
mike retitle 17 "17 (LATEST)" -b publish -p

# - name: Install Node.js 14.x
# uses: percona-platform/setup-node@v2
Expand Down
36 changes: 36 additions & 0 deletions _resource/.icons/percona/logo-postgresql.svg
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
2 changes: 1 addition & 1 deletion _resource/overrides/main.html
Original file line number Diff line number Diff line change
Expand Up @@ -55,7 +55,7 @@ <h4>Contact Us </h4>
{% include "partials/nav.html" %}
<br>
<label class="md-nav__title" for="__drawer">
<a href="https://learn.percona.com/download-manual-percona-distribution-for-postgresql-16" onclick="_gaq.push(['b._trackEvent', 'Percona Distribution for PostgreSQL', 'Download', 'Download Manual Distribution for PostgreSQL']);" class="md-nav__link md-nav__link--active" style="font-size: .7rem;">
<a href="https://learn.percona.com/download-manual-percona-distribution-for-postgresql-17" onclick="_gaq.push(['b._trackEvent', 'Percona Distribution for PostgreSQL', 'Download', 'Download Manual Distribution for PostgreSQL']);" class="md-nav__link md-nav__link--active" style="font-size: .7rem;">
Download PDF
</a>
</label>
Expand Down
2 changes: 1 addition & 1 deletion _resource/overrides/partials/header.html
Original file line number Diff line number Diff line change
Expand Up @@ -43,7 +43,7 @@
<path d="m7.825 13 5.6 5.6L12 20l-8-8 8-8 1.425 1.4-5.6 5.6H20v2H7.825Z"/>
</g>
</svg>
<span>Percona Documentation</span>
<span>Percona Software for PostgreSQL Documentation</span>
</a>
</div>
</div>
Expand Down
23 changes: 20 additions & 3 deletions docs/apt.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,8 +4,13 @@ This document describes how to install Percona Server for PostgreSQL from Percon

## Preconditions

1. Debian and other systems that use the `apt` package manager include the upstream PostgreSQL server package `postgresql-16` by default. The components of Percona Distribution for PostgreSQL 16 can only be installed together with the PostgreSQL server shipped by Percona (`percona-postgresql-16`). If you wish to use Percona Distribution for PostgreSQL, uninstall the `postgresql-16` package provided by your distribution and then install the chosen components from Percona Distribution for PostgreSQL.
2. Install `curl` for [Telemetry](telemetry.md). We use it to better understand the use of our products and improve them.
1. Debian and other systems that use the `apt` package manager include the upstream PostgreSQL server package `postgresql-{{pgversion}}` by default. The components of Percona Distribution for PostgreSQL {{pgversion}} can only be installed together with Percona Server for PostgreSQL (`percona-postgresql-{{pgversion}}`). If you wish to use Percona Distribution for PostgreSQL, uninstall the `postgresql-{{pgversion}}` package provided by your distribution and then install the chosen components from Percona Distribution for PostgreSQL.
2. Install `curl` for [Telemetry](telemetry.md). We use it to better understand the use of our products and improve them. To install `curl`, run the following command:

```{.bash data-prompt="$"}
$ sudo apt install curl
```


## Procedure

Expand Down Expand Up @@ -88,7 +93,7 @@ Run all the commands in the following sections as root or using the `sudo` comma
$ sudo apt install percona-patroni
```

[Install `pg_stat_monitor`](pg-stat-monitor.md)
[Install `pg_stat_monitor` :octicons-link-external-16:](https://docs.percona.com/pg-stat-monitor/install.html#__tabbed_1_1)


Install `pgBouncer`:
Expand Down Expand Up @@ -150,6 +155,18 @@ The installation process automatically initializes and starts the default databa
$ sudo systemctl status postgresql.service
```

Check the Percona Distribution for PostgreSQL version:

```{.bash data-prompt="$"}
$ psql --version
```

??? example "Sample output"

```{.text .no-copy}
psql (PostgreSQL) {{pspgversion}} (Percona Server for PostgreSQL) - Percona Distribution
```

Congratulations! Your Percona Distribution for PostgreSQL is up and running.

## Next steps
Expand Down
1 change: 1 addition & 0 deletions docs/docker.md
Original file line number Diff line number Diff line change
Expand Up @@ -96,6 +96,7 @@ Where:
* `container-name` is the name of your container that you will use to connect to the database container using the `psql` command line client
`tag-multi` is the tag specifying the version you need. For example, `{{dockertag}}-multi`. The `multi` part of the tag serves to identify the architecture (x86_64 or ARM64) and pull the respective image.
* `address` is the network address where your database container is running. Use 127.0.0.1, if the database container is running on the local machine/host.

## Enable `pg_stat_monitor`

To enable the `pg_stat_monitor` extension after launching the container, do the following:
Expand Down
4 changes: 2 additions & 2 deletions docs/enable-extensions.md
Original file line number Diff line number Diff line change
Expand Up @@ -60,7 +60,7 @@ For details about each option, see [pdBadger documentation :octicons-link-extern

## pgaudit

Add the `pgaudit` to `shared_preload_libraries` in `postgresql.conf`. The recommended way is to use the [ALTER SYSTEM](https://www.postgresql.org/docs/16/sql-altersystem.html) command. [Connect to psql](#connect-to-the-postgresql-server) and use the following command:
Add the `pgaudit` to `shared_preload_libraries` in `postgresql.conf`. The recommended way is to use the [ALTER SYSTEM](https://www.postgresql.org/docs/17/sql-altersystem.html) command. [Connect to psql](#connect-to-the-postgresql-server) and use the following command:

```sql
ALTER SYSTEM SET shared_preload_libraries = 'pgaudit';
Expand All @@ -84,7 +84,7 @@ CREATE EXTENSION pgaudit;

## pgaudit set-user

Add the `set-user` to `shared_preload_libraries` in `postgresql.conf`. The recommended way is to use the [ALTER SYSTEM :octicons-link-external-16:](https://www.postgresql.org/docs/16/sql-altersystem.html) command. [Connect to psql](connect.md) and use the following command:
Add the `set-user` to `shared_preload_libraries` in `postgresql.conf`. The recommended way is to use the [ALTER SYSTEM :octicons-link-external-16:](https://www.postgresql.org/docs/17/sql-altersystem.html) command. [Connect to psql](connect.md) and use the following command:

```sql
ALTER SYSTEM SET shared_preload_libraries = 'set-user';
Expand Down
10 changes: 3 additions & 7 deletions docs/extensions.md
Original file line number Diff line number Diff line change
@@ -1,18 +1,14 @@
# Extensions

Percona Distribution for PostgreSQL is not only the PostgreSQL server. It also includes extensions - the add-ons that enhance the functionality of PostgreSQL database. By installing these extensions, you can modify and extend your database server with new features, functions, and data types.
Percona Distribution for PostgreSQL is not only [Percona Server for PostgreSQL](postgresql-server.md). It also includes extensions - the add-ons that enhance the functionality of PostgreSQL database. By installing these extensions, you can modify and extend your database server with new features, functions, and data types.

Percona Distribution for PostgreSQL includes the extensions that have been tested to work together. These extensions encompass the following:

* [PostgreSQL contrib modules and utilities](contrib.md)
* Extensions authored by Percona:

* [`pg_stat_monitor`](pg-stat-monitor.md)
* [`pg_tde`](pg-tde.md)

* [Extensions authored by Percona](percona-ext.md)
* [Third-party components](third-party.md)

Percona also supports [extra modules](https://repo.percona.com/ppg-16-extras/), not included in Percona Distribution for PostgreSQL but tested to work with it.
Percona also supports [extra modules](https://repo.percona.com/ppg-17-extras/), not included in Percona Distribution for PostgreSQL but tested to work with it.

Additionally, see the list of [PostgreSQL software](https://www.percona.com/services/support/support-tiers-postgresql) covered by Percona Support.

Expand Down
13 changes: 7 additions & 6 deletions docs/index.md
Original file line number Diff line number Diff line change
@@ -1,10 +1,10 @@
# Percona Distribution for PostgreSQL 16 Documentation
# Percona Distribution for PostgreSQL 17 Documentation

Percona Distribution for PostgreSQL is a suite of open source software, tools and services required to deploy and maintain a reliable production cluster for PostgreSQL.
Percona Distribution for PostgreSQL is a suite of open source software, tools and services required to deploy and maintain a reliable production cluster for PostgreSQL.

Percona Distribution for PostgreSQL includes [PostgreSQL server :octicons-link-external-16:](https://www.postgresql.org/docs/16/index.html), packaged with extensions from open source community that are certified and tested to work together for high availability, backups, security, and monitoring that help ensure the cluster's peak performance.
Percona Distribution for PostgreSQL includes [Percona Server for PostgreSQL](postgresql-server.md) packaged with extensions from open source community that are certified and tested to work together for high availability, backups, security, and monitoring that help ensure the cluster's peak performance.

Part of the solution, Percona Operator for PostgreSQL, makes it easy to orchestrate the cluster reliably and repeatably in Kubernetes.
Part of the solution, Percona Operator for PostgreSQL, makes it easy to orchestrate the cluster reliably and repeatably in Kubernetes.

[What's included in Percona Distribution for PostgreSQL? :material-arrow-right:](extensions.md){.md-button}

Expand All @@ -16,10 +16,11 @@
- Spatial data handling support via PostGIS
- Monitoring of the database health, performance and infrastructure usage via open source [Percona Management and Monitoring :octicons-link-external-16:](https://www.percona.com/doc/percona-monitoring-and-management/2.x/index.html) with PostgreSQL-specific dashboards
- Run PostgreSQL on Kubernetes using open source [Percona Operator for PostgreSQL :octicons-link-external-16:](https://docs.percona.com/percona-operator-for-postgresql/2.0/index.html). It not only automates deployment and management of PostgreSQL clusters on Kubernetes, but also includes enterprise-ready features for high-availability, backup and restore, replication, logging, and more
nastena1606 marked this conversation as resolved.
Show resolved Hide resolved
- Automate PostgreSQL provisioning and management in Kubernetes, in the cloud or on-premises with [Percona Everest :octicons-link-external-16:](https://docs.percona.com/everest/index.html#why-percona-everest) - the cloud-native database platform

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

## :material-progress-download: Installation guides { .title }
### :material-progress-download: Installation guides { .title }

Get started quickly with the step-by-step installation instructions.

Expand Down Expand Up @@ -47,7 +48,7 @@ Our comprehensive resources will help you overcome challenges, from everyday iss

Learn about the releases and changes in the Distribution.

[Release notes :material-arrow-right:](release-notes.md){.md-button}
[Release notes :material-arrow-right:]({{release}}.md){.md-button}
</div>
</div>

Expand Down
4 changes: 2 additions & 2 deletions docs/installing.md
Original file line number Diff line number Diff line change
@@ -1,8 +1,8 @@
# Quickstart guide

Percona Distribution for PostgreSQL is the PostgreSQL server with the collection of tools from PostgreSQL community that are tested to work together and serve to assist you in deploying and managing PostgreSQL. [Read more](index.md).
Percona Distribution for PostgreSQL is the Percona server for PostgreSQL with the collection of tools from PostgreSQL community that are tested to work together and serve to assist you in deploying and managing PostgreSQL. [Read more](index.md).

This document aims to guide database application developers and DevOps engineer in getting started with Percona Distribution for PostgreSQL. Upon completion of this guide, you’ll have Percona Distribution for PostgreSQL installed and operational, and you’ll be able to:
This document aims to guide database application developers and DevOps engineers in getting started with Percona Distribution for PostgreSQL. Upon completion of this guide, you’ll have Percona Distribution for PostgreSQL installed and operational, and you’ll be able to:

* Connect to PostgreSQL using the `psql` interactive terminal
* Interact with PostgreSQL with basic psql commands
Expand Down
2 changes: 1 addition & 1 deletion docs/ldap.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,6 +2,6 @@

When a client application or a user that runs the client application connects to the database, it must identify themselves. The process of validating the client's identity and determining whether this client is permitted to access the database it has requested is called **authentication**.

Percona Distribution for PortgreSQL supports several [authentication methods :octicons-link-external-16:](https://www.postgresql.org/docs/15/auth-methods.html), including the [LDAP authentication :octicons-link-external-16:](https://www.postgresql.org/docs/14/auth-ldap.html). The use of LDAP is to provide a central place for authentication - meaning the LDAP server stores usernames and passwords and their resource permissions.
Percona Distribution for PortgreSQL supports several [authentication methods :octicons-link-external-16:](https://www.postgresql.org/docs/17/auth-methods.html), including the [LDAP authentication :octicons-link-external-16:](https://www.postgresql.org/docs/17/auth-ldap.html). The use of LDAP is to provide a central place for authentication - meaning the LDAP server stores usernames and passwords and their resource permissions.

The LDAP authentication in Percona Distribution for PortgreSQL is implemented the same way as in upstream PostgreSQL.
Loading