root/trunk/omnipitr/doc/intro.pod

Revision 159, 2.0 kB (checked in by depesz, 4 years ago)

be a bit more specific about where to use each tool

Line 
1 =head1 OmniPITR
2
3 =head2 OVERVIEW
4
5 OmniPITR is a set of scripts to ease setting up WAL replication, and making hot backups from both Master and Slave systems.
6
7 This set of scripts has been written to make the operation seamless, secure and as light on resources-usage as possible.
8
9 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.
10
11 =head2 INSTALLATION
12
13 Simply fetch the directory L<https://labs.omniti.com/pgsoltools/trunk/omnipitr>, and you're done. More details are in I<doc/install.pod>.
14
15 =head2 USAGE
16
17 There is a set of scripts in bin/ directory. All named I<omnipitr-*> are scripts meant for general usage (others are not really useful unless you'll encounter some problems).
18
19 For every one of them you will have documentation in I<doc/B<SCRIPT_NAME>.pod> - for example documentation for I<omnipitr-archive> script is in I<doc/omnipitr-archive.pod>.
20
21 Quick list of programs:
22
23 =over
24
25 =item * omnipitr-archive
26
27 This should be used on master server, as I<archive_command> command, setup in
28 postgresql.conf.
29
30 =item * omnipitr-restore
31
32 This should be used on slave server/servers, as I<restore_command> command in
33 recovery.conf file.
34
35 =item * omnipitr-master-backup
36
37 Used to make hot backup on master DB server.
38
39 =item * omnipitr-slave-backup
40
41 Used to make hot backup on slave DB server.
42
43 =item * omnipitr-monitor
44
45 General script for I<Nagios>/I<Cacti> type of systems - monitoring, graphing. Provides a way to check for replication lag, last backup timestamp, and other metrics.
46
47 =back
48
49 In most of the cases you can simply call the program you want to use with I<--help> option to get brief overview of command line options.
50
51 =head2 SUPPORT
52
53 Currently there is simply mailing list that you can subscribe, and post your
54 questions/problems to.
55
56 Maling list page (includes option to subscribe, and view archives) is available
57 here: http://lists.omniti.com/mailman/listinfo/pgtreats-users/
58
59 =head2 COPYRIGHT
60
61 The OmniPITR project is Copyright (c) 2009-2010 OmniTI. All rights reserved.
Note: See TracBrowser for help on using the browser.