omnipitr

This Release
omnipitr 2.0.0
Date
Status
Stable
Other Releases
Abstract
Advanced WAL File / Backup Management Tools
Description
OmniPITR provides a set of tools for managing PITR, including archive_commands, restore_commands, and creating backups from either the master or slave server
Released By
depesz
License
PostgreSQL
Resources
Special Files
Tags

Extensions

omnipitr 2.0.0
Advanced WAL File / Backup Management Tools

Documentation

omnipitr-monitor
OmniPITR - omnipitr-monitor
ParallelSystem
NAME
Tools
ext_for_compression()
Check
NAME
internals
OmniPITR
Monitor
run()
Restore
run()
omnipitr-synch
OmniPITR - omnipitr-synch
Log
new()
todo
OmniPITR
omnipitr-backup-slave
OmniPITR - omnipitr-backup-slave
intro
OmniPITR
Archive
Parser/Archvie state data structure
changes
OmniPITR
omnipitr-backup-master
OmniPITR - omnipitr-backup-master
Master
make_data_archive()
Cleanup
run()
Checksum
run()
Backup
run()
Pidfile
NAME
Archive
run()
Archive_Queue
split_xlog_filename()
omnipitr-backup-cleanup
OmniPITR - omnipitr-backup-cleanup
Slave
make_data_archive()
Restore
Parser/Restore state data structure
omnipitr-restore
OmniPITR - omnipitr-restore
howto
OmniPITR - how to setup.
omnipitr-cleanup
OmniPITR - omnipitr-cleanup
Backup
Backup_Slave/Backup_Master *base* state data structure
Cleanup
run()
Synch
run()
omnipitr-archive
OmniPITR - omnipitr-archive
install
OmniPITR - Installation
CommandPiper
NAME
Parser
NAME
Program
new()

README

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/

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

LICENCE INFORMATION

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