Skip to main content
Version: 2.9

Back up PostgreSQL on Kubernetes

You can use the instructions on this page to create pre and post backup rules with Portworx Backup, which take application-consistent backups for PostgreSQL on Kubernetes in production.

Postgres places data within a data directory known as PGDATA. The most common location for PGDATA is /var/lib/pgsql/data. You must configure your Kubernetes spec file with this volumeMount when using a persistent volume.

PGDATA contains control, configuration, and data files related to the Postgres server which need to be backed up. Assigning the PGDATA directory a persistent volume claim allows Portworx Backup to back up and restore Postgres server data.

Postgres suggests taking a CHECKPOINT to flush data to disk before any snapshots.

Installation​

Prerequisites​

note

  • Postgres pods should use the label app=postgres for this example.

  • If the Postgres username and password are available in the pod as an environment variable, the below actions can be used. If not, you may need to adjust the command.

Create rules for PostgreSQL​

Create rules for PostgreSQL that will run both before and after the backup operation runs:

Create a pre-exec backup rule for PostgreSQL​

For the pre-backup rule, you will create a CHECKPOINT rule that will run within our Postgres pod(s).

  1. From the home page, navigate to Settings > Rules > Add New.

  2. In the Add Rule window, provide the following details:

  • Rule name: add a name for your backup rule

  • Pod Selector: add the following app label app=postgres

  • Container: ignore this field

  • Action: add the following action

  1. Add the following action:

    PGPASSWORD=$POSTGRES_PASSWORD; psql -U "$POSTGRES_USER" -c "CHECKPOINT";

Create a post-exec backup rule for PostgreSQL​

PostgreSQL is designed in such a way that it is crash consistent. Since there is no outright read or write locking done with Postgres, it will start back up as if it has crashed. This is perfectly fine and expected because it is crash safe and designed to work that way.

In other words, because we are using consistent and atomic snapshots taken by Portworx Backup with CHECKPOINT, A post-backup rule is not needed.

Use the rules during backup of PostgreSQL​

During the backup creation process, select the rules in the pre-exec and post-exec drop-down lists:

  • Once you have populated all the fields of Create Backup window, click Create.

Demo​

Watch this short demo of the above information.