diff --git a/LICENSE b/LICENSE index ac0075d74..ffdbcdf45 100644 --- a/LICENSE +++ b/LICENSE @@ -1,6 +1,6 @@ The MIT License (MIT) -Copyright (c) 2013 David Steele +Copyright (c) 2013-2014 David Steele Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in diff --git a/README.md b/README.md index b25afb5d7..7bc3fb205 100644 --- a/README.md +++ b/README.md @@ -2,3 +2,24 @@ pg_backrest =========== Simple Postgres Backup and Restore + +release notes +============= + +v0.01: Backup and archiving are functional + +This version has been put into production at Resonate, so it does work, but there are a number of major caveats. + +* No restore functionality, but the backup directories are consistent Postgres data directories. You'll need to either uncompress the files or turn off compression in the backup. Uncompressed backups on a ZFS (or similar) filesystem are a good option because backups can be restored locally via a snapshot to create logical backups or do spot data recovery. + +* Archiving is single-threaded. This has not posed an issue on our multi-terabyte databases with heavy write volume. Recommend a large WAL volume or to use the async option with a large volume nearby. + +* Backups are multi-threaded, but the Net::OpenSSH library does not appear to be 100% threadsafe so it will very occasionally lock up on a thread. There is an overall process timeout that resolves this issue by killing the process. Yes, very ugly. + +* Checksums are lost on any resumed backup. Only the final backup will record checksum on multiple resumes. Checksums from previous backups are correctly recorded and a full backup will reset everything. + +* The backup.manifest is being written as Storable because Config::IniFile does not seem to handle large files well. Would definitely like to save these as human-readable text. + +* Absolutely no documentation (outside the code). Well, excepting these release notes. + +* Lots of other little things and not so little things. Much refactoring to follow. \ No newline at end of file