mmartinello / patroni-docker

Docker image for PostgreSQL and Patroni

PostgreSQL, pg_cron, PostGIS, pgRouting and Patroni Docker image

This Docker project builds a Docker image with PostgreSQL with a couple of plugins and Patroni installed on it.

PostgreSQL is a free and open-source relational database management system (RDBMS) emphasizing extensibility and SQL compliance.

Patroni is a template for high availability (HA) PostgreSQL solutions using Python. Patroni needs one of the following distributed configuration store systems: ZooKeeper, etcd, Consul or Kubernetes. In this image Patroni is installed with dependencies for etcd.

pg_cron is a simple cron-based job scheduler for PostgreSQL.

PostGIS extends the capabilities of the PostgreSQL relational database by adding support storing, indexing and querying geographic data.

pgRouting extends the PostGIS / PostgreSQL geospatial database to provide geospatial routing functionality.

Tags

Tags use the following schema: <patroni_version>-pg<pg_major_version>-<image_variant>.

Image variants refers to which PostgreSQL extensions are installed

• pgcron: pg_cron
• pgcron-postgis: pg_cron and PostGIS
• pgcron-pgrouting: pg_cron and pgRouting
• postgis: PostGIS
• postgis-pgrouting: PostGIS and pgRouting
• pgrouting: pgRouting

PostgreSQL and Patroni are installed in all image variants.

If image variant is not specified, all extensions are installed.

All images are based on Debian 12 Bullseye.

Volumes

The following volumes should be configured or mounted for data to be persistent:

• /var/log/patroni: the log directory where Patroni writes log files in
• /var/lib/postgresql: the PostgreSQL data directory where PostgreSQL write data into
• /etc/patroni.yml: the Patroni local configuration file

Ports

This Docker image listens on the following ports:

• PostgreSQL port: default 5432
• Patroni REST API port: default 8008

Configuration

Patroni can be configured in several ways: global dynamic configuration, local configuration file or environent variables. You can use the configuration type you prefer, or a group of them. Please refer to [Patroni documentation] (https://patroni.readthedocs.io/en/latest/patroni_configuration.html) for more information.

Build instructions

Build arguments (environment variables)

PG_MAJOR: set the PostgreSQL major version to be used (default 14).

INSTALL_PG_CRON: pg_cron will be installed if this variable is set to true, you can set it to false or any other value if you don't want pg_cron to be installed. The default value is true.

INSTALL_POSTGIS: PostGis will be installed if this variable is set to true, you can set it to false or any other value if you don't want PostGis to be installed. The default value is true.

INSTALL_PGROUTING: pgRouting will be installed if this variable is set to true, you can set it to false or any other value if you don't want pgRouting to be installed. The default value is true.

Build the image

You can build the Docker image using the docker build command:

docker build -t <image_tag> .

If you wish to specify some build arguments you can add them with the --build-arg parameter, for example:

docker build --build-arg='INSTALL_PG_CRON=false' -t <image_tag> .

Maintainer

Mattia Martinello