Reference v23
Installation
Running TPA in a Docker container
How to run TPA itself from within a Docker container, for systems where TPA is not supported natively.
Managing clusters in a disconnected or air-gapped environment
How to manage clusters in a disconnected or air-gapped environment
Distribution support
Which Linux distributions are supported by TPA.
TPA capabilities and supported software
What software can be installed and configured by TPA.
Administration
Reconciling changes made outside of TPA
How to reconcile changes made outside of TPA with the configuration in `config.yml`.
Services
EDB Postgres Distributed configuration
How to configure and deploy EDB Postgres Distributed (PGD) with TPA.
Barman
Configuring Barman for backup and recovery with TPA.
Configuring EFM
How to install and configure EFM with TPA.
Configuring haproxy
How to install and configure haproxy with TPA.
Configuring HARP
Configuring HARP for BDR-Always-ON clusters.
Configuring Postgres Enterprise Manager (PEM)
Installing and configuring Postgres Enterprise Manager (PEM) with TPA.
Configuring PgBouncer
Adding PgBouncer to your Postgres cluster.
Configuring pgd-proxy
Incorporating pgd-proxy into your TPA deployed PGD 5 cluster.
pglogical configuration
Configuring pglogical replication with TPA.
Configuring repmgr
How to install and configure repmgr with TPA.
Configuration
Configuring EDB Repos 2.0 repositories
How to configure EDB Repos 2.0 package repositories.
Configuring APT repositories
Configuring APT repositories for Debian and Ubuntu systems.
Configuring YUM repositories
Configuring YUM package repositories on RedHat systems.
Creating and using a local repository
Creating and using a local repository with TPA.
Installing from source
Building and installing Postgres extensions from source.
Git credentials
How to authenticate to Git repositories during deployment.
Environment
Controlling the target instances environment during deployment.
Python environment
The Python environment used by TPA and how to configure it.
Configuring /etc/hosts
Configuring /etc/hosts on instances with TPA
Filesystem configuration
Configuring volumes for instances in a TPA cluster.
Uploading artifacts
Uploading files and directories to target instances with TPA.
ssh_key_file
About the ssh_key_file setting in config.yml and how to use an existing SSH keypair for a cluster.
Managing SSH host keys
Managing a cluster's SSH host keys with TPA.
Postgres source installation
Building Postgres from source using TPA.
Installing packages
Installing packages on target instances with TPA.
Running initdb
Running initdb to initialise a Postgres data directory on a target instance.
Installing Postgres-related packages
Adding extra packages that depend on Postgres to your cluster.
SSL Certificates
Enabling the pg-backup-api and configuring client cert authentication.
Setting sysctl values
Setting sysctl values for target instances.
Postgres configuration
Creating Postgres databases
Creating Postgres databases during deployment.
Creating Postgres tablespaces
Tablespaces in Postgres and how to configure them with TPA.
Configuring .pgpass
Defining the generated .pgpass file with TPA.
The postgres Unix user
How TPA configures the Postgres system user
Creating Postgres users
Creating Postgres users during deployment.
Commands
tpaexec archive-logs
How to archive logs from a TPA cluster.
tpaexec download-packages
The command that downloads packages for a TPA cluster.
TPA custom commands
Creating custom commands for TPA to perform tasks specific to your environment.
TPA custom tests
How to write custom tests for TPA clusters.
PGD Lightweight
Configuring a PGD Lightweight cluster with TPA.
Configuring the beacon agent
Integrating TPA deployments with EDB Postgres AI using the agent
Compliance
Generating standards-compliant clusters with TPA
Locale
Setting the locale for the target instance.
Patroni cluster management commands
Using Patroni as a failover manager with TPA.
pg_hba.conf
Customizing the pg_hba.conf file for your Postgres cluster.
pg_ident.conf
Working with pg_ident.conf.
Adding Postgres extensions
Postgres extensions and how to configure them with TPA.
postgresql.conf
Modifying postgresql.conf on a TPA-managed Postgres cluster.
tpaexec deprovision
The command that destroys a cluster and associated resources.
tpaexec info
A command to output information about the TPA installation.
tpaexec reconfigure
The command that reads config.yml, changes the cluster in various ways and outputs a new config.yml.