omnipitr 2.0.0

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

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

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