Installation

pglift can be installed from PyPI. Python 3.10 or higher is required.

$ # In a dedicated virtualenv
$ python3 -m venv --upgrade-deps .venv
$ . .venv/bin/activate
(.venv) $ pip install "pglift[cli]"

$ pipx install "pglift[cli]"

$ # Using uv tool
$ uv tool install pglift-cli --with pglift
$ # Or in a virtualenv
$ uv venv
$ uv pip install pglift[cli]

$ # For advanced users who want for example to test unreleased features
$ python3 -m venv --upgrade-deps .venv
$ . .venv/bin/activate
(.venv) $ pip install ./lib ./cli

Once installed, the pglift command should be available:

Usage: pglift [OPTIONS] COMMAND [ARGS]...

  Deploy production-ready instances of PostgreSQL

Options:
  -L, --log-level [DEBUG|INFO|WARNING|ERROR|CRITICAL]
                                  Set log threshold (default to INFO when
                                  logging to stderr or WARNING when logging to
                                  a file).
  -l, --log-file LOGFILE          Write logs to LOGFILE, instead of stderr.
  --interactive / --non-interactive
                                  Interactively prompt for confirmation when
                                  needed (the default), or automatically pick
                                  the default option for all choices.
  --version                       Show program version.
  --help                          Show this message and exit.

Commands:
  instance  Manage instances.
  pgconf    Manage configuration of a PostgreSQL instance.
  role      Manage roles.
  database  Manage databases.

Warning

If the pglift executable is unavailable (ie. command not found), it may mean that the CLI is not installed. Make sure you installed pglift with the [cli] extra.

Runtime dependencies

pglift operates PostgreSQL and a number of satellite components, each available as independent software packages. Thus, depending on the components selected (see site settings), the following packages might be needed:

  • postgresql (required, including libpq)

  • pgbackrest

  • prometheus-postgres-exporter

  • powa (with pg_qualstats and pg_stat_kcache)

  • temboard-agent

  • patroni

Site configuration

An extra step is usually required as part of site configuration to install extra data files (like base configuration files for satellite components or systemd unit templates). This is done by invoking:

$ pglift site-configure install

Conversely, uninstallation may be done through pglift site-configure uninstall.

If installation is incomplete or the command has not been run at all, any operation will fail with an error message suggesting to perform a proper installation.

Warning

The exact result of site-configure commands depends on site settings; so changing those after having run the install command will quite likely break the site installation (and probably make already created instances non-functional).