Skip to content

Backport: Doc update from 0d46fe5, modified for v14 #786

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.

Sign up for GitHub

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

Merged
merged 1 commit into from
Apr 28, 2025
Merged

Backport: Doc update from 0d46fe5, modified for v14 #786

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
21 changes: 9 additions & 12 deletions docs/installing.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -4,14 +4,14 @@ Percona Distribution for PostgreSQL is the solution with the collection of tools

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:

* Connect to PostgreSQL using the `psql` interactive terminal
* Connect to PostgreSQL using the `psql` interactive terminal
* Interact with PostgreSQL with basic psql commands
* Manipulate data in PostgreSQL
* Manipulate data in PostgreSQL
* Understand the next steps you can take as a database application developer or administrator to expand your knowledge of Percona Distribution for PostgreSQL

## Install Percona Distribution for PostgreSQL

You can select from multiple easy-to-follow installation options, but **we recommend using a Package Manager** for a convenient and quick way to try the software first.
You can select from multiple easy-to-follow installation options, however **we strongly recommend using a Package Manager** for a convenient and quick way to try the software first.

=== ":octicons-terminal-16: Package manager"

Expand All @@ -24,7 +24,6 @@ You can select from multiple easy-to-follow installation options, but **we recom
[Install via apt :material-arrow-right:](apt.md){.md-button}
[Install via yum :material-arrow-right:](yum.md){.md-button}


=== ":simple-docker: Docker"

Get our image from Docker Hub and spin up a cluster on a Docker container for quick evaluation.
Expand All @@ -41,15 +40,13 @@ You can select from multiple easy-to-follow installation options, but **we recom

[Get started with Percona Operator :octicons-link-external-16:](https://docs.percona.com/percona-operator-for-postgresql/2.0/quickstart.html){.md-button}

=== ":octicons-download-16: Manual download"
=== ":octicons-download-16: Tar download (not recommended)"

If you need to install Percona Distribution for PostgreSQL offline or as a non-superuser, check out the link below for a step-by-step guide and get access to the downloads directory.
If installing the package (the **recommended** method for a safe, secure, and reliable setup) is not an option, refer to the link below for step-by-step instructions on installing from tarballs using the provided download links.

Note that for this scenario you must make sure that all dependencies are satisfied.
In this scenario, you must ensure that all dependencies are met. Failure to do so may result in errors or crashes.

!!! note

This method is **not recommended** for mission-critical environments.
[Install from tarballs :material-arrow-right:](tarball.md){.md-button}





43 changes: 25 additions & 18 deletions docs/tarball.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,13 +1,21 @@
# Install Percona Distribiution for PostgreSQL from binary tarballs
# Install Percona Distribution for PostgreSQL from binary tarballs

You can find the binary tarballs on the [Percona website](https://www.percona.com/downloads). Select the desired version from a version dropdown and _All_ from the Select Platform dropdown.
You can download the tarballs using the links below.

There are the following tarballs available for both x86-64 and ARM64 architectures:
!!! note

* percona-postgresql-{{dockertag}}-ssl1.1-linux-<architecture>.tar.gz - for operating systems that run OpenSSL version 1.x
* percona-postgresql-{{dockertag}}-ssl3-linux-<architecture>.tar.gz - for operating systems that run OpenSSL version 3.x
Unlike package managers, a tarball installation does **not** provide mechanisms to ensure that all dependencies are resolved to the correct library versions. There is no built-in method to verify that required libraries are present or to prevent them from being removed. As a result, unresolved or broken dependencies may lead to errors, crashes, or even data corruption.

For this reason, tarball installations are **not recommended** for environments where safety, security, reliability, or mission-critical stability are required.

The following tarballs are available for the x86_64 and ARM64 architectures:

* [percona-postgresql-{{dockertag}}-ssl1.1-linux-aarch64.tar.gz](https://downloads.percona.com/downloads/postgresql-distribution-14/{{dockertag}}/binary/tarball/percona-postgresql-{{dockertag}}-ssl1.1-linux-aarch64.tar.gz) - for operating systems on ARM64 architecture that run OpenSSL version 1.x
* [percona-postgresql-{{dockertag}}-ssl1.1-linux-x86_64.tar.gz](https://downloads.percona.com/downloads/postgresql-distribution-14/{{dockertag}}/binary/tarball/percona-postgresql-{{dockertag}}-ssl1.1-linux-x86_64.tar.gz) - for operating systems on x86_64 architecture that run OpenSSL version 1.x
* [percona-postgresql-{{dockertag}}-ssl3-linux-aarch64.tar.gz](https://downloads.percona.com/downloads/postgresql-distribution-14/{{dockertag}}/binary/tarball/percona-postgresql-{{dockertag}}-ssl3-linux-aarch64.tar.gz) - for operating systems on ARM64 architecture that run OpenSSL version 3.x
* [percona-postgresql-{{dockertag}}-ssl3-linux-x86_64.tar.gz](https://downloads.percona.com/downloads/postgresql-distribution-14/{{dockertag}}/binary/tarball/percona-postgresql-{{dockertag}}-ssl3-linux-x86_64.tar.gz) - for operating systems on x86_64 architecture that run OpenSSL version 3.x

To check what OpenSSL version you have, run the following command:
To check what OpenSSL version you have, run the following command:

```{.bash data-prompt="$"}
$ openssl version
Expand Down Expand Up @@ -36,7 +44,7 @@ The tarballs include the following components:

=== "Debian and Ubuntu"

1. Uninstall the upstream PostgreSQL package.
1. Uninstall the upstream PostgreSQL package.
2. Create the user to own the PostgreSQL process. For example, `mypguser`. Run the following command:

```{.bash data-prompt="$"}
Expand All @@ -51,7 +59,7 @@ The tarballs include the following components:

=== "RHEL and derivatives"

Create the user to own the PostgreSQL process. For example, `mypguser`, Run the following command:
Create the user to own the PostgreSQL process. For example, `mypguser`, Run the following command:

```{.bash data-prompt="$"}
$ sudo useradd mypguser -m
Expand All @@ -75,7 +83,7 @@ The steps below install the tarballs for OpenSSL 3.x on x86_64 architecture. Use
$ sudo chown mypguser:mypguser /opt/pgdistro/
```

3. Fetch the binary tarball:
3. Fetch the binary tarball.

```{.bash data-prompt="$"}
$ wget https://downloads.percona.com/downloads/postgresql-distribution-{{pgversion}}/{{dockertag}}/binary/tarball/percona-postgresql-{{dockertag}}-ssl3-linux-x86_64.tar.gz
Expand All @@ -87,12 +95,12 @@ The steps below install the tarballs for OpenSSL 3.x on x86_64 architecture. Use
$ sudo tar -xvf percona-postgresql-{{dockertag}}-ssl3-linux-x86_64.tar.gz -C /opt/pgdistro/
```

5. If you extracted the tarball in a directory other than `/opt`, copy `percona-python3`, `percona-tcl` and `percona-perl` to the `/opt` directory. This is required for the correct run of libraries that require those modules.
5. If you extracted the tarball in a directory other than `/opt`, copy `percona-python3`, `percona-tcl` and `percona-perl` to the `/opt` directory. This is required for the correct run of libraries that require those modules.

```{.bash data-prompt="$"}
$ sudo cp <path_to>/percona-perl <path_to>/percona-python3 <path_to>/percona-tcl /opt/
```

6. Add the location of the binaries to the PATH variable:

```{.bash data-prompt="$"}
Expand All @@ -113,7 +121,7 @@ The steps below install the tarballs for OpenSSL 3.x on x86_64 architecture. Use
```

9. Initiate the PostgreSQL data directory:

```{.bash data-prompt="$"}
$ /opt/pgdistro/percona-postgresql{{pgversion}}/bin/initdb -D /usr/local/pgsql/data
```
Expand All @@ -133,7 +141,7 @@ The steps below install the tarballs for OpenSSL 3.x on x86_64 architecture. Use
```

??? example "Sample output"

```{.text .no-copy}
waiting for server to start.... done
server started
Expand All @@ -152,15 +160,15 @@ The steps below install the tarballs for OpenSSL 3.x on x86_64 architecture. Use
```

??? example "Sample output"

```{.text .no-copy}
psql ({{dockertag}})
Type "help" for help.

postgres=#
```
## Start the components

### Start the components

After you unpacked the tarball and added the location of the components' binaries to the `$PATH` variable, the components are available for use. You can invoke a component by running its command-line tool.

Expand All @@ -171,4 +179,3 @@ $ haproxy version
```

Some components require additional setup. Check the [Enabling extensions](enable-extensions.md) page for details.