Permalink
Browse files

Release version 0.2.0

New feature: checksumming of backups (--digest option).
  • Loading branch information...
1 parent 84ac8fd commit f209c3221a9d824989f0cdff8174befb5fec8711 @depesz depesz committed Nov 10, 2011
View
@@ -2,7 +2,7 @@
"name": "omnipitr",
"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",
- "version": "0.1.3",
+ "version": "0.2.0",
"maintainer": "Robert Treat <rob@xzilla.net>",
"license": "postgresql",
"release_status": "stable",
@@ -32,7 +32,7 @@
"abstract": "Advanced WAL File / Backup Management Tools",
"file": "bin/omnipitr-archive",
"docfile": "doc/howto.pod",
- "version": "0.1.3"
+ "version": "0.2.0"
}
}
}
View
@@ -1,5 +1,16 @@
=head1 OmniPITR
+=head2 2011-11-10
+
+=over
+
+=item * Release version 0.2.0
+
+=item * Added ability to create checksums of backups, with --digest option for
+omnipitr-backup-master and omnipitr-backup-slave programs
+
+=back
+
=head2 2011-08-05
=over
@@ -95,6 +95,8 @@ Do not use nice for compressions.
Digest method to use (eg MD5 or SHA-1) for checksumming. Can be a comma
seperated list to use multiple digest algorithms.
+For details please check L<CHECKSUMMING> below.
+
=item --gzip-path (-gp)
Full path to gzip program - in case you can't set proper PATH environment
@@ -261,6 +263,55 @@ For details - please consult manual to your choosen compression tool.
B<It is strongly suggest to use only 1 compression method for all destinations>
+=head2 CHECKSUMMING
+
+OmniPITR can (since version 0.2.0) calculate checksums of created files.
+
+To calculate the checksums, OmniPITR uses Digest Perl module (part of standard
+Perl distribution).
+
+Digest module supports (now) 5 different types of checksums:
+
+=over
+
+=item * MD5 - standard md5 algorithm
+
+=item * SHA-1 - SHA-1 algorithm
+
+=item * SHA-256 - SHA-2 algorithm with hash size of 256 bits
+
+=item * SHA-384 - SHA-2 algorithm with hash size of 384 bits
+
+=item * SHA-512 - SHA-2 algorithm with hash size of 512 bits
+
+=back
+
+If you'll choose to use checksums, for every type of checksum (you can specify
+--digest=MD5,SHA-512) there will be one additional file created, named just like
+data and xlog tarbals, but with __FILETYPE__ part of filename (details in
+L<FILENAMES>) changed to digest name.
+
+So, with filename template being __FILETYPE__.tar__CEXT__, gzip compression and
+MD5 checksumming, you will get 3 files:
+
+=over
+
+=item * data.tar.gz
+
+=item * xlog.tar.gz
+
+=item * MD5.tar.gz
+
+=back
+
+It is important to understand that the checksum file is plain text, and the
+parts of its name that suggest tar.gz as just "leftovers" from filename
+template.
+
+After creation, such checksum file can be verified with:
+
+ md5sum -c MD5.tar.gz
+
=head2 FILENAMES
Naming of files for backups might be important depending on deployment.
@@ -119,6 +119,8 @@ Do not use nice for compressions.
Digest method to use (eg MD5 or SHA-1) for checksumming. Can be a comma
seperated list to use multiple digest algorithms.
+For details please check L<CHECKSUMMING> below.
+
=item --gzip-path (-gp)
Full path to gzip program - in case you can't set proper PATH environment
@@ -288,6 +290,55 @@ For details - please consult manual to your choosen compression tool.
B<It is strongly suggest to use only 1 compression method for all destinations>
+=head2 CHECKSUMMING
+
+OmniPITR can (since version 0.2.0) calculate checksums of created files.
+
+To calculate the checksums, OmniPITR uses Digest Perl module (part of standard
+Perl distribution).
+
+Digest module supports (now) 5 different types of checksums:
+
+=over
+
+=item * MD5 - standard md5 algorithm
+
+=item * SHA-1 - SHA-1 algorithm
+
+=item * SHA-256 - SHA-2 algorithm with hash size of 256 bits
+
+=item * SHA-384 - SHA-2 algorithm with hash size of 384 bits
+
+=item * SHA-512 - SHA-2 algorithm with hash size of 512 bits
+
+=back
+
+If you'll choose to use checksums, for every type of checksum (you can specify
+--digest=MD5,SHA-512) there will be one additional file created, named just like
+data and xlog tarbals, but with __FILETYPE__ part of filename (details in
+L<FILENAMES>) changed to digest name.
+
+So, with filename template being __FILETYPE__.tar__CEXT__, gzip compression and
+MD5 checksumming, you will get 3 files:
+
+=over
+
+=item * data.tar.gz
+
+=item * xlog.tar.gz
+
+=item * MD5.tar.gz
+
+=back
+
+It is important to understand that the checksum file is plain text, and the
+parts of its name that suggest tar.gz as just "leftovers" from filename
+template.
+
+After creation, such checksum file can be verified with:
+
+ md5sum -c MD5.tar.gz
+
=head2 FILENAMES
Naming of files for backups might be important depending on deployment.
View
@@ -9,7 +9,7 @@ use Data::Dumper;
use POSIX qw(strftime floor);
use IO::File;
-our $VERSION = '0.1.3';
+our $VERSION = '0.2.0';
BEGIN {
eval { use Time::HiRes qw( time ); };
View
@@ -11,7 +11,7 @@ use File::Path qw( mkpath rmtree );
use File::Spec;
use Carp;
-our $VERSION = '0.1.3';
+our $VERSION = '0.2.0';
=head1 new()
@@ -2,7 +2,7 @@ package OmniPITR::Program::Archive;
use strict;
use warnings;
-our $VERSION = '0.1.3';
+our $VERSION = '0.2.0';
use base qw( OmniPITR::Program );
use Carp;
@@ -2,7 +2,7 @@ package OmniPITR::Program::Backup;
use strict;
use warnings;
-our $VERSION = '0.1.3';
+our $VERSION = '0.2.0';
use base qw( OmniPITR::Program );
use File::Spec;
@@ -2,7 +2,7 @@ package OmniPITR::Program::Backup::Master;
use strict;
use warnings;
-our $VERSION = '0.1.3';
+our $VERSION = '0.2.0';
use base qw( OmniPITR::Program::Backup );
use Carp;
@@ -2,7 +2,7 @@ package OmniPITR::Program::Backup::Slave;
use strict;
use warnings;
-our $VERSION = '0.1.3';
+our $VERSION = '0.2.0';
use base qw( OmniPITR::Program::Backup );
use File::Spec;
@@ -2,6 +2,6 @@ package OmniPITR::Program::Monitor;
use strict;
use warnings;
-our $VERSION = '0.1.3';
+our $VERSION = '0.2.0';
1;
@@ -2,7 +2,7 @@ package OmniPITR::Program::Restore;
use strict;
use warnings;
-our $VERSION = '0.1.3';
+our $VERSION = '0.2.0';
use base qw( OmniPITR::Program );
use Carp;
View
@@ -7,7 +7,7 @@ use Digest::MD5;
use File::Temp qw( tempfile );
use base qw( Exporter );
-our $VERSION = '0.1.3';
+our $VERSION = '0.2.0';
our @EXPORT_OK = qw( file_md5sum run_command ext_for_compression );
our %EXPORT_TAGS = ( 'all' => \@EXPORT_OK );

0 comments on commit f209c32

Please sign in to comment.