TPA installation v23
To use TPA, you need to install from packages or source and run the
tpaexec setup
command. This document explains how to install TPA
packages. If you have an EDB subscription plan, and therefore have
access to the EDB repositories, you should follow these instructions. To
install TPA from source, please refer to
Installing TPA from Source.
See Distribution support for information on what platforms are supported.
Info
Please make absolutely sure that your system has the correct
date and time set, because various things will fail otherwise. We
recommend you use a network time, for example sudo ntpdate
pool.ntp.org
Quickstart
Login to EDB Repos 2.0
to obtain your token. Then execute the following command, substituting
your token for <your-token>
and replacing <your-plan>
with
one of the following according to which EDB plan you are subscribed:
enterprise
, standard
, community360
, postgres_distributed
.
Add repository and install TPA on Debian or Ubuntu
Add repository and install TPA on RHEL, Rocky, AlmaLinux or Oracle Linux
Install additional dependencies
Verify installation (run as a normal user)
More detailed explanations of each step are given below.
Where to install TPA
As long as you are using a supported platform, TPA can be installed and run from your workstation. This is fine for learning, local testing or demonstration purposes. TPA supports deploying to Docker containers should you wish to perform a complete deployment on your own workstation.
For production use, we recommend running TPA on a dedicated, persistent virtual machine. We recommend this because it ensures that the cluster directories are retained and available to your team for future cluster management or update. It also means you only have to update one copy of TPA and you only need to provide network access from a single TPA host to the target instances.
Installing TPA packages
To install TPA, you must first subscribe to an EDB repository that provides it. The preferred source for repositories is EDB Repos 2.0.
Login to EDB Repos 2.0
to obtain your token. Then execute the following command, substituting
your token for <your-token>
and replacing <your-plan>
with
one of the following according to which EDB plan you are subscribed:
enterprise
, standard
, community360
, postgres_distributed
.
Add repository on Debian or Ubuntu
Add repository on RHEL, Rocky, AlmaLinux or Oracle Linux
Alternatively, you may obtain TPA from the legacy 2ndQuadrant repository. To do so, login to the EDB Customer Support Portal and subscribe to the "products/tpa/release" repository by adding a subscription under Support/Software/Subscriptions, and following the instructions to enable the repository on your system.
Once you have enabled one of these repositories, you may install TPA as follows:
Install on Debian or Ubuntu
Install on RHEL, Rocky, AlmaLinux or Oracle Linux
This will install TPA into /opt/EDB/TPA
. It will also
ensure that other required packages (e.g., Python 3.6 or later) are
installed.
We mention sudo
here only to indicate which commands need root
privileges. You may use any other means to run the commands as root.
Setting up the TPA Python environment
Next, run tpaexec setup
to create an isolated Python environment and
install the correct versions of all required modules.
Note
On Ubuntu versions prior to 20.04, please use sudo -H tpaexec setup
to avoid subsequent permission errors during tpaexec configure
You must run this as root because it writes to /opt/EDB/TPA
,
but the process will not affect any system-wide Python modules you may
have installed (including Ansible).
Add /opt/EDB/TPA/bin
to the PATH
of the user who will
normally run tpaexec
commands. For example, you could add this to
your .bashrc or equivalent shell configuration file:
Installing TPA without internet or network access (air-gapped)
This section describes how to install TPA onto a server which cannot access either the EDB repositories, a Python package index, or both. For information on how to use TPA in such an environment, please see Managing clusters in a disconnected or air-gapped environment
Downloading TPA packages
If you cannot access the EDB repositories directly from the server on which you need to install TPA, you can download the packages from an internet-connected machine and transfer them. There are several ways to achieve this.
If your internet-connected machine uses the same operating system as the
target, we recommend using yumdownloader
(RHEL-like) or apt download
(Debian-like) to download the packages.
If this is not possible, please contact EDB support and we will provide you with a download link or instructions appropriate to your subscription.
Installing without access to a Python package index
When you run tpaexec setup
, it will ordinarily download the Python
packages from a Python package index. Unless your environment provides a
different index the default is the official PyPI. If
no package index is available, you should install the tpaexec-deps
package in the same way your installed tpaexec
. The tpaexec-deps
package (available from the same repository as tpaexec) bundles
everything that would have been downloaded, so that they can be
installed without network access. Just install the package before you
run tpaexec setup
and the bundled copies will be used automatically.
Verifying your TPA installation
Once you're done with all of the above steps, run the following command to verify your local installation:
If that command completes without any errors, your TPA installation is ready for use.
Upgrading TPA
To upgrade to a later release of TPA, you must:
- Install the latest
tpaexec
package - Install the latest
tpaexec-deps
package (if required; see above) - Run
tpaexec setup
again
If you have subscribed to the TPA package repository as described
above, running apt-get update && apt-get upgrade
or yum update
should install the latest available versions of these packages. If not,
you can install the packages by any means available.
We recommend that you run tpaexec setup
again whenever a new version
of tpaexec
is installed. Some new releases may not strictly require
this, but others will not work without it.
Ansible community support
TPA now uses the community distribution of ansible by default; you can
continue to use the 2ndQuadrant/ansible fork by passing the
--use-2q-ansible
option to tpaexec setup
. In a future TPA release,
support for the 2ndQuadrant ansible fork will be removed.
For most users, this makes no difference. However, if you are using
--skip-tags
with 2ndQuadrant ansible, be aware that this is not supported
An alternative means of skipping tasks, compatible with all ansible
versions, will be provided before support for 2ndQuadrant ansible is
removed.