https://github.com/ome/ansible-role-postgresql-backup

Backup PostgreSQL database servers
https://github.com/ome/ansible-role-postgresql-backup

ansible ansible-role backup database ome openmicroscopy postgresql

Last synced: 11 months ago
JSON representation

Backup PostgreSQL database servers

• Host: GitHub
• URL: https://github.com/ome/ansible-role-postgresql-backup
• Owner: ome
• License: bsd-2-clause
• Created: 2018-07-10T11:16:35.000Z (almost 8 years ago)
• Default Branch: master
• Last Pushed: 2024-01-15T13:29:58.000Z (over 2 years ago)
• Last Synced: 2025-07-01T16:10:42.317Z (11 months ago)
• Topics: ansible, ansible-role, backup, database, ome, openmicroscopy, postgresql
• Language: Python
• Homepage: https://galaxy.ansible.com/ome/postgresql_backup/
• Size: 36.1 KB
• Stars: 5
• Watchers: 7
• Forks: 10
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • License: LICENSE.md

Awesome Lists containing this project

README

          
PostgreSQL Backup

=================

[![Actions Status](https://github.com/ome/ansible-role-postgresql-backup/workflows/Molecule/badge.svg)](https://github.com/ome/ansible-role-postgresql-backup/actions)

[![Ansible Role](https://img.shields.io/badge/ansible--galaxy-postgresql_backup-blue.svg)](https://galaxy.ansible.com/ui/standalone/roles/ome/postgresql_backup/)

Setup a cron job for regular full PostgreSQL database dumps.

Assumes the local `postgres` has password-less access to all databases (this is the default when installing PostgreSQL server).

Dependencies

------------

This requires a cron daemon to already be running.

This should be the default on most systems.

Role Variables

--------------

Required:

- `postgresql_backup_dir`: Save backups in this directory

Optional:

- `postgresql_backup_filename_format`: A filename containing unix `date` format sequences, default `{{ ansible_hostname }}-%Y%m%d-%H%M%S.pgdump` (or `{{ ansible_hostname }}-%Y%m%d-%H%M%S.pgdump.gz` if `postgresql_backup_compress: true`).

  This can be used to automatically overwrite backups on a rolling basis.

- `postgresql_backup_frequency`: This must match one of the standard `/etc/cron.*` directories, typically either `daily` (default), `hourly`, `weekly` or `monthly`.

- `postgresql_backup_minimum_expected_size`: The minimum size in bytes of the backup file.

  The cron job will return an error if the file is smaller than this.

- `postgresql_backup_compress`: If `true` compress the output using gzip, default `false`.

Example playbook

----------------

    # This will name the backup file /nfs/backups/HOSTNAME-Mon.pgdump

    # where Mon will be replaced by the abbreviated day of the week, resulting

    # in daily backups on a rolling weekly cycle

    - hosts: postgresql-servers

      roles:

      - role: ome.postgresql_backup

        postgresql_backup_dir: /nfs/backups

        postgresql_backup_filename_format: "{{ ansible_hostname }}-%a.pgdump"

        postgresql_backup_minimum_expected_size: 100000

Author Information

------------------

ome-devel@lists.openmicroscopy.org.uk