Skip to content

Latest commit

 

History

History
78 lines (42 loc) · 2.5 KB

README.pod

File metadata and controls

78 lines (42 loc) · 2.5 KB
Raw

OmniPITR

OVERVIEW

OmniPITR is a set of scripts to ease setting up WAL replication, and making hot backups from both Master and Slave systems.

This set of scripts has been written to make the operation seamless, secure and as light on resources-usage as possible.

To make it portable, it was written in Perl, but with assumption that it should work on any Perl installation - i.e. no dependencies on non-base Perl modules.

INSTALLATION

/* Simply fetch the directory https://github.com/omniti-labs/omnipitr, and you're done. More details are in doc/install.pod. */

USAGE

There is a set of scripts in bin/ directory. All named omnipitr-* are scripts meant for general usage (others are not really useful unless you'll encounter some problems).

For every one of them you will have documentation in doc/SCRIPT_NAME.pod - for example documentation for omnipitr-archive script is in doc/omnipitr-archive.pod.

Quick list of programs:

  • omnipitr-archive

    This should be used on master server, as archive_command command, setup in postgresql.conf.

  • omnipitr-restore

    This should be used on slave server/servers, as restore_command command in recovery.conf file.

  • omnipitr-master-backup

    Used to make hot backup on master DB server.

  • omnipitr-slave-backup

    Used to make hot backup on slave DB server.

  • omnipitr-monitor

    General script for Nagios/Cacti type of systems - monitoring, graphing. Provides a way to check for replication lag, last backup timestamp, and other metrics.

  • omnipitr-cleanup

    Removes obsolete wal segments from wal archive, when using streaming replication

  • omnipitr-sync

    Send copy of PGDATA to remote locations - even multiple at the same time.

  • omnipitr-backup-cleanup

    This can be called from scheduler (crontab) to enforce retention period (7 days is default) for backups and related WAL archive files.

In most of the cases you can simply call the program you want to use with --help option to get brief overview of command line options.

SUPPORT

Currently there is simply mailing list that you can subscribe, and post your questions/problems to.

Maling list page (includes option to subscribe, and view archives) is available here: http://lists.omniti.com/mailman/listinfo/pgtreats-users/

COPYRIGHT

The OmniPITR project is Copyright (c) 2009-2013 OmniTI. All rights reserved.

LICENCE INFORMATION

https://github.com/omniti-labs/omnipitr/blob/master/doc/LICENSE