diff --git a/docs/apt.md b/docs/apt.md index 36f7bd1dc..3bd540cef 100644 --- a/docs/apt.md +++ b/docs/apt.md @@ -46,111 +46,99 @@ Run all the commands in the following sections as root or using the `sudo` comma $ sudo percona-release setup ppg-{{pgversion}} ``` -### Install packages +### Install packages individually -=== "Install using meta-package (deprecated)" +Run the following commands: - The [meta package](repo-overview.md#percona-ppg-server){:target=”_blank”} enables you to install several components of the distribution in one go. - - ```{.bash data-prompt="$"} - $ sudo apt install percona-ppg-server-{{pgversion}} - ``` +1. Install the PostgreSQL server package: -=== "Install packages individually" - - Run the following commands: - {.power-number} - - 1. Install the PostgreSQL server package: - - ```{.bash data-prompt="$"} - $ sudo apt install percona-postgresql-{{pgversion}} - ``` - - 2. Install the components: + ```{.bash data-prompt="$"} + $ sudo apt install percona-postgresql-{{pgversion}} + ``` - Install `pg_repack`: +2. Install the components: - ```{.bash data-prompt="$"} - $ sudo apt install percona-postgresql-{{pgversion}}-repack - ``` + Install `pg_repack`: - Install `pgAudit`: + ```{.bash data-prompt="$"} + $ sudo apt install percona-postgresql-{{pgversion}}-repack + ``` - ```{.bash data-prompt="$"} - $ sudo apt install percona-postgresql-{{pgversion}}-pgaudit - ``` + Install `pgAudit`: - Install `pgBackRest`: + ```{.bash data-prompt="$"} + $ sudo apt install percona-postgresql-{{pgversion}}-pgaudit + ``` - ```{.bash data-prompt="$"} - $ sudo apt install percona-pgbackrest - ``` + Install `pgBackRest`: - Install `Patroni`: + ```{.bash data-prompt="$"} + $ sudo apt install percona-pgbackrest + ``` - ```{.bash data-prompt="$"} - $ sudo apt install percona-patroni - ``` + Install `Patroni`: - [Install `pg_stat_monitor` :octicons-link-external-16:](https://docs.percona.com/pg-stat-monitor/install.html#__tabbed_1_1) + ```{.bash data-prompt="$"} + $ sudo apt install percona-patroni + ``` + [Install `pg_stat_monitor` :octicons-link-external-16:](https://docs.percona.com/pg-stat-monitor/install.html#__tabbed_1_1) - Install `pgBouncer`: + Install `pgBouncer`: - ```{.bash data-prompt="$"} - $ sudo apt install percona-pgbouncer - ``` + ```{.bash data-prompt="$"} + $ sudo apt install percona-pgbouncer + ``` - Install `pgAudit-set_user`: + Install `pgAudit-set_user`: - ```{.bash data-prompt="$"} - $ sudo apt install percona-pgaudit{{pgversion}}-set-user - ``` + ```{.bash data-prompt="$"} + $ sudo apt install percona-pgaudit{{pgversion}}-set-user + ``` - Install `pgBadger`: + Install `pgBadger`: - ```{.bash data-prompt="$"} - $ sudo apt install percona-pgbadger - ``` + ```{.bash data-prompt="$"} + $ sudo apt install percona-pgbadger + ``` - Install `wal2json`: + Install `wal2json`: - ```{.bash data-prompt="$"} - $ sudo apt install percona-postgresql-{{pgversion}}-wal2json - ``` + ```{.bash data-prompt="$"} + $ sudo apt install percona-postgresql-{{pgversion}}-wal2json + ``` - Install PostgreSQL contrib extensions: + Install PostgreSQL contrib extensions: - ```{.bash data-prompt="$"} - $ sudo apt install percona-postgresql-contrib - ``` + ```{.bash data-prompt="$"} + $ sudo apt install percona-postgresql-contrib + ``` - Install HAProxy + Install HAProxy - ```{.bash data-prompt="$"} - $ sudo apt install percona-haproxy - ``` - - Install pgpool2 + ```{.bash data-prompt="$"} + $ sudo apt install percona-haproxy + ``` + + Install pgpool2 - ```{.bash data-prompt="$"} - $ sudo apt install percona-pgpool2 - ``` + ```{.bash data-prompt="$"} + $ sudo apt install percona-pgpool2 + ``` - Install `pg_gather` + Install `pg_gather` - ```{.bash data-prompt="$"} - $ sudo apt install percona-pg-gather - ``` + ```{.bash data-prompt="$"} + $ sudo apt install percona-pg-gather + ``` - Install `pgvector` + Install `pgvector` - ```{.bash data-prompt="$"} - $ sudo apt install percona-postgresql-{{pgversion}}-pgvector - ``` + ```{.bash data-prompt="$"} + $ sudo apt install percona-postgresql-{{pgversion}}-pgvector + ``` - Some extensions require additional setup in order to use them with Percona Distribution for PostgreSQL. For more information, refer to [Enabling extensions](enable-extensions.md). + Some extensions require additional setup in order to use them with Percona Distribution for PostgreSQL. For more information, refer to [Enabling extensions](enable-extensions.md). ### Start the service diff --git a/docs/docker.md b/docs/docker.md index 4617dbb38..1d35ccec6 100644 --- a/docs/docker.md +++ b/docs/docker.md @@ -5,7 +5,6 @@ Docker images of Percona Distribution for PostgreSQL are hosted publicly on [Doc For more information about using Docker, see the [Docker Docs :octicons-link-external-16:](https://docs.docker.com/). !!! note - Make sure that you are using [the latest version of Docker :octicons-link-external-16:](https://docs.docker.com/get-docker/). The ones provided via `apt` and `yum` may be outdated and cause errors. By default, Docker pulls the image from Docker Hub if it is not available locally. @@ -16,8 +15,7 @@ For more information about using Docker, see the [Docker Docs :octicons-link-ext | Component name | Description | |-------------------------------|--------------------------------------| - | `percona-postgresql{{pgversion}}`| A metapackage that installs the latest version of PostgreSQL| - | `percona-postgresql{{pgversion}}-server` | The PostgreSQL server package. | + | `percona-postgresql{{pgversion}}-server` | The PostgreSQL server package. | | `percona-postgresql-common` | PostgreSQL database-cluster manager. It provides a structure under which multiple versions of PostgreSQL may be installed and/or multiple clusters maintained at one time.| | `percona-postgresql-client-common`| The manager for multiple PostgreSQL client versions.| | `percona-postgresql{{pgversion}}-contrib` | A collection of additional PostgreSQLcontrib extensions | @@ -44,8 +42,7 @@ For more information about using Docker, see the [Docker Docs :octicons-link-ext * `{{dockertag}}` is the tag specifying the version you need. Docker identifies the architecture (x86_64 or ARM64) and pulls the respective image. See the [full list of tags :octicons-link-external-16:](https://hub.docker.com/r/percona/percona-distribution-postgresql/tags/). !!! tip - - You can secure the password by exporting it to the environment file and using that to start the container. + You can secure the password by exporting it to the environment file and using that to start the container. 1. Export the password to the environment file: diff --git a/docs/repo-overview.md b/docs/repo-overview.md index 95ddf494b..4b7e765ff 100644 --- a/docs/repo-overview.md +++ b/docs/repo-overview.md @@ -5,51 +5,3 @@ Percona provides two repositories for Percona Distribution for PostgreSQL. | Major release repository | Minor release repository | | ------------------------ | ------------------------ | | *Major Release repository* (`ppg-{{pgversion}}`) it includes the latest version packages. Whenever a package is updated, the package manager of your operating system detects that and prompts you to update. As long as you update all Distribution packages at the same time, you can ensure that the packages you’re using have been tested and verified by Percona.

We recommend installing Percona Distribution for PostgreSQL from the *Major Release repository*| *Minor Release repository* includes a particular minor release of the database and all of the packages that were tested and verified to work with that minor release (e.g. `ppg-{{dockertag}}`). You may choose to install Percona Distribution for PostgreSQL from the Minor Release repository if you have decided to standardize on a particular release which has passed rigorous testing procedures and which has been verified to work with your applications. This allows you to deploy to a new host and ensure that you’ll be using the same version of all the Distribution packages, even if newer releases exist in other repositories.

The disadvantage of using a Minor Release repository is that you are locked in this particular release. When potentially critical fixes are released in a later minor version of the database, you will not be prompted for an upgrade by the package manager of your operating system. You would need to change the configured repository in order to install the upgrade.| - -## Repository contents - -Percona Distribution for PostgreSQL provides individual packages for its components. It also includes two meta-packages: `percona-ppg-server` and `percona-ppg-server-ha`. - -Using a meta-package, you can install all components it contains in one go. - -### `percona-ppg-server` - -=== "Package name on Debian/Ubuntu" - - `percona-ppg-server-{{pgversion}}` - -=== "Package name on RHEL/derivatives" - - `percona-ppg-server{{pgversion}}` - -The `percona-ppg-server` meta-package installs the PostgreSQL server with the following packages: - -| Package contents | Description | -| ---------------- | --------------------------------------- | -| `percona-postgresql{{pgversion}}-server` | The PostgreSQL server package. | -| `percona-postgresql-common` | PostgreSQL database-cluster manager. It provides a structure under which multiple versions of PostgreSQL may be installed and/or multiple clusters maintained at one time.| -| `percona-postgresql{{pgversion}}-contrib` | A collection of additional PostgreSQLcontrib extensions | -| `percona-pg-stat-monitor{{pgversion}}` | A Query Performance Monitoring tool for PostgreSQL. | -| `percona-pgaudit{{pgversion}}` | Provides detailed session or object audit logging via the standard PostgreSQL logging facility. | -| `percona-pg_repack{{pgversion}}`| rebuilds PostgreSQL database objects.| -| `percona-wal2json{{pgversion}}` | a PostgreSQL logical decoding JSON output plugin.| - - -### `percona-ppg-server-ha` - -=== "Package name on Debian/Ubuntu" - - `percona-ppg-server-ha-{{pgversion}}` - -=== "Package name on RHEL/derivatives" - - `percona-ppg-server-{{pgversion}}` - -The `percona-ppg-server-ha` meta-package installs high-availability components that are recommended by Percona: - -| Package contents | Description | -| ---------------- | --------------------------------------- | -| `percona-patroni`| A high-availability solution for PostgreSQL. | -| `percona-haproxy`| A high-availability and load-balancing solution | -| `etcd` | A consistent, distributed key-value store | -| `python3-python-etcd` | A Python client for etcd | diff --git a/docs/yum.md b/docs/yum.md index 31dad8b8a..0cf207884 100644 --- a/docs/yum.md +++ b/docs/yum.md @@ -382,114 +382,103 @@ $ sudo yum -y install curl $ sudo percona-release setup ppg{{pgversion}} ``` -### Install packages +### Install packages individually -=== "Install using meta-package" +Run the following commands: +{.power-number} - The [meta package](repo-overview.md#percona-ppg-server){:target=”_blank”} enables you to install several components of the distribution in one go. - - ```{.bash data-prompt="$"} - $ sudo yum install percona-ppg-server{{pgversion}} - ``` +1. Install the PostgreSQL server package: -=== "Install packages individually" - - Run the following commands: - {.power-number} - - 1. Install the PostgreSQL server package: + ```{.bash data-prompt="$"} + $ sudo yum install percona-postgresql{{pgversion}}-server + ``` - ```{.bash data-prompt="$"} - $ sudo yum install percona-postgresql{{pgversion}}-server - ``` +2. Install the following components: - 2. Install the components: + Install `pg_repack`: - Install `pg_repack`: + ```{.bash data-prompt="$"} + $ sudo yum install percona-pg_repack{{pgversion}} + ``` - ```{.bash data-prompt="$"} - $ sudo yum install percona-pg_repack{{pgversion}} - ``` + Install `pgaudit`: - Install `pgaudit`: + ```{.bash data-prompt="$"} + $ sudo yum install percona-pgaudit{{pgversion}} + ``` - ```{.bash data-prompt="$"} - $ sudo yum install percona-pgaudit{{pgversion}} - ``` + Install `pgBackRest`: - Install `pgBackRest`: + ```{.bash data-prompt="$"} + $ sudo yum install percona-pgbackrest + ``` - ```{.bash data-prompt="$"} - $ sudo yum install percona-pgbackrest - ``` + Install `Patroni`: - Install `Patroni`: + ```{.bash data-prompt="$"} + $ sudo yum install percona-patroni + ``` - ```{.bash data-prompt="$"} - $ sudo yum install percona-patroni - ``` + [Install `pg_stat_monitor` :octicons-link-external-16:](https://docs.percona.com/pg-stat-monitor/install.html#__tabbed_1_1). - [Install `pg_stat_monitor` :octicons-link-external-16:](https://docs.percona.com/pg-stat-monitor/install.html#__tabbed_1_1) + Install `pgBouncer`: + ```{.bash data-prompt="$"} + $ sudo yum install percona-pgbouncer + ``` - Install `pgBouncer`: + Install `pgAudit-set_user`: - ```{.bash data-prompt="$"} - $ sudo yum install percona-pgbouncer - ``` + ```{.bash data-prompt="$"} + $ sudo yum install percona-pgaudit{{pgversion}}_set_user + ``` - Install `pgAudit-set_user`: + Install `pgBadger`: - ```{.bash data-prompt="$"} - $ sudo yum install percona-pgaudit{{pgversion}}_set_user - ``` + ```{.bash data-prompt="$"} + $ sudo yum install percona-pgbadger + ``` - Install `pgBadger`: + Install `wal2json`: - ```{.bash data-prompt="$"} - $ sudo yum install percona-pgbadger - ``` + ```{.bash data-prompt="$"} + $ sudo yum install percona-wal2json{{pgversion}} + ``` - Install `wal2json`: + Install PostgreSQL contrib extensions: - ```{.bash data-prompt="$"} - $ sudo yum install percona-wal2json{{pgversion}} - ``` + ```{.bash data-prompt="$"} + $ sudo yum install percona-postgresql{{pgversion}}-contrib + ``` - Install PostgreSQL contrib extensions: + Install HAProxy: - ```{.bash data-prompt="$"} - $ sudo yum install percona-postgresql{{pgversion}}-contrib - ``` + ```{.bash data-prompt="$"} + $ sudo yum install percona-haproxy + ``` - Install HAProxy: - - ```{.bash data-prompt="$"} - $ sudo yum install percona-haproxy - ``` - - Install `pg_gather`: + Install `pg_gather`: - ```{.bash data-prompt="$"} - $ sudo yum install percona-pg_gather - ``` + ```{.bash data-prompt="$"} + $ sudo yum install percona-pg_gather + ``` - Install pgpool2: + Install pgpool2: - 1. Check the [platform specific notes](#for-pgpool2-extension) - 2. Install the extension + 1. Check the [platform specific notes](#for-pgpool2-extension). + 2. Install the extension: - ```{.bash data-prompt="$"} - $ sudo yum install percona-pgpool-II-pg{{pgversion}} - ``` + ```{.bash data-prompt="$"} + $ sudo yum install percona-pgpool-II-pg{{pgversion}} + ``` - Install pgvector package suite: + Install pgvector package suite: - ```{.bash data-prompt="$"} - $ sudo yum install percona-pgvector_{{pgversion}} percona-pgvector_{{pgversion}}-debuginfo percona-pgvector_{{pgversion}}-debugsource percona-pgvector_{{pgversion}}-llvmjit - ``` + ```{.bash data-prompt="$"} + $ sudo yum install percona-pgvector_{{pgversion}} percona-pgvector_{{pgversion}}-debuginfo percona-pgvector_{{pgversion}}-debugsource percona-pgvector_{{pgversion}}-llvmjit + ``` - Some extensions require additional setup in order to use them with Percona Distribution for PostgreSQL. For more information, refer to [Enabling extensions](enable-extensions.md). + Some extensions require additional setup in order to use them with Percona Distribution for PostgreSQL. For more information, refer to [Enable Percona Distribution for PostgreSQL components](enable-extensions.md). ### Start the service