diff --git a/INSTALL.md b/INSTALL.md deleted file mode 100644 index 60b6b71a2..000000000 --- a/INSTALL.md +++ /dev/null @@ -1,562 +0,0 @@ -# PgBackRest Installation - -## sample ubuntu 12.04 install - -1. Starting from a clean install, update the OS: - -``` -apt-get update -apt-get upgrade (reboot if required) -``` - -2. Install ssh, git and cpanminus - -``` -apt-get install ssh -apt-get install git -apt-get install cpanminus -``` - -3. Install Postgres (instructions from http://www.postgresql.org/download/linux/ubuntu/) - -Create the file /etc/apt/sources.list.d/pgdg.list, and add a line for the repository: -``` -deb http://apt.postgresql.org/pub/repos/apt/ precise-pgdg main -``` -Then run the following: -``` -wget --quiet -O - https://www.postgresql.org/media/keys/ACCC4CF8.asc | sudo apt-key add - -sudo apt-get update - -apt-get install postgresql-9.3 -apt-get install postgresql-server-dev-9.3 -``` - -4. Install required Perl modules: -``` -cpanm JSON -cpanm Net::OpenSSH -cpanm DBI -cpanm DBD::Pg -cpanm IPC::System::Simple -cpanm Digest::SHA -cpanm Compress::ZLib -``` -5. Install PgBackRest - -Backrest can be installed by downloading the most recent release: - -https://github.com/pgmasters/backrest/releases - -6. To run unit tests: - -* Create backrest_dev user -* Setup trusted ssh between test user account and backrest_dev -* Backrest user and test user must be in the same group - -## configuration examples - -PgBackRest takes some command-line parameters, but depends on a configuration file for most of the settings. The default location for the configuration file is /etc/pg_backrest.conf. - -#### confguring postgres for archiving with backrest - -Modify the following settings in postgresql.conf: -``` -wal_level = archive -archive_mode = on -archive_command = '/path/to/backrest/bin/pg_backrest.pl --stanza=db archive-push %p' -``` - -Replace the path with the actual location where PgBackRest was installed. The stanza parameter should be changed to the actual stanza name you used for your database in pg_backrest.conf. - -#### simple single host install - -This configuration is appropriate for a small installation where backups are being made locally or to a remote file system that is mounted locally. - -`/etc/pg_backrest.conf`: -``` -[global:command] -psql=/usr/bin/psql - -[global:backup] -path=/var/lib/postgresql/backup - -[global:retention] -full-retention=2 -differential-retention=2 -archive-retention-type=diff -archive-retention=2 - -[db] -path=/var/lib/postgresql/9.3/main -``` - -#### simple multiple host install - -This configuration is appropriate for a small installation where backups are being made remotely. Make sure that postgres@db-host has trusted ssh to backrest@backup-host and vice versa. This configuration assumes that you have pg_backrest_remote.pl and pg_backrest.pl in the same path on both servers. - -`/etc/pg_backrest.conf on the db host`: -``` -[global:command] -psql=/usr/bin/psql - -[global:backup] -host=backup-host@mydomain.com -user=postgres -path=/var/lib/postgresql/backup - -[db] -path=/var/lib/postgresql/9.3/main -``` -`/etc/pg_backrest.conf on the backup host`: -``` -[global:command] -psql=/usr/bin/psql - -[global:backup] -path=/var/lib/postgresql/backup - -[global:retention] -full-retention=2 -archive-retention-type=full - -[db] -host=db-host@mydomain.com -user=postgres -path=/var/lib/postgresql/9.3/main -``` - -## operations - -PgBackRest is intended to be run from a scheduler like cron as there is no built-in scheduler. - -### general options - -These options are either global or used by all operations. - -#### stanza - -Defines the stanza for the operation. A stanza is the configuration for a database that defines where it is located, how it will be backed up, archiving options, etc. Most db servers will only have one Postgres cluster and therefore one stanza, whereas backup servers will have a stanza for every database that needs to be backed up. - -Examples of how to configure a stanza can be found in the `configuration examples` section. - -#### config - -By default PgBackRest expects the its configuration file to be located at `/etc/pg_backrest.conf`. Use this option to specify another location. - -#### version - -Returns the PgBackRest version. - -#### help - -Prints help with a summary of all options. - -### backup - -Perform a database backup. - -#### options - -##### type - -The following backup types are supported: - -- `full` - all database files will be copied and there will be no dependencies on previous backups. -- `incr` - incremental from the last successful backup. -- `diff` - like an incremental backup but always based on the last full backup. - -##### no-start-stop - -This option prevents PgBackRest from running `pg_start_backup()` and `pg_stop_backup()` on the database. In order for this to work Postgres should be shut down and PgBackRest will generate an error if it is not. - -The purpose of this option is to allow cold backups. The `pg_xlog` directory is copied as-is and `backup::archive-required` is automatically set to `n` for the backup. - -##### force - -When used with `--no-start-stop` a backup will be run even if PgBackRest thinks that Postgres is running. **This option should be used with extreme care as it will likely result in a bad backup.** - -There are some scenarios where a backup might still be desirable under these conditions. For example, if a server crashes and database volume can only be mounted read-only, it would be a good idea to take a backup even if `postmaster.pid` is present. In this case it would be better to revert to the prior backup and replay WAL, but possibly there is a very important transaction in a WAL log that did not get archived. - -#### usage examples - -``` -/path/to/pg_backrest.pl --stanza=db --type=full backup -``` -Run a `full` backup on the `db` stanza. `--type` can also be set to `incr` or `diff` for incremental or differential backups. However, if no `full` backup exists then a `full` backup will be forced even if `incr` or `diff` is requested. - -### archive-push -``` -/path/to/pg_backrest.pl --stanza=db archive-push %p -``` -Accepts an archive file from Postgres and pushes it to the backup. `%p` is how Postgres specifies the location of the file to be archived. This command has no other purpose. - -### archive-get - -``` -/path/to/pg_backrest.pl --stanza=db archive-get %f %p -``` -Retrieves an archive log from the backup. This is used in `restore.conf` to restore a backup to that last archive log, do PITR, or as an alternative to streaming for keep a replica up to date. `%f` is how Postgres specifies the archive log it needs, and `%p` is the location where it should be copied. - -### expire - -PgBackRest does backup rotation, but it is not concerned with when the backups were created. So if two full backups are configured in rentention, PgBackRest will keep two full backup no matter whether they occur 2 hours apart or two weeks apart. - -``` -/path/to/pg_backrest.pl --stanza=db expire -``` -Expire (rotate) any backups that exceed the defined retention. Expiration is run automatically after every successful backup, so there's no need to run this command on its own unless you have reduced rentention, usually to free up some space. - -### restore - -Restore a database from the PgBackRest repository. - -#### restore options - -##### set - -The backup set to be restored. `latest` will restore the latest backup, otherwise provide the name of the backup to restore. For example: `20150131-153358F` or `20150131-153358F_20150131-153401I`. - -##### delta - -By default the database base and tablespace directories are expected to be present but empty. This option performs a delta restore using checksums. - -##### force - -By itself this option forces the database base and tablespace paths to be completely overwritten. In combination with `--delta` a timestamp/size delta will be performed instead of using checksums. - -#### recovery options - -##### type - -The following recovery types are supported: - -- `default` - recover to the end of the archive stream. -- `name` - recover the restore point specified in `--target`. -- `xid` - recover to the transaction id specified in `--target`. -- `time` - recover to the time specified in `--target`. -- `preserve` - preserve the existing `recovery.conf` file. -- `none` - no recovery past database becoming consistent. - -Note that the `none` option may produce duplicate WAL if the database is started with archive logging enabled. It is recommended that a new stanza be created for production databases restored in this way. - -##### target - -Defines the recovery target when `--type` is `name`, `xid`, or `time`. For example, `--type=time` and `--target=2015-01-30 14:15:11 EST`. - -##### target-exclusive - -Defines whether recovery to the target whould be exclusive (the default is inclusive) and is only valid when `--type` is `time` or `xid`. For example, using `--target-exclusive` would exclude the contents of transaction `1007` when `--type=xid` and `-target=1007`. See `recovery_target_inclusive` option in Postgres docs for more information. - -##### target-resume - -Specifies whether recovery should resume when the recovery target is reached. See `pause_at_recovery_target` in Postgres docs for more information. - -##### target-timeline - -Recovers along the specified timeline. See `recovery_target_timeline` in Postgres docs for more information. - -#### usage examples - -``` -/path/to/pg_backrest.pl --stanza=db --set=latest --type=name --target=release -``` -Restores the latest database backup and then recovers to the `release` restore point. - -**MORE TO BE ADDED HERE** - -PITR should start after the stop time in the .backup file. - -[reference this when writing about tablespace remapping] - -http://www.databasesoup.com/2013/11/moving-tablespaces.html - -## structure - -PgBackRest stores files in a way that is easy for users to work with directly. Each backup directory has one file and two subdirectories: - -* `backup.manifest` file - -Stores information about all the directories, links, and files in the backup. The file is plaintext and should be very clear, but documentation of the format is planned in a future release. - -* `base` directory - -Contains the Postgres data directory as defined by the data_directory setting in `postgresql.conf`. - -* `tablespace` directory - -If tablespaces are present in the database, contains each tablespace in a separate subdirectory. Tablespace names are used for the subdirectories unless --no-start-stop is specified in which case oids will be used instead. The links in `base/pg_tblspc` are rewritten to the tablespace directory in either case. - -## configuration options - -Each section defines important aspects of the backup. All configuration sections below should be prefixed with `global:` as demonstrated in the configuration samples. - -#### command section - -The command section defines external commands that are used by PgBackRest. - -##### psql key - -Defines the full path to psql. psql is used to call pg_start_backup() and pg_stop_backup(). -``` -required: y -example: psql=/usr/bin/psql -``` -##### remote key - -Defines the file path to pg_backrest_remote.pl. - -Required only if the path to pg_backrest_remote.pl is different on the local and remote systems. If not defined, the remote path will be assumed to be the same as the local path. -``` -required: n -example: remote=/home/postgres/backrest/bin/pg_backrest_remote.pl -``` -#### command-option section - -The command-option section allows abitrary options to be passed to any command in the command section. - -##### psql key - -Allows command line parameters to be passed to psql. -``` -required: no -example: psql=--port=5433 -``` - -#### log section - -The log section defines logging-related settings. The following log levels are supported: - -- `off `- No logging at all (not recommended) -- `error `- Log only errors -- `warn `- Log warnings and errors -- `info `- Log info, warnings, and errors -- `debug `- Log debug, info, warnings, and errors -- `trace `- Log trace (very verbose debugging), debug, info, warnings, and errors - -##### level-file - -Sets file log level. -``` -default: info -example: level-file=warn -``` -##### level-console - -Sets console log level. -``` -default: error -example: level-file=info -``` -#### general section - -The `general` section defines settings that are shared between multiple operations. - -##### buffer-size - -Set the buffer size used for copy, compress, and uncompress functions. A maximum of 3 buffers will be in use at a time per thread. An additional maximum of 256K per thread may be used for zlib buffers. - -``` -default: 1048576 -allowed: 4096 - 8388608 -example: buffer-size=8192 -``` -##### compress-level - -Sets the zlib level to be used for file compression when `compress=y`. - -This setting can be overridden in the `backup` and `archive` sections. - -``` -default: 6 -allowed: 0 - 9 -example: compress-level=9 -``` -##### compress-level-network - -Sets the zlib level to be used for protocol compression when `compress=n` and the database is not on the same host as the backup. Protocol compression is used to reduce network traffic but can be disabled by setting `compress-level-network=0`. When `compress=y` the `compress-level-network` setting is ignored and `compress-level` is used instead so that the file is only compressed once. SSH compression is always disabled. - -This setting can be overridden in the `backup` and `archive`, and `restore` sections. -``` -default: 3 -allowed: 0 - 9 -example: compress-level-network=1 -``` -#### backup section - -The backup section defines settings related to backup and archiving. - -##### host - -Sets the backup host. -``` -required: n (but must be set if user is defined) -example: host=backup.mydomain.com -``` -##### user - -Sets user account on the backup host. -``` -required: n (but must be set if host is defined) -example: user=backrest -``` -##### path - -Path where backups are stored on the local or remote host. -``` -required: y -example: path=/backup/backrest -``` -##### compress - -Enable gzip compression. Files stored in the backup are compatible with command-line gzip tools. -``` -default: y -example: compress=n -``` -##### start-fast - -Forces an immediate checkpoint (by passing true to the fast parameter of pg_start_backup()) so the backup begins immediately. -``` -default: n -example: start-fast=y -``` -##### hardlink - -Enable hard-linking of files in differential and incremental backups to their full backups. This gives the appearance that each -backup is a full backup. Be care though, because modifying files that are hard-linked can affect all the backups in the set. -``` -default: y -example: hardlink=n -``` -##### thread-max - -Defines the number of threads to use for backup. Each thread will perform compression and transfer to make the backup run faster, but don't set `thread-max` so high that it impacts database performance. -``` -default: 1 -example: thread-max=4 -``` -##### thread-timeout - -Maximum amount of time (in seconds) that a backup thread should run. This limits the amount of time that a thread might be stuck due to unforeseen issues during the backup. -``` -default: -example: thread-timeout=86400 -``` -##### archive-required - -Are archive logs required to to complete the backup? It's a good idea to leave this as the default unless you are using another -method for archiving. -``` -default: y -example: archive-required=n -``` -#### archive section - -The archive section defines parameters when doing async archiving. This means that the archive files will be stored locally, then a background process will pick them and move them to the backup. - -##### path - -Path where archive logs are stored before being asynchronously transferred to the backup. Make sure this is not the same path as the backup is using if the backup is local. -``` -required: y -example: path=/backup/archive -``` -##### compress-async - -When set then archive logs are not compressed immediately, but are instead compressed when copied to the backup host. This means that more space will be used on local storage, but the initial archive process will complete more quickly allowing greater throughput from Postgres. -``` -default: n -example: compress-async=y -``` -##### archive-max-mb - -Limits the amount of archive log that will be written locally. After the limit is reached, the following will happen: - -1. PgBackRest will notify Postgres that the archive was succesfully backed up, then DROP IT. -2. An error will be logged to the console and also to the Postgres log. -3. A stop file will be written in the lock directory and no more archive files will be backed up until it is removed. - -If this occurs then the archive log stream will be interrupted and PITR will not be possible past that point. A new backup will be required to regain full restore capability. - -The purpose of this feature is to prevent the log volume from filling up at which point Postgres will stop all operation. Better to lose the backup than have the database go down completely. - -To start normal archiving again you'll need to remove the stop file which will be located at `${archive-path}/lock/${stanza}-archive.stop` where `${archive-path}` is the path set in the archive section, and ${stanza} is the backup stanza. -``` -required: n -example: archive-max-mb=1024 -``` -#### retention section - -The rentention section defines how long backups will be retained. Expiration only occurs when the number of complete backups exceeds the allowed retention. In other words, if full-retention is set to 2, then there must be 3 complete backups before the oldest will be expired. Make sure you always have enough space for rentention + 1 backups. - -##### full-retention - -Number of full backups to keep. When a full backup expires, all differential and incremental backups associated with the full backup will also expire. When not defined then all full backups will be kept. -``` -required: n -example: full-retention=2 -``` -##### differential-retention - -Number of differential backups to keep. When a differential backup expires, all incremental backups associated with the differential backup will also expire. When not defined all differential backups will be kept. -``` -required: n -example: differential-retention=3 -``` -##### archive-retention-type - -Type of backup to use for archive retention (full or differential). If set to full, then PgBackRest will keep archive logs for the number of full backups defined by `archive-retention`. If set to differential, then PgBackRest will keep archive logs for the number of differential backups defined by `archive-retention`. - -If not defined then archive logs will be kept indefinitely. In general it is not useful to keep archive logs that are older than the oldest backup, but there may be reasons for doing so. -``` -required: n -example: archive-retention-type=full -``` -##### archive-retention - -Number of backups worth of archive log to keep. If not defined, then `full-retention` will be used when `archive-retention-type=full` and `differential-retention` will be used when `archive-retention-type=differential`. -``` -required: n -example: archive-retention=2 -``` - -### restore section - -????? - -### restore:option section - -`Archive Recovery` and `Standby Server` `restore.conf` options can be specified here. See http://www.postgresql.org/docs/X.X/static/recovery-config.html for details on `restore.conf` options (replace `X.X` with your database version). - -Note: `restore_command` will automatically be generated unless overridden in this section. Be careful about specifying your own `restore_command` as PgBackRest is designed to handle this for you. - -'Target Recovery` options are specified on the command-line since they end to change from restore to restore (or not be needed at all in the case of a standby server). - -Since PgBackRest does not start PostgreSQL after writing the recovery.conf file, it is always possible to edit/check the file before manually restarting. - -### stanza sections - -A stanza defines a backup for a specific database. The stanza section must define the base database path and host/user if the database is remote. Also, any global configuration sections can be overridden to define stanza-specific settings. - -##### host - -Sets the database host. -``` -required: n (but must be set if user is defined) -example: host=db.mydomain.com -``` -##### user - -Sets user account on the db host. -``` -required: n (but must be set if host is defined) -example: user=postgres -``` -##### path - -Path to the db data directory (data_directory setting in postgresql.conf). -``` -required: y -example: path=/var/postgresql/data -``` diff --git a/LICENSE b/LICENSE index ffdbcdf45..91ca7456a 100644 --- a/LICENSE +++ b/LICENSE @@ -1,6 +1,6 @@ The MIT License (MIT) -Copyright (c) 2013-2014 David Steele +Copyright (c) 2013-2015 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 2ba1d25a4..2a6cab158 100644 --- a/README.md +++ b/README.md @@ -2,111 +2,550 @@ PgBackRest aims to be a simple backup and restore system that can seamlessly scale up to the largest databases and workloads. -Instead of relying on traditional backup tools like tar and rsync, PgBackRest implements all backup features internally and features a custom protocol for communicating with remote systems. Removing reliance on tar and rsync allows better solutions to database-specific backup issues. The custom remote protocol limits the types of connections that are required to perform a backup which increases security. Each thread requires only one SSH connection for remote backups. - Primary PgBackRest features: -* Local or remote backup -* Multi-threaded backup/restore for performance -* Checksums -* Safe backups (checks that logs required for consistency are present before backup completes) -* Full, differential, and incremental backups -* Backup rotation (and minimum retention rules with optional separate retention for archive) -* In-stream compression/decompression -* Archiving and retrieval of logs for replicas/restores built in -* Async archiving for very busy systems (including space limits) -* Backup directories are consistent Postgres clusters (when hardlinks are on and compression is off) -* Tablespace support -* Restore delta option -* Restore using timestamp/size or checksum -* Restore remapping base/tablespaces +- Local or remote backup +- Multi-threaded backup/restore for performance +- Checksums +- Safe backups (checks that logs required for consistency are present before backup completes) +- Full, differential, and incremental backups +- Backup rotation (and minimum retention rules with optional separate retention for archive) +- In-stream compression/decompression +- Archiving and retrieval of logs for replicas/restores built in +- Async archiving for very busy systems (including space limits) +- Backup directories are consistent Postgres clusters (when hardlinks are on and compression is off) +- Tablespace support +- Restore delta option +- Restore using timestamp/size or checksum +- Restore remapping base/tablespaces -## release notes +Instead of relying on traditional backup tools like tar and rsync, PgBackRest implements all backup features internally and features a custom protocol for communicating with remote systems. Removing reliance on tar and rsync allows better solutions to database-specific backup issues. The custom remote protocol limits the types of connections that are required to perform a backup which increases security. Each thread requires only one SSH connection for remote backups. + +## Install + +!!! Perl-based blah, blah, blah + +### Ubuntu 12.04 + +* Starting from a clean install, update the OS: +``` +apt-get update +apt-get upgrade (reboot if required) +``` +* Install ssh, git and cpanminus: +``` +apt-get install ssh +apt-get install git +apt-get install cpanminus +``` +* Install Postgres (instructions from http://www.postgresql.org/download/linux/ubuntu/) + +Create the file /etc/apt/sources.list.d/pgdg.list, and add a line for the repository: +``` +deb http://apt.postgresql.org/pub/repos/apt/ precise-pgdg main +``` +* Then run the following: +``` +wget --quiet -O - https://www.postgresql.org/media/keys/ACCC4CF8.asc | sudo apt-key add - +sudo apt-get update + +apt-get install postgresql-9.3 +apt-get install postgresql-server-dev-9.3 +``` +* Install required Perl modules: +``` +cpanm JSON +cpanm Net::OpenSSH +cpanm DBI +cpanm DBD::Pg +cpanm IPC::System::Simple +cpanm Digest::SHA +cpanm Compress::ZLib +``` +* Install PgBackRest + +Backrest can be installed by downloading the most recent release: + +https://github.com/pgmasters/backrest/releases + +* To run unit tests: +``` +Create backrest_dev user +Setup trusted ssh between test user account and backrest_dev +Backrest user and test user must be in the same group +``` + +## Configuration + +PgBackRest takes some command-line parameters, but depends on a configuration file for most of the settings. The default location for the configuration file is `/etc/pg_backrest.conf`. + +### Examples + +#### Confguring Postgres for Archiving + +Modify the following settings in `postgresql.conf`: +``` +wal_level = archive +archive_mode = on +archive_command = '/path/to/backrest/bin/pg_backrest.pl --stanza=db archive-push %p' +``` +Replace the path with the actual location where PgBackRest was installed. The stanza parameter should be changed to the actual stanza name for your database in `pg_backrest.conf`. + + +#### Simple Single Host Install + +This configuration is appropriate for a small installation where backups are being made locally or to a remote file system that is mounted locally. + +`/etc/pg_backrest.conf`: +``` +[global:command] +psql=/usr/bin/psql + +[global:backup] +path=/var/lib/postgresql/backup + +[global:retention] +full-retention=2 +differential-retention=2 +archive-retention-type=diff +archive-retention=2 + +[db] +path=/var/lib/postgresql/9.3/main +``` + + +#### Simple Multiple Host Install + +This configuration is appropriate for a small installation where backups are being made remotely. Make sure that postgres@db-host has trusted ssh to backrest@backup-host and vice versa. This configuration assumes that you have pg_backrest_remote.pl and pg_backrest.pl in the same path on both servers. + +`/etc/pg_backrest.conf` on the db host: +``` +[global:command] +psql=/usr/bin/psql + +[global:backup] +host=backup-host@mydomain.com +user=postgres +path=/var/lib/postgresql/backup + +[db] +path=/var/lib/postgresql/9.3/main +``` +`/etc/pg_backrest.conf` on the backup host: +``` +[global:command] +psql=/usr/bin/psql + +[global:backup] +path=/var/lib/postgresql/backup + +[global:retention] +full-retention=2 +archive-retention-type=full + +[db] +host=db-host@mydomain.com +user=postgres +path=/var/lib/postgresql/9.3/main +``` + + +### Options + +#### `command` section + +The `command` section defines the location of external commands that are used by PgBackRest. + +##### `psql` key + +Defines the full path to `psql`. `psql` is used to call `pg_start_backup()` and `pg_stop_backup()`. + +If addtional parameters need to be passed to `psql` (such as `--port` or `--cluster`) then add `%option%` to the command line and use `command-option::psql` to set options. +``` +required: y +example: psql=/usr/bin/psql -X %option% +``` + +##### `remote` key + +Defines the location of `pg_backrest_remote.pl`. + +Required only if the path to `pg_backrest_remote.pl` is different on the local and remote systems. If not defined, the remote path will be assumed to be the same as the local path. +``` +required: n +default: same as local +example: remote=/usr/lib/backrest/bin/pg_backrest_remote.pl +``` + +#### `command-option` section + +The `command-option` section allows abitrary options to be passed to any command in the `command` section. + +##### `psql` key + +Allows command line parameters to be passed to `psql`. +``` +required: n +example: psql=--port=5433 +``` + +#### `log` section + +The `log` section defines logging-related settings. The following log levels are supported: + +- `off` - No logging at all (not recommended) +- `error` - Log only errors +- `warn` - Log warnings and errors +- `info` - Log info, warnings, and errors +- `debug` - Log debug, info, warnings, and errors +- `trace` - Log trace (very verbose debugging), debug, info, warnings, and errors + + +##### `level-file` key + +Sets file log level. +``` +required: n +default: info +example: level-file=debug +``` + +##### `level-console` key + +Sets console log level. +``` +required: n +default: warning +example: level-console=error +``` + +#### `general` section + +The `general` section defines settings that are shared between multiple operations. + +##### `buffer-size` key + +Set the buffer size used for copy, compress, and uncompress functions. A maximum of 3 buffers will be in use at a time per thread. An additional maximum of 256K per thread may be used for zlib buffers. +``` +required: n +default: 1048576 +allow: 4096 - 8388608 +example: buffer-size=16384 +``` + +##### `compress-level` key + +Sets the zlib level to be used for file compression when `compress=y`. +``` +required: n +default: 6 +allow: 0-9 +override: backup, archive +example: compress-level=9 +``` + +##### `compress-level-network` key + +Sets the zlib level to be used for protocol compression when `compress=n` and the database is not on the same host as the backup. Protocol compression is used to reduce network traffic but can be disabled by setting `compress-level-network=0`. When `compress=y` the `compress-level-network` setting is ignored and `compress-level` is used instead so that the file is only compressed once. SSH compression is always disabled. +``` +required: n +default: 3 +allow: 0-9 +override: backup, archive, restore +example: compress-level-network=1 +``` + +#### `backup` section + +The `backup` section defines settings related to backup. + +##### `host` key + +Sets the backup host when backup up remotely via SSH. Make sure that trusted SSH authentication is configured between the db host and the backup host. + +When backing up to a locally mounted network filesystem this setting is not required. +``` +required: n +example: host=backup.domain.com +``` + +##### `user` key + +Sets user account on the backup host. +``` +required: n +example: user=backrest +``` + +##### `path` key + +Path where backups are stored on the local or remote host. +``` +required: y +example: path=/var/lib/backrest +``` + +##### `compress` key + +Enable gzip compression. Backup files are compatible with command-line gzip tools. +``` +required: n +default: y +example: compress=n +``` + +##### `start-fast` key + +Forces a checkpoint (by passing `true` to the `fast` parameter of `pg_start_backup()`) so the backup begins immediately. +``` +required: n +default: n +example: start-fast=y +``` + +##### `hardlink` key + +Enable hard-linking of files in differential and incremental backups to their full backups. This gives the appearance that each backup is a full backup. Be care though, because modifying files that are hard-linked can affect all the backups in the set. +``` +required: n +default: n +example: hardlink=y +``` + +##### `thread-max` key + +Defines the number of threads to use for backup. Each thread will perform compression and transfer to make the backup run faster, but don't set `thread-max` so high that it impacts database performance. +``` +required: n +default: 1 +example: thread-max=4 +``` + +##### `thread-timeout` key + +Maximum amount of time (in seconds) that a backup thread should run. This limits the amount of time that a thread might be stuck due to unforeseen issues during the backup. Has no affect when `thread-max=1`. +``` +required: n +example: thread-timeout=3600 +``` + +##### `archive-required` key + +Are archive logs required to to complete the backup? It's a good idea to leave this as the default unless you are using another method for archiving. +``` +required: n +default: y +example: archive-required=n +``` + +#### `archive` section + +The `archive` section defines parameters when doing async archiving. This means that the archive files will be stored locally, then a background process will pick them and move them to the backup. + +##### `path` key + +Path where archive logs are stored before being asynchronously transferred to the backup. Make sure this is not the same path as the backup is using if the backup is local. +``` +required: n +example: path=/var/lib/backrest +``` + +##### `compress-async` key + +When set archive logs are not compressed immediately, but are instead compressed when copied to the backup host. This means that more space will be used on local storage, but the initial archive process will complete more quickly allowing greater throughput from Postgres. +``` +required: n +default: n +example: compress-async=y +``` + +##### `archive-max-mb` key + +Limits the amount of archive log that will be written locally when `compress-async=y`. After the limit is reached, the following will happen: + +- PgBackRest will notify Postgres that the archive was succesfully backed up, then DROP IT. +- An error will be logged to the console and also to the Postgres log. +- A stop file will be written in the lock directory and no more archive files will be backed up until it is removed. + +If this occurs then the archive log stream will be interrupted and PITR will not be possible past that point. A new backup will be required to regain full restore capability. + +The purpose of this feature is to prevent the log volume from filling up at which point Postgres will stop completely. Better to lose the backup than have the database go down. + +To start normal archiving again you'll need to remove the stop file which will be located at `${archive-path}/lock/${stanza}-archive.stop` where `${archive-path}` is the path set in the `archive` section, and `${stanza}` is the backup stanza. +``` +required: n +example: archive-max-mb=1024 +``` + +#### `retention` section + +The `rentention` section defines how long backups will be retained. Expiration only occurs when the number of complete backups exceeds the allowed retention. In other words, if full-retention is set to 2, then there must be 3 complete backups before the oldest will be expired. Make sure you always have enough space for rentention + 1 backups. + +##### `full-retention` key + +Number of full backups to keep. When a full backup expires, all differential and incremental backups associated with the full backup will also expire. When not defined then all full backups will be kept. +``` +required: n +example: full-retention=2 +``` + +##### `differential-retention` key + +Number of differential backups to keep. When a differential backup expires, all incremental backups associated with the differential backup will also expire. When not defined all differential backups will be kept. +``` +required: n +example: differential-retention=3 +``` + +##### `differential-retention` key + +Number of differential backups to keep. When a differential backup expires, all incremental backups associated with the differential backup will also expire. When not defined all differential backups will be kept. +``` +required: n +example: differential-retention=3 +``` + +##### `archive-retention-type` key + +Type of backup to use for archive retention (full or differential). If set to full, then PgBackRest will keep archive logs for the number of full backups defined by `archive-retention`. If set to differential, then PgBackRest will keep archive logs for the number of differential backups defined by `archive-retention`. + +If not defined then archive logs will be kept indefinitely. In general it is not useful to keep archive logs that are older than the oldest backup, but there may be reasons for doing so. +``` +required: n +example: archive-retention-type=full +``` + +##### `archive-retention` key + +Number of backups worth of archive log to keep. If not defined, then `full-retention` will be used when `archive-retention-type=full` and `differential-retention` will be used when `archive-retention-type=differential`. +``` +required: n +example: archive-retention=2 +``` + +#### `restore` section + +[Not much to put here, but think of something] + +#### `restore-option` section + +Archive Recovery and Standby Server restore.conf options can be specified here. See http://www.postgresql.org/docs/X.X/static/recovery-config.html for details on restore.conf options (replace X.X with your database version). + +Note: `restore_command` will automatically be generated unless overridden in this section. Be careful about specifying your own `restore_command` as PgBackRest is designed to handle this for you. + +Target Recovery options are specified on the command-line since they end to change from restore to restore (or not be needed at all in the case of a standby server). + +Since PgBackRest does not start PostgreSQL after writing the `recovery.conf` file, it is always possible to edit/check the file before manually restarting. + +#### `stanza` section + +A stanza defines a backup for a specific database. The stanza section must define the base database path and host/user if the database is remote. Also, any global configuration sections can be overridden to define stanza-specific settings. + +##### `host` key + +Define the database host. Used for backups where the database host is different from the backup host. +``` +required: n +example: host=db.domain.com +``` + +##### `user` key + +Defines user account on the db host when `stanza::host` is defined. +``` +required: n +example: user=postgres +``` + +##### `path` key + +Path to the db data directory (data_directory setting in postgresql.conf). +``` +required: y +example: path=/data/db +``` + +## Release Notes ### v0.50: [under development] -* Added restore functionality. +- Added restore functionality. -* De/compression is now performed without threads and checksum/size is calculated in stream. That means file checksums are no longer optional. +- De/compression is now performed without threads and checksum/size is calculated in stream. That means file checksums are no longer optional. -* Added option (--no-start-stop) to allow backups when Postgres is shut down. If postmaster.pid is present then --force is required to make the backup run (though if Postgres is running an inconsistent backup will likely be created). This option was added primarily for the purpose of unit testing, but there may be applications in the real world as well. +- Added option `--no-start-stop` to allow backups when Postgres is shut down. If `postmaster.pid` is present then `--force` is required to make the backup run (though if Postgres is running an inconsistent backup will likely be created). This option was added primarily for the purpose of unit testing, but there may be applications in the real world as well. -* Fixed broken checksums and now they work with normal and resumed backups. Finally realized that checksums and checksum deltas should be functionally separated and this simplied a number of things. Issue #28 has been created for checksum deltas. +- Fixed broken checksums and now they work with normal and resumed backups. Finally realized that checksums and checksum deltas should be functionally separated and this simplied a number of things. Issue #28 has been created for checksum deltas. -* Fixed an issue where a backup could be resumed from an aborted backup that didn't have the same type and prior backup. +- Fixed an issue where a backup could be resumed from an aborted backup that didn't have the same type and prior backup. -* Removed dependency on Moose. It wasn't being used extensively and makes for longer startup times. +- Removed dependency on Moose. It wasn't being used extensively and makes for longer startup times. -* Checksum for backup.manifest to detect corrupted/modified manifest. +- Checksum for backup.manifest to detect corrupted/modified manifest. -* Link (called latest) always points to the last backup. This has been added for convenience and to make restore simpler. +- Link `latest` always points to the last backup. This has been added for convenience and to make restore simpler. -* More comprehensive backup unit tests. +- More comprehensive backup unit tests. -### v0.30: core restructuring and unit tests +### v0.30: Core Restructuring and Unit Tests -* Complete rewrite of BackRest::File module to use a custom protocol for remote operations and Perl native GZIP and SHA operations. Compression is performed in threads rather than forked processes. +- Complete rewrite of BackRest::File module to use a custom protocol for remote operations and Perl native GZIP and SHA operations. Compression is performed in threads rather than forked processes. -* Fairly comprehensive unit tests for all the basic operations. More work to be done here for sure, but then there is always more work to be done on unit tests. +- Fairly comprehensive unit tests for all the basic operations. More work to be done here for sure, but then there is always more work to be done on unit tests. -* Removed dependency on Storable and replaced with a custom ini file implementation. +- Removed dependency on Storable and replaced with a custom ini file implementation. -* Added much needed documentation (see INSTALL.md). +- Added much needed documentation -* Numerous other changes that can only be identified with a diff. +- Numerous other changes that can only be identified with a diff. -### v0.19: improved error reporting/handling +### v0.19: Improved Error Reporting/Handling -* Working on improving error handling in the file object. This is not complete, but works well enough to find a few errors that have been causing us problems (notably, find is occasionally failing building the archive async manifest when system is under load). +- Working on improving error handling in the file object. This is not complete, but works well enough to find a few errors that have been causing us problems (notably, find is occasionally failing building the archive async manifest when system is under load). -* Found and squashed a nasty bug where file_copy was defaulted to ignore errors. There was also an issue in file_exists that was causing the test to fail when the file actually did exist. Together they could have resulted in a corrupt backup with no errors, though it is very unlikely. +- Found and squashed a nasty bug where `file_copy()` was defaulted to ignore errors. There was also an issue in file_exists that was causing the test to fail when the file actually did exist. Together they could have resulted in a corrupt backup with no errors, though it is very unlikely. -### v0.18: return soft error from archive-get when file is missing +### v0.18: Return Soft Error When Archive Missing -* The archive-get function returns a 1 when the archive file is missing to differentiate from hard errors (ssh connection failure, file copy error, etc.) This lets Postgres know that that the archive stream has terminated normally. However, this does not take into account possible holes in the archive stream. +- The `archive-get` operation returns a 1 when the archive file is missing to differentiate from hard errors (ssh connection failure, file copy error, etc.) This lets Postgres know that that the archive stream has terminated normally. However, this does not take into account possible holes in the archive stream. -### v0.17: warn when archive directories cannot be deleted +### v0.17: Warn When Archive Directories Cannot Be Deleted -* If an archive directory which should be empty could not be deleted backrest was throwing an error. There's a good fix for that coming, but for the time being it has been changed to a warning so processing can continue. This was impacting backups as sometimes the final archive file would not get pushed if the first archive file had been in a different directory (plus some bad luck). +- If an archive directory which should be empty could not be deleted backrest was throwing an error. There's a good fix for that coming, but for the time being it has been changed to a warning so processing can continue. This was impacting backups as sometimes the final archive file would not get pushed if the first archive file had been in a different directory (plus some bad luck). -### v0.16: RequestTTY=yes for SSH sessions +### v0.16: RequestTTY=yes for SSH Sessions -* Added RequestTTY=yes to ssh sesssions. Hoping this will prevent random lockups. +- Added `RequestTTY=yes` to ssh sesssions. Hoping this will prevent random lockups. -### v0.15: added archive-get +### v0.15: RequestTTY=yes for SSH Sessions -* Added archive-get functionality to aid in restores. +- Added archive-get functionality to aid in restores. -* Added option to force a checkpoint when starting the backup (start_fast=y). +- Added option to force a checkpoint when starting the backup `start-fast=y`. -### v0.11: minor fixes +### v0.11: Minor Fixes -Tweaking a few settings after running backups for about a month. +- Removed `master_stderr_discard` option on database SSH connections. There have been occasional lockups and they could be related to issues originally seen in the file code. -* Removed master_stderr_discard option on database SSH connections. There have been occasional lockups and they could be related to issues originally seen in the file code. +- Changed lock file conflicts on backup and expire commands to ERROR. They were set to DEBUG due to a copy-and-paste from the archive locks. -* Changed lock file conflicts on backup and expire commands to ERROR. They were set to DEBUG due to a copy-and-paste from the archive locks. +### v0.10: Backup and Archiving are Functional -### v0.10: backup and archiving are functional +- 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. -This version has been put into production at Resonate, so it does work, but there are a number of major caveats. +- 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. -* 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. +- 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. -* 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. +- 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. -* 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. +- 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. -* 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. +- Absolutely no documentation (outside the code). Well, excepting these release notes. -* 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. - -## recognition +## Recognition Primary recognition goes to Stephen Frost for all his valuable advice and criticism during the development of PgBackRest. It's a far better piece of software than it would have been without him. -Resonate (http://www.resonateinsights.com) also contributed to the development of PgBackRest and allowed me to install early (but well tested) versions as their primary Postgres backup solution. +Resonate (http://www.resonate.com/) also contributed to the development of PgBackRest and allowed me to install early (but well tested) versions as their primary Postgres backup solution. diff --git a/README.old.md b/README.old.md new file mode 100644 index 000000000..0c76e2aa8 --- /dev/null +++ b/README.old.md @@ -0,0 +1,216 @@ +# PgBackRest Installation + +## sample ubuntu 12.04 install + +1. Starting from a clean install, update the OS: + +``` +apt-get update +apt-get upgrade (reboot if required) +``` + +2. Install ssh, git and cpanminus + +``` +apt-get install ssh +apt-get install git +apt-get install cpanminus +``` + +3. Install Postgres (instructions from http://www.postgresql.org/download/linux/ubuntu/) + +Create the file /etc/apt/sources.list.d/pgdg.list, and add a line for the repository: +``` +deb http://apt.postgresql.org/pub/repos/apt/ precise-pgdg main +``` +Then run the following: +``` +wget --quiet -O - https://www.postgresql.org/media/keys/ACCC4CF8.asc | sudo apt-key add - +sudo apt-get update + +apt-get install postgresql-9.3 +apt-get install postgresql-server-dev-9.3 +``` + +4. Install required Perl modules: +``` +cpanm JSON +cpanm Net::OpenSSH +cpanm DBI +cpanm DBD::Pg +cpanm IPC::System::Simple +cpanm Digest::SHA +cpanm Compress::ZLib +``` +5. Install PgBackRest + +Backrest can be installed by downloading the most recent release: + +https://github.com/pgmasters/backrest/releases + +6. To run unit tests: + +* Create backrest_dev user +* Setup trusted ssh between test user account and backrest_dev +* Backrest user and test user must be in the same group + +## operations + +PgBackRest is intended to be run from a scheduler like cron as there is no built-in scheduler. + +### general options + +These options are either global or used by all operations. + +#### stanza + +Defines the stanza for the operation. A stanza is the configuration for a database that defines where it is located, how it will be backed up, archiving options, etc. Most db servers will only have one Postgres cluster and therefore one stanza, whereas backup servers will have a stanza for every database that needs to be backed up. + +Examples of how to configure a stanza can be found in the `configuration examples` section. + +#### config + +By default PgBackRest expects the its configuration file to be located at `/etc/pg_backrest.conf`. Use this option to specify another location. + +#### version + +Returns the PgBackRest version. + +#### help + +Prints help with a summary of all options. + +### backup + +Perform a database backup. + +#### options + +##### type + +The following backup types are supported: + +- `full` - all database files will be copied and there will be no dependencies on previous backups. +- `incr` - incremental from the last successful backup. +- `diff` - like an incremental backup but always based on the last full backup. + +##### no-start-stop + +This option prevents PgBackRest from running `pg_start_backup()` and `pg_stop_backup()` on the database. In order for this to work Postgres should be shut down and PgBackRest will generate an error if it is not. + +The purpose of this option is to allow cold backups. The `pg_xlog` directory is copied as-is and `backup::archive-required` is automatically set to `n` for the backup. + +##### force + +When used with `--no-start-stop` a backup will be run even if PgBackRest thinks that Postgres is running. **This option should be used with extreme care as it will likely result in a bad backup.** + +There are some scenarios where a backup might still be desirable under these conditions. For example, if a server crashes and database volume can only be mounted read-only, it would be a good idea to take a backup even if `postmaster.pid` is present. In this case it would be better to revert to the prior backup and replay WAL, but possibly there is a very important transaction in a WAL log that did not get archived. + +#### usage examples + +``` +/path/to/pg_backrest.pl --stanza=db --type=full backup +``` +Run a `full` backup on the `db` stanza. `--type` can also be set to `incr` or `diff` for incremental or differential backups. However, if no `full` backup exists then a `full` backup will be forced even if `incr` or `diff` is requested. + +### archive-push +``` +/path/to/pg_backrest.pl --stanza=db archive-push %p +``` +Accepts an archive file from Postgres and pushes it to the backup. `%p` is how Postgres specifies the location of the file to be archived. This command has no other purpose. + +### archive-get + +``` +/path/to/pg_backrest.pl --stanza=db archive-get %f %p +``` +Retrieves an archive log from the backup. This is used in `restore.conf` to restore a backup to that last archive log, do PITR, or as an alternative to streaming for keep a replica up to date. `%f` is how Postgres specifies the archive log it needs, and `%p` is the location where it should be copied. + +### expire + +PgBackRest does backup rotation, but it is not concerned with when the backups were created. So if two full backups are configured in rentention, PgBackRest will keep two full backup no matter whether they occur 2 hours apart or two weeks apart. + +``` +/path/to/pg_backrest.pl --stanza=db expire +``` +Expire (rotate) any backups that exceed the defined retention. Expiration is run automatically after every successful backup, so there's no need to run this command on its own unless you have reduced rentention, usually to free up some space. + +### restore + +Restore a database from the PgBackRest repository. + +#### restore options + +##### set + +The backup set to be restored. `latest` will restore the latest backup, otherwise provide the name of the backup to restore. For example: `20150131-153358F` or `20150131-153358F_20150131-153401I`. + +##### delta + +By default the database base and tablespace directories are expected to be present but empty. This option performs a delta restore using checksums. + +##### force + +By itself this option forces the database base and tablespace paths to be completely overwritten. In combination with `--delta` a timestamp/size delta will be performed instead of using checksums. + +#### recovery options + +##### type + +The following recovery types are supported: + +- `default` - recover to the end of the archive stream. +- `name` - recover the restore point specified in `--target`. +- `xid` - recover to the transaction id specified in `--target`. +- `time` - recover to the time specified in `--target`. +- `preserve` - preserve the existing `recovery.conf` file. +- `none` - no recovery past database becoming consistent. + +Note that the `none` option may produce duplicate WAL if the database is started with archive logging enabled. It is recommended that a new stanza be created for production databases restored in this way. + +##### target + +Defines the recovery target when `--type` is `name`, `xid`, or `time`. For example, `--type=time` and `--target=2015-01-30 14:15:11 EST`. + +##### target-exclusive + +Defines whether recovery to the target whould be exclusive (the default is inclusive) and is only valid when `--type` is `time` or `xid`. For example, using `--target-exclusive` would exclude the contents of transaction `1007` when `--type=xid` and `-target=1007`. See `recovery_target_inclusive` option in Postgres docs for more information. + +##### target-resume + +Specifies whether recovery should resume when the recovery target is reached. See `pause_at_recovery_target` in Postgres docs for more information. + +##### target-timeline + +Recovers along the specified timeline. See `recovery_target_timeline` in Postgres docs for more information. + +#### usage examples + +``` +/path/to/pg_backrest.pl --stanza=db --set=latest --type=name --target=release +``` +Restores the latest database backup and then recovers to the `release` restore point. + +**MORE TO BE ADDED HERE** + +PITR should start after the stop time in the .backup file. + +[reference this when writing about tablespace remapping] + +http://www.databasesoup.com/2013/11/moving-tablespaces.html + +## structure + +PgBackRest stores files in a way that is easy for users to work with directly. Each backup directory has one file and two subdirectories: + +* `backup.manifest` file + +Stores information about all the directories, links, and files in the backup. The file is plaintext and should be very clear, but documentation of the format is planned in a future release. + +* `base` directory + +Contains the Postgres data directory as defined by the data_directory setting in `postgresql.conf`. + +* `tablespace` directory + +If tablespaces are present in the database, contains each tablespace in a separate subdirectory. Tablespace names are used for the subdirectories unless --no-start-stop is specified in which case oids will be used instead. The links in `base/pg_tblspc` are rewritten to the tablespace directory in either case. diff --git a/doc/doc.dtd b/doc/doc.dtd new file mode 100644 index 000000000..115a9dbbf --- /dev/null +++ b/doc/doc.dtd @@ -0,0 +1,72 @@ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + diff --git a/doc/doc.pl b/doc/doc.pl new file mode 100755 index 000000000..fcd3302bd --- /dev/null +++ b/doc/doc.pl @@ -0,0 +1,734 @@ +#!/usr/bin/perl +#################################################################################################################################### +# pg_backrest.pl - Simple Postgres Backup and Restore +#################################################################################################################################### + +#################################################################################################################################### +# Perl includes +#################################################################################################################################### +use strict; +use warnings FATAL => qw(all); +use Carp qw(confess); + +use File::Basename qw(dirname); +use Pod::Usage qw(pod2usage); +use Getopt::Long qw(GetOptions); +use XML::Checker::Parser; + +use lib dirname($0) . '/../lib'; +use BackRest::Utility; + +#################################################################################################################################### +# Usage +#################################################################################################################################### + +=head1 NAME + +doc.pl - Generate PgBackRest documentation + +=head1 SYNOPSIS + +doc.pl [options] [operation] + + General Options: + --help display usage and exit + +=cut + +#################################################################################################################################### +# DOC_RENDER_TAG - render a tag to another markup language +#################################################################################################################################### +my $oRenderTag = +{ + 'markdown' => + { + 'b' => ['**', '**'], + 'i' => ['_', '_'], + 'bi' => ['_**', '**_'], + 'ul' => ["\n", ''], + 'ol' => ["\n", ''], + 'li' => ['- ', "\n"], + 'id' => ['`', '`'], + 'file' => ['`', '`'], + 'path' => ['`', '`'], + 'cmd' => ['`', '`'], + 'param' => ['`', '`'], + 'setting' => ['`', '`'], + 'code' => ['`', '`'], + 'code-block' => ['```', '```'], + 'backrest' => ['PgBackRest', ''], + }, + + 'html' => + { + 'b' => ['', ''] + } +}; + +sub doc_render_tag +{ + my $oTag = shift; + my $strType = shift; + + my $strBuffer = ""; + + my $strTag = $$oTag{name}; + my $strStart = $$oRenderTag{$strType}{$strTag}[0]; + my $strStop = $$oRenderTag{$strType}{$strTag}[1]; + + if (!defined($strStart) || !defined($strStop)) + { + confess "invalid type ${strType} or tag ${strTag}"; + } + + $strBuffer .= $strStart; + + if ($strTag eq 'li') + { + $strBuffer .= doc_render_text($oTag, $strType); + } + elsif (defined($$oTag{value})) + { + $strBuffer .= $$oTag{value}; + } + elsif (defined($$oTag{children}[0])) + { + foreach my $oSubTag (@{doc_list($oTag)}) + { + $strBuffer .= doc_render_tag($oSubTag, $strType); + } + + } + + $strBuffer .= $strStop; +} + +#################################################################################################################################### +# DOC_RENDER_TEXT - Render a text node +#################################################################################################################################### +sub doc_render_text +{ + my $oText = shift; + my $strType = shift; + + my $strBuffer = ""; + + if (defined($$oText{children})) + { + for (my $iIndex = 0; $iIndex < @{$$oText{children}}; $iIndex++) + { + if (ref(\$$oText{children}[$iIndex]) eq "SCALAR") + { + $strBuffer .= $$oText{children}[$iIndex]; + } + else + { + $strBuffer .= doc_render_tag($$oText{children}[$iIndex], $strType); + } + } + } + + return $strBuffer; +} + +#################################################################################################################################### +# DOC_GET - Get a node +#################################################################################################################################### +sub doc_get +{ + my $oDoc = shift; + my $strName = shift; + my $bRequired = shift; + + my $oNode; + + for (my $iIndex = 0; $iIndex < @{$$oDoc{children}}; $iIndex++) + { + if ($$oDoc{children}[$iIndex]{name} eq $strName) + { + if (!defined($oNode)) + { + $oNode = $$oDoc{children}[$iIndex]; + } + else + { + confess "found more than one child ${strName} in node $$oDoc{name}"; + } + } + } + + if (!defined($oNode) && (!defined($bRequired) || $bRequired)) + { + confess "unable to find child ${strName} in node $$oDoc{name}"; + } + + return $oNode; +} + +#################################################################################################################################### +# DOC_GET - Test if a node exists +#################################################################################################################################### +sub doc_exists +{ + my $oDoc = shift; + my $strName = shift; + + my $bExists = false; + + for (my $iIndex = 0; $iIndex < @{$$oDoc{children}}; $iIndex++) + { + if ($$oDoc{children}[$iIndex]{name} eq $strName) + { + return true; + } + } + + return false; +} + +#################################################################################################################################### +# DOC_LIST - Get a list of nodes +#################################################################################################################################### +sub doc_list +{ + my $oDoc = shift; + my $strName = shift; + my $bRequired = shift; + + my @oyNode; + + for (my $iIndex = 0; $iIndex < @{$$oDoc{children}}; $iIndex++) + { + if (!defined($strName) || $$oDoc{children}[$iIndex]{name} eq $strName) + { + push(@oyNode, $$oDoc{children}[$iIndex]); + } + } + + if (@oyNode == 0 && (!defined($bRequired) || $bRequired)) + { + confess "unable to find child ${strName} in node $$oDoc{name}"; + } + + return \@oyNode; +} + +#################################################################################################################################### +# DOC_VALUE - Get value from a node +#################################################################################################################################### +sub doc_value +{ + my $oNode = shift; + my $strDefault = shift; + + if (defined($oNode) && defined($$oNode{value})) + { + return $$oNode{value}; + } + + return $strDefault; +} + +#################################################################################################################################### +# DOC_PARSE - Parse the XML tree into something more usable +#################################################################################################################################### +sub doc_parse +{ + my $strName = shift; + my $oyNode = shift; + + my %oOut; + my $iIndex = 0; + my $bText = $strName eq 'text' || $strName eq 'li'; + + # Store the node name + $oOut{name} = $strName; + + if (keys($$oyNode[$iIndex])) + { + $oOut{param} = $$oyNode[$iIndex]; + } + + $iIndex++; + + # Look for strings and children + while (defined($$oyNode[$iIndex])) + { + # Process string data + if (ref(\$$oyNode[$iIndex]) eq 'SCALAR' && $$oyNode[$iIndex] eq '0') + { + $iIndex++; + my $strBuffer = $$oyNode[$iIndex++]; + + # Strip tabs, CRs, and LFs + $strBuffer =~ s/\t|\r//g; + + # If anything is left + if (length($strBuffer) > 0) + { + # If text node then create array entries for strings + if ($bText) + { + if (!defined($oOut{children})) + { + $oOut{children} = []; + } + + push($oOut{children}, $strBuffer); + } + # Don't allow strings mixed with children + elsif (length(trim($strBuffer)) > 0) + { + if (defined($oOut{children})) + { + confess "text mixed with children in node ${strName} (spaces count)"; + } + + if (defined($oOut{value})) + { + confess "value is already defined in node ${strName} - this shouldn't happen"; + } + + # Don't allow text mixed with + $oOut{value} = $strBuffer; + } + } + } + # Process a child + else + { + if (defined($oOut{value}) && $bText) + { + confess "text mixed with children in node ${strName} before child " . $$oyNode[$iIndex++] . " (spaces count)"; + } + + if (!defined($oOut{children})) + { + $oOut{children} = []; + } + + push($oOut{children}, doc_parse($$oyNode[$iIndex++], $$oyNode[$iIndex++])); + } + } + + return \%oOut; +} + +#################################################################################################################################### +# DOC_SAVE - save a doc +#################################################################################################################################### +sub doc_write +{ + my $strFileName = shift; + my $strBuffer = shift; + + # Open the file + my $hFile; + open($hFile, '>', $strFileName) + or confess &log(ERROR, "unable to open ${strFileName}"); + + # Write the buffer + my $iBufferOut = syswrite($hFile, $strBuffer); + + # Report any errors + if (!defined($iBufferOut) || $iBufferOut != length($strBuffer)) + { + confess "unable to write '${strBuffer}'" . (defined($!) ? ': ' . $! : ''); + } + + # Close the file + close($hFile); +} + +#################################################################################################################################### +# Load command line parameters and config +#################################################################################################################################### +my $bHelp = false; # Display usage +my $bVersion = false; # Display version +my $bQuiet = false; # Sets log level to ERROR +my $strLogLevel = 'info'; # Log level for tests + +GetOptions ('help' => \$bHelp, + 'version' => \$bVersion, + 'quiet' => \$bQuiet, + 'log-level=s' => \$strLogLevel) + or pod2usage(2); + +# Display version and exit if requested +if ($bHelp || $bVersion) +{ + print 'pg_backrest ' . version_get() . " documentation\n"; + + if ($bHelp) + { + print "\n"; + pod2usage(); + } + + exit 0; +} + +# Set console log level +if ($bQuiet) +{ + $strLogLevel = 'off'; +} + +log_level_set(undef, uc($strLogLevel)); + +#################################################################################################################################### +# Load the doc file +#################################################################################################################################### +# Initialize parser object and parse the file +my $oParser = XML::Checker::Parser->new(ErrorContext => 2, Style => 'Tree'); +my $strFile = dirname($0) . '/doc.xml'; +my $oTree; + +eval +{ + local $XML::Checker::FAIL = sub + { + my $iCode = shift; + + die XML::Checker::error_string($iCode, @_); + }; + + $oTree = $oParser->parsefile(dirname($0) . '/doc.xml'); +}; + +# Report any error that stopped parsing +if ($@) +{ + $@ =~ s/at \/.*?$//s; # remove module line number + die "malformed xml in '$strFile}':\n" . trim($@); +} + +#################################################################################################################################### +# Parse the doc +#################################################################################################################################### +# my %oDocOut; + +# Doc Build +#----------------------------------------------------------------------------------------------------------------------------------- +# $oDocOut{title} = $$oDocIn{param}{title}; +# $oDocOut{subtitle} = $$oDocIn{param}{subtitle}; +# $oDocOut{children} = []; + +# my $strReadMe = "# ${strTitle} - ${strSubTitle}"; + +# Intro Build +#----------------------------------------------------------------------------------------------------------------------------------- +# my $oIntroOut = {name => 'intro'}; +# +# $$oIntroOut{text} = doc_get(doc_get($oDocIn, $$oIntroOut{name}), 'text'); +# push($oDocOut{children}, $oIntroOut); + +# Config Build +#----------------------------------------------------------------------------------------------------------------------------------- +# my $oConfigOut = {name => 'config', children => []}; +# my $oConfig = doc_get($oDocIn, $$oConfigOut{name}); +# +# $$oConfigOut{title} = $$oConfig{param}{title}; +# $$oConfigOut{text} = doc_get($oConfig, 'text'); +# push($oDocOut{children}, $oConfigOut); +# +# # Config Example List +# my $oConfigExampleOut = {name => 'config-example-list', children => []}; +# my $oConfigExampleList = doc_get($oConfig, $$oConfigExampleOut{name}); +# +# $$oConfigExampleOut{title} = $$oConfigExampleList{param}{title}; +# $$oConfigExampleOut{text} = doc_get($oConfigExampleList, 'text', false); +# push($$oConfigExampleOut{children}, $oConfigExampleOut); + +# +# #$strReadMe .= "\n\n## " . $$oConfigExampleList{param}{title}; +# +# $oDocOut{config}{exampleListText} = doc_get($oConfigExampleList, 'text', false); +# my @oExampleList; +# +# # if (doc_exists($oConfigExampleList, 'text', false)) +# # { +# # $strReadMe .= "\n\n" . doc_render_text(doc_get($oConfigExampleList, 'text'), 'markdown'); +# # } +# +# foreach my $oConfigExample (@{doc_list($oConfigExampleList, 'config-example')}) +# { +# my %oExampleOut; +# +# $oExampleOut{title} = $$oConfigExample{param}{title}; +# $oExampleOut{text} = doc_get($oConfigExample, 'text', false); +# # $strReadMe .= "\n\n### " . $$oConfigExample{param}{title} . +# # "\n\n" . doc_render_text(doc_get($oConfigExample, 'text'), 'markdown'); +# +# push(@oExampleList, \%oExampleOut); +# } +# +# $oDocOut{config}{exampleList} = \@oExampleList; + +# # Config Section List +# my $oConfigSectionList = doc_get($oConfig, 'config-section-list'); +# +# $strReadMe .= "\n\n## " . $$oConfigSectionList{param}{title}; +# +# if (doc_exists($oConfigSectionList, 'text', false)) +# { +# $strReadMe .= "\n\n" . doc_render_text(doc_get($oConfigSectionList, 'text'), 'markdown'); +# } +# +# foreach my $oConfigSection (@{doc_list($oConfigSectionList, 'config-section')}) +# { +# my $strConfigSectionId = $$oConfigSection{param}{id}; +# +# $strReadMe .= "\n\n#### `" . $strConfigSectionId . "` section" . +# "\n\n" . doc_render_text(doc_get($oConfigSection, 'text'), 'markdown'); +# +# foreach my $oConfigKey (@{doc_list($oConfigSection, 'config-key', false)}) +# { +# my $strConfigKeyId = $$oConfigKey{param}{id}; +# my $strError = "config section ${strConfigSectionId}, key ${strConfigKeyId} requires"; +# +# my $bRequired = doc_exists($oConfigKey, 'required'); +# my $strDefault = !$bRequired ? doc_value(doc_get($oConfigKey, 'default', false)) : undef; +# my $strAllow = doc_value(doc_get($oConfigKey, 'allow', false)); +# my $strOverride = doc_value(doc_get($oConfigKey, 'override', false)); +# my $strExample = doc_value(doc_get($oConfigKey, 'example', false)); +# +# defined($strExample) or die "${strError} example"; +# +# $strReadMe .= "\n\n##### `" . $strConfigKeyId . "` key" . +# "\n\n" . doc_render_text(doc_get($oConfigKey, 'text'), 'markdown') . +# "\n```\n" . +# "required: " . ($bRequired ? 'y' : 'n') . "\n" . +# (defined($strDefault) ? "default: ${strDefault}\n" : '') . +# (defined($strAllow) ? "allow: ${strAllow}\n" : '') . +# (defined($strOverride) ? "override: ${strOverride}\n" : '') . +# "example: ${strConfigKeyId}=${strExample}\n" . +# "```"; +# } +# } + +# Release Build +#----------------------------------------------------------------------------------------------------------------------------------- +# my $oReleaseOut = {name => 'release'}; +# my $oRelease = doc_get($oDocIn, 'release'); +# +# $$oReleaseOut{title} = $$oRelease{param}{title}; +# $$oReleaseOut{text} = doc_get($oRelease, 'text', false); +# $$oReleaseOut{children} = []; +# +# my $oReleaseList = doc_get($oRelease, 'release-list'); +# +# foreach my $oReleaseVersion (@{doc_list($oReleaseList, 'release-version')}) +# { +# my %oVersionOut; +# my @oFeatureList; +# +# $oVersionOut{version} = $$oReleaseVersion{param}{version}; +# $oVersionOut{title} = $$oReleaseVersion{param}{title}; +# $oVersionOut{text} = doc_get($oReleaseVersion, 'text', false); +# $oVersionOut{list} = true; +# $oVersionOut{children} = []; +# +# foreach my $oReleaseFeature (@{doc_list($oReleaseVersion, 'release-feature')}) +# { +# my %oFeatureOut; +# $oFeatureOut{text} = doc_get($oReleaseFeature, 'text'); +# push ($oVersionOut{children}, \%oFeatureOut); +# } +# +# push($$oReleaseOut{children}, \%oVersionOut); +# } +# +# push($oDocOut{children}, $oReleaseOut); + +# Recognition Build +#----------------------------------------------------------------------------------------------------------------------------------- +# my $oRecognitionOut = {name => 'recognition'}; +# my $oRecognition = doc_get($oDocIn, $$oRecognitionOut{name}); +# +# $$oRecognitionOut{title} = $$oRecognition{param}{title}; +# $$oRecognitionOut{text} = doc_get($oRecognition, 'text'); +# push($oDocOut{children}, $oRecognitionOut); + +# Build +#----------------------------------------------------------------------------------------------------------------------------------- +my $oDocIn = doc_parse(${$oTree}[0], ${$oTree}[1]); + +sub doc_build +{ + my $oDoc = shift; + + # Initialize the node object + my $oOut = {name => $$oDoc{name}, children => []}; + my $strError = "in node $$oDoc{name}"; + + # Get all params + if (defined($$oDoc{param})) + { + for my $strParam (keys $$oDoc{param}) + { + $$oOut{param}{$strParam} = $$oDoc{param}{$strParam}; + } + } + + if (defined($$oDoc{children})) + { + for (my $iIndex = 0; $iIndex < @{$$oDoc{children}}; $iIndex++) + { + my $oSub = $$oDoc{children}[$iIndex]; + my $strName = $$oSub{name}; + + if ($strName eq 'text') + { + $$oOut{field}{text} = $oSub; + } + elsif (defined($$oSub{value})) + { + $$oOut{field}{$strName} = $$oSub{value}; + } + elsif (!defined($$oSub{children})) + { + $$oOut{field}{$strName} = true; + } + else + { + push($$oOut{children}, doc_build($oSub)); + } + } + } + + return $oOut; +} + +my $oDocOut = doc_build($oDocIn); + +# Render +#----------------------------------------------------------------------------------------------------------------------------------- +sub doc_render +{ + my $oDoc = shift; + my $strType = shift; + my $iDepth = shift; + my $bChildList = shift; + + my $strBuffer = ""; + my $bList = $$oDoc{name} =~ /.*-bullet-list$/; + $bChildList = defined($bChildList) ? $bChildList : false; + my $iChildDepth = $iDepth; + + if ($strType eq 'markdown') + { + if (defined($$oDoc{param}{id})) + { + my @stryToken = split('-', $$oDoc{name}); + my $strTitle = @stryToken == 0 ? '[unknown]' : $stryToken[@stryToken - 1]; + + $strBuffer = ('#' x $iDepth) . " `$$oDoc{param}{id}` " . $strTitle; + } + + if (defined($$oDoc{param}{title})) + { + $strBuffer = ('#' x $iDepth) . ' '; + + if (defined($$oDoc{param}{version})) + { + $strBuffer .= "v$$oDoc{param}{version}: "; + } + + $strBuffer .= $$oDoc{param}{title}; + } + + if (defined($$oDoc{param}{subtitle})) + { + if (!defined($$oDoc{param}{subtitle})) + { + confess "subtitle not valid without title"; + } + + $strBuffer .= " - " . $$oDoc{param}{subtitle}; + } + + if ($strBuffer ne "") + { + $iChildDepth++; + } + + if (defined($$oDoc{field}{text})) + { + if ($strBuffer ne "") + { + $strBuffer .= "\n\n"; + } + + if ($bChildList) + { + $strBuffer .= '- '; + } + + $strBuffer .= doc_render_text($$oDoc{field}{text}, $strType); + } + + if ($$oDoc{name} eq 'config-key') + { + my $strError = "config section ?, key $$oDoc{param}{id} requires"; + + my $bRequired = defined($$oDoc{field}{required}); + my $strDefault = !$bRequired ? $$oDoc{field}{default} : undef; + my $strAllow = $$oDoc{field}{allow}; + my $strOverride = $$oDoc{field}{override}; + my $strExample = $$oDoc{field}{example}; + + defined($strExample) or die "${strError} example"; + + $strBuffer .= "\n```\n" . + "required: " . ($bRequired ? 'y' : 'n') . "\n" . + (defined($strDefault) ? "default: ${strDefault}\n" : '') . + (defined($strAllow) ? "allow: ${strAllow}\n" : '') . + (defined($strOverride) ? "override: ${strOverride}\n" : '') . + "example: $$oDoc{param}{id}=${strExample}\n" . + "```"; + } + + if ($strBuffer ne "" && $iDepth != 1 && !$bList) + { + $strBuffer = "\n\n" . $strBuffer; + } + } + else + { + confess "unknown type ${strType}"; + } + + my $bFirst = true; + + foreach my $oChild (@{$$oDoc{children}}) + { + if ($strType eq 'markdown') + { + } + else + { + confess "unknown type ${strType}"; + } + + $strBuffer .= doc_render($oChild, $strType, $iChildDepth, $bList); + + } + + if ($iDepth == 1) + { + if ($strType eq 'markdown') + { + $strBuffer .= "\n"; + } + else + { + confess "unknown type ${strType}"; + } + } + + return $strBuffer; +} + +# Write markdown +doc_write(dirname($0) . '/../README.md', doc_render($oDocOut, 'markdown', 1)); diff --git a/doc/doc.xml b/doc/doc.xml new file mode 100644 index 000000000..d031e7b29 --- /dev/null +++ b/doc/doc.xml @@ -0,0 +1,613 @@ + + + + + aims to be a simple backup and restore system that can seamlessly scale up to the largest databases and workloads. + + Primary features: +
    +
  • Local or remote backup
    • +
  • Multi-threaded backup/restore for performance
    • +
  • Checksums
    • +
  • Safe backups (checks that logs required for consistency are present before backup completes)
    • +
  • Full, differential, and incremental backups
    • +
  • Backup rotation (and minimum retention rules with optional separate retention for archive)
    • +
  • In-stream compression/decompression
    • +
  • Archiving and retrieval of logs for replicas/restores built in
    • +
  • Async archiving for very busy systems (including space limits)
    • +
  • Backup directories are consistent Postgres clusters (when hardlinks are on and compression is off)
    • +
  • Tablespace support
    • +
  • Restore delta option
    • +
  • Restore using timestamp/size or checksum
    • +
  • Restore remapping base/tablespaces
    • +
+ Instead of relying on traditional backup tools like tar and rsync, implements all backup features internally and features a custom protocol for communicating with remote systems. Removing reliance on tar and rsync allows better solutions to database-specific backup issues. The custom remote protocol limits the types of connections that are required to perform a backup which increases security. Each thread requires only one SSH connection for remote backups. + + + + !!! Perl-based blah, blah, blah + + + + * Starting from a clean install, update the OS: + + apt-get update + apt-get upgrade (reboot if required) + + * Install ssh, git and cpanminus: + + apt-get install ssh + apt-get install git + apt-get install cpanminus + + * Install Postgres (instructions from http://www.postgresql.org/download/linux/ubuntu/) + + Create the file /etc/apt/sources.list.d/pgdg.list, and add a line for the repository: + + deb http://apt.postgresql.org/pub/repos/apt/ precise-pgdg main + + * Then run the following: + + wget --quiet -O - https://www.postgresql.org/media/keys/ACCC4CF8.asc | sudo apt-key add - + sudo apt-get update + + apt-get install postgresql-9.3 + apt-get install postgresql-server-dev-9.3 + + * Install required Perl modules: + + cpanm JSON + cpanm Net::OpenSSH + cpanm DBI + cpanm DBD::Pg + cpanm IPC::System::Simple + cpanm Digest::SHA + cpanm Compress::ZLib + + * Install PgBackRest + + Backrest can be installed by downloading the most recent release: + + https://github.com/pgmasters/backrest/releases + + * To run unit tests: + + Create backrest_dev user + Setup trusted ssh between test user account and backrest_dev + Backrest user and test user must be in the same group + + + + + + + takes some command-line parameters, but depends on a configuration file for most of the settings. The default location for the configuration file is /etc/pg_backrest.conf. + + + + Modify the following settings in postgresql.conf: + + wal_level = archive + archive_mode = on + archive_command = '/path/to/backrest/bin/pg_backrest.pl --stanza=db archive-push %p' + + Replace the path with the actual location where was installed. The stanza parameter should be changed to the actual stanza name for your database in pg_backrest.conf. + + + + + This configuration is appropriate for a small installation where backups are being made locally or to a remote file system that is mounted locally. + + /etc/pg_backrest.conf: + + [global:command] + psql=/usr/bin/psql + + [global:backup] + path=/var/lib/postgresql/backup + + [global:retention] + full-retention=2 + differential-retention=2 + archive-retention-type=diff + archive-retention=2 + + [db] + path=/var/lib/postgresql/9.3/main + + + + + + This configuration is appropriate for a small installation where backups are being made remotely. Make sure that postgres@db-host has trusted ssh to backrest@backup-host and vice versa. This configuration assumes that you have pg_backrest_remote.pl and pg_backrest.pl in the same path on both servers. + + /etc/pg_backrest.conf on the db host: + + [global:command] + psql=/usr/bin/psql + + [global:backup] + host=backup-host@mydomain.com + user=postgres + path=/var/lib/postgresql/backup + + [db] + path=/var/lib/postgresql/9.3/main + + /etc/pg_backrest.conf on the backup host: + + [global:command] + psql=/usr/bin/psql + + [global:backup] + path=/var/lib/postgresql/backup + + [global:retention] + full-retention=2 + archive-retention-type=full + + [db] + host=db-host@mydomain.com + user=postgres + path=/var/lib/postgresql/9.3/main + + + + + + + + The command section defines the location of external commands that are used by . + + + + Defines the full path to psql. psql is used to call pg_start_backup() and pg_stop_backup(). + + If addtional parameters need to be passed to psql (such as --port or --cluster) then add %option% to the command line and use command-option::psql to set options. + + + /usr/bin/psql -X %option% + + + + Defines the location of pg_backrest_remote.pl. + + Required only if the path to pg_backrest_remote.pl is different on the local and remote systems. If not defined, the remote path will be assumed to be the same as the local path. + + same as local + /usr/lib/backrest/bin/pg_backrest_remote.pl + + + + + + + The command-option section allows abitrary options to be passed to any command in the command section. + + + + + Allows command line parameters to be passed to psql. + + --port=5433 + + + + + + + The log section defines logging-related settings. The following log levels are supported: +
    +
  • off - No logging at all (not recommended)
    • +
  • error - Log only errors
    • +
  • warn - Log warnings and errors
    • +
  • info - Log info, warnings, and errors
    • +
  • debug - Log debug, info, warnings, and errors
    • +
  • trace - Log trace (very verbose debugging), debug, info, warnings, and errors
    • +
+ + + + + Sets file log level. + + info + debug + + + + + Sets console log level. + + warning + error + + + + + + + The general section defines settings that are shared between multiple operations. + + + + + Set the buffer size used for copy, compress, and uncompress functions. A maximum of 3 buffers will be in use at a time per thread. An additional maximum of 256K per thread may be used for zlib buffers. + + 1048576 + 4096 - 8388608 + 16384 + + + + + Sets the zlib level to be used for file compression when compress=y. + + 6 + 0-9 + backup, archive + 9 + + + + + Sets the zlib level to be used for protocol compression when compress=n and the database is not on the same host as the backup. Protocol compression is used to reduce network traffic but can be disabled by setting compress-level-network=0. When compress=y the compress-level-network setting is ignored and compress-level is used instead so that the file is only compressed once. SSH compression is always disabled. + + 3 + 0-9 + backup, archive, restore + 1 + + + + + + + The backup section defines settings related to backup. + + + + + Sets the backup host when backup up remotely via SSH. Make sure that trusted SSH authentication is configured between the db host and the backup host. + + When backing up to a locally mounted network filesystem this setting is not required. + + backup.domain.com + + + + + Sets user account on the backup host. + + backrest + + + + + Path where backups are stored on the local or remote host. + + + /var/lib/backrest + + + + + Enable gzip compression. Backup files are compatible with command-line gzip tools. + + y + n + + + + + Forces a checkpoint (by passing true to the fast parameter of pg_start_backup()) so the backup begins immediately. + + n + y + + + + + Enable hard-linking of files in differential and incremental backups to their full backups. This gives the appearance that each backup is a full backup. Be care though, because modifying files that are hard-linked can affect all the backups in the set. + + n + y + + + + + Defines the number of threads to use for backup. Each thread will perform compression and transfer to make the backup run faster, but don't set thread-max so high that it impacts database performance. + + 1 + 4 + + + + + Maximum amount of time (in seconds) that a backup thread should run. This limits the amount of time that a thread might be stuck due to unforeseen issues during the backup. Has no affect when thread-max=1. + + 3600 + + + + + Are archive logs required to to complete the backup? It's a good idea to leave this as the default unless you are using another method for archiving. + + y + n + + + + + + + The archive section defines parameters when doing async archiving. This means that the archive files will be stored locally, then a background process will pick them and move them to the backup. + + + + + Path where archive logs are stored before being asynchronously transferred to the backup. Make sure this is not the same path as the backup is using if the backup is local. + + /var/lib/backrest + + + + + When set archive logs are not compressed immediately, but are instead compressed when copied to the backup host. This means that more space will be used on local storage, but the initial archive process will complete more quickly allowing greater throughput from Postgres. + + n + y + + + + + Limits the amount of archive log that will be written locally when compress-async=y. After the limit is reached, the following will happen: +
    +
  1. PgBackRest will notify Postgres that the archive was succesfully backed up, then DROP IT.
    2. +
  2. An error will be logged to the console and also to the Postgres log.
    3. +
  3. A stop file will be written in the lock directory and no more archive files will be backed up until it is removed.
    4. +
+ If this occurs then the archive log stream will be interrupted and PITR will not be possible past that point. A new backup will be required to regain full restore capability. + + The purpose of this feature is to prevent the log volume from filling up at which point Postgres will stop completely. Better to lose the backup than have the database go down. + + To start normal archiving again you'll need to remove the stop file which will be located at ${archive-path}/lock/${stanza}-archive.stop where ${archive-path} is the path set in the archive section, and ${stanza} is the backup stanza. + + 1024 + + + + + + + The rentention section defines how long backups will be retained. Expiration only occurs when the number of complete backups exceeds the allowed retention. In other words, if full-retention is set to 2, then there must be 3 complete backups before the oldest will be expired. Make sure you always have enough space for rentention + 1 backups. + + + + + Number of full backups to keep. When a full backup expires, all differential and incremental backups associated with the full backup will also expire. When not defined then all full backups will be kept. + + 2 + + + + + Number of differential backups to keep. When a differential backup expires, all incremental backups associated with the differential backup will also expire. When not defined all differential backups will be kept. + + 3 + + + + + Number of differential backups to keep. When a differential backup expires, all incremental backups associated with the differential backup will also expire. When not defined all differential backups will be kept. + + 3 + + + + + Type of backup to use for archive retention (full or differential). If set to full, then PgBackRest will keep archive logs for the number of full backups defined by archive-retention. If set to differential, then PgBackRest will keep archive logs for the number of differential backups defined by archive-retention. + + If not defined then archive logs will be kept indefinitely. In general it is not useful to keep archive logs that are older than the oldest backup, but there may be reasons for doing so. + + full + + + + + Number of backups worth of archive log to keep. If not defined, then full-retention will be used when archive-retention-type=full and differential-retention will be used when archive-retention-type=differential. + + 2 + + + + + + + [Not much to put here, but think of something] + + + + + Archive Recovery and Standby Server restore.conf options can be specified here. See http://www.postgresql.org/docs/X.X/static/recovery-config.html for details on restore.conf options (replace X.X with your database version). + +Note: restore_command will automatically be generated unless overridden in this section. Be careful about specifying your own restore_command as PgBackRest is designed to handle this for you. + +Target Recovery options are specified on the command-line since they end to change from restore to restore (or not be needed at all in the case of a standby server). + +Since does not start PostgreSQL after writing the recovery.conf file, it is always possible to edit/check the file before manually restarting. + + + + + A stanza defines a backup for a specific database. The stanza section must define the base database path and host/user if the database is remote. Also, any global configuration sections can be overridden to define stanza-specific settings. + + + + + Define the database host. Used for backups where the database host is different from the backup host. + + db.domain.com + + + + + Defines user account on the db host when stanza::host is defined. + + postgres + + + + + Path to the db data directory (data_directory setting in postgresql.conf). + + + /data/db + + + + + + + + + + + + Added restore functionality. + + + De/compression is now performed without threads and checksum/size is calculated in stream. That means file checksums are no longer optional. + + + Added option --no-start-stop to allow backups when Postgres is shut down. If postmaster.pid is present then --force is required to make the backup run (though if Postgres is running an inconsistent backup will likely be created). This option was added primarily for the purpose of unit testing, but there may be applications in the real world as well. + + + Fixed broken checksums and now they work with normal and resumed backups. Finally realized that checksums and checksum deltas should be functionally separated and this simplied a number of things. Issue #28 has been created for checksum deltas. + + + Fixed an issue where a backup could be resumed from an aborted backup that didn't have the same type and prior backup. + + + Removed dependency on Moose. It wasn't being used extensively and makes for longer startup times. + + + Checksum for backup.manifest to detect corrupted/modified manifest. + + + Link latest always points to the last backup. This has been added for convenience and to make restore simpler. + + + More comprehensive backup unit tests. + + + + + + + + Complete rewrite of BackRest::File module to use a custom protocol for remote operations and Perl native GZIP and SHA operations. Compression is performed in threads rather than forked processes. + + + Fairly comprehensive unit tests for all the basic operations. More work to be done here for sure, but then there is always more work to be done on unit tests. + + + Removed dependency on Storable and replaced with a custom ini file implementation. + + + Added much needed documentation + + + Numerous other changes that can only be identified with a diff. + + + + + + + + Working on improving error handling in the file object. This is not complete, but works well enough to find a few errors that have been causing us problems (notably, find is occasionally failing building the archive async manifest when system is under load). + + + Found and squashed a nasty bug where file_copy() was defaulted to ignore errors. There was also an issue in file_exists that was causing the test to fail when the file actually did exist. Together they could have resulted in a corrupt backup with no errors, though it is very unlikely. + + + + + + + + The archive-get operation returns a 1 when the archive file is missing to differentiate from hard errors (ssh connection failure, file copy error, etc.) This lets Postgres know that that the archive stream has terminated normally. However, this does not take into account possible holes in the archive stream. + + + + + + + + If an archive directory which should be empty could not be deleted backrest was throwing an error. There's a good fix for that coming, but for the time being it has been changed to a warning so processing can continue. This was impacting backups as sometimes the final archive file would not get pushed if the first archive file had been in a different directory (plus some bad luck). + + + + + + + + Added RequestTTY=yes to ssh sesssions. Hoping this will prevent random lockups. + + + + + + + + Added archive-get functionality to aid in restores. + + + Added option to force a checkpoint when starting the backup start-fast=y. + + + + + + + + Removed master_stderr_discard option on database SSH connections. There have been occasional lockups and they could be related to issues originally seen in the file code. + + + Changed lock file conflicts on backup and expire commands to ERROR. They were set to DEBUG due to a copy-and-paste from the archive locks. + + + + + + + + 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. + + + + + + + + Primary recognition goes to Stephen Frost for all his valuable advice and criticism during the development of . It's a far better piece of software than it would have been without him. + + Resonate (http://www.resonate.com/) also contributed to the development of PgBackRest and allowed me to install early (but well tested) versions as their primary Postgres backup solution. + + diff --git a/doc/default.css b/doc/html/default.css similarity index 99% rename from doc/default.css rename to doc/html/default.css index 41f8f567b..90a0af567 100644 --- a/doc/default.css +++ b/doc/html/default.css @@ -36,7 +36,7 @@ a:link color: black; } -a:visited +a:visited { text-decoration: none; color: black; diff --git a/doc/index.html b/doc/index.html deleted file mode 100644 index d61c6a3a8..000000000 --- a/doc/index.html +++ /dev/null @@ -1,407 +0,0 @@ - - - PgBackRest - Simple Postgres Backup & Restore - - - - - - -
-
PgBackRest
-
Simple Postgres Backup & Restore
-
- - -
-
[Install]
-
[Configure]
-
- - - - Some intro text here. - - - - - Install - - Something.

- - - - - Configure - - PgBackRest takes some command-line parameters, but depends on a configuration file for most of the settings. The default location for the configuration file is /etc/pg_backrest.conf. - - - - command section - - The command section defines the location external commands that are used by PgBackRest. - - - - psql key - - Defines the full path to psql. psql is used to call pg_start_backup() and pg_stop_backup(). - - - required: y
- example: psql=/usr/bin/psql - - - - - - remote key - - Defines the file path to pg_backrest_remote.pl. - - Required only if the path to pg_backrest_remote.pl is different on the local and remote systems. If not defined, the remote path will be assumed to be the same as the local path. - - - required: n
- example: remote=/home/postgres/backrest/bin/pg_backrest_remote.pl - - - - - - - command-option section - - The command-option section allows abitrary options to be passed to any command in the command section. - - - - psql key - - Allows command line parameters to be passed to psql. - - - required: no
- example: psql=--port=5433 - - - - - - - log section - - The log section defines logging-related settings. The following log levels are supported:
- -
    -
  • off - No logging at all (not recommended)
    • -
  • error - Log only errors
    • -
  • warn - Log warnings and errors
    • -
  • info - Log info, warnings, and errors
    • -
  • debug - Log debug, info, warnings, and errors
    • -
  • trace - Log trace (very verbose debugging), debug, info, warnings, and errors
    • -
- - - - level-file key - - Sets file log level. - - - default: info
- example: level-file=debug - - - - - - level-console key - - Sets console log level. - - - default: warn
- example: level-console=info - - - - - - - general section - - The general section defines settings that are shared between multiple operations. - - - - buffer-size key - - Set the buffer size used for copy, compress, and uncompress functions. A maximum of 3 buffers will be in use at a time per thread. An additional maximum of 256K per thread may be used for zlib buffers. - - - default:1048576 - allowed:4096 - 8388608 - example:buffer-size=8192 - - - - - - compress-level key - - Sets the zlib level to be used for file compression when `compress=y`. - - - default:6 - allowed:0-9 - override:backup, archive - example:compress-level=9 - - - - - - compress-level-network key - - Sets the zlib level to be used for protocol compression when compress=n and the database is not on the same host as the backup. Protocol compression is used to reduce network traffic but can be disabled by setting compress-level-network=0. When compress=y the compress-level-network setting is ignored and compress-level is used instead so that the file is only compressed once. SSH compression is always disabled. - - - default:6 - allowed:0-9 - override:backup, archive - example:compress-level=9 - - - - - - - backup section - - The backup section defines settings related to backup. - - - - host key - -

Sets the backup host when backup up remotely via SSH. Make sure that trusted SSH authentication is configured between the db host and the backup host.

-

When backing up to a locally mounted network filesystem this setting is not required.

- - - required:n - example:host=backup.mydomain.com - - - - - - user key - -

Sets user account on the backup host.

- - - required:n (but must be set if host is defined) - example:user=backrest - - - - - - path key - -

Path where backups are stored on the local or remote host.

- - - required:y - example:path=/var/lib/backrest - - - - - - compress key - -

Enable gzip compression. Backup files are compatible with command-line gzip tools.

- - - default:y - example:compress=n - - - - - - start-fast key - -

Forces a checkpoint (by passing true to the fast parameter of pg_start_backup()) so the backup begins immediately.

- - - default:n - example:start-fast=y - - - - - - hardlink key - -

Enable hard-linking of files in differential and incremental backups to their full backups. This gives the appearance that each backup is a full backup. Be care though, because modifying files that are hard-linked can affect all the backups in the set.

- - - default:n - example:hardlink=y - - - - - - thread-max key - -

Defines the number of threads to use for backup. Each thread will perform compression and transfer to make the backup run faster, but don't set thread-max so high that it impacts database performance.

- - - default:1 - example:thread-max=4 - - - - - - thread-timeout key - -

Maximum amount of time (in seconds) that a backup thread should run. This limits the amount of time that a thread might be stuck due to unforeseen issues during the backup. Not valid when thread-max=1.

- - - required:n - example:thread-timeout=3600 - - - - - - archive-required key - -

Are archive logs required to to complete the backup? It's a good idea to leave this as the default unless you are using another method for archiving.

- - - default:y - example:archive-required=n - - - - - - - archive section - -

The archive section defines parameters when doing async archiving. This means that the archive files will be stored locally, then a background process will pick them and move them to the backup.

- - - - path key - -

Path where archive logs are stored before being asynchronously transferred to the backup. Make sure this is not the same path as the backup is using if the backup is local.

- - - required:y - example:/var/lib/backest - - - - - - compress-async key - -

When set archive logs are not compressed immediately, but are instead compressed when copied to the backup host. This means that more space will be used on local storage, but the initial archive process will complete more quickly allowing greater throughput from Postgres.

- - - default:n - example:compress-async=y - - - - - - archive-max-mb key - -

Limits the amount of archive log that will be written locally when compress-async=y. After the limit is reached, the following will happen:

-
    -
  1. PgBackRest will notify Postgres that the archive was succesfully backed up, then DROP IT.
    2. -
  2. An error will be logged to the console and also to the Postgres log.
    3. -
  3. A stop file will be written in the lock directory and no more archive files will be backed up until it is removed.
    4. -
- -

If this occurs then the archive log stream will be interrupted and PITR will not be possible past that point. A new backup will be required to regain full restore capability.

- -

The purpose of this feature is to prevent the log volume from filling up at which point Postgres will stop completely. Better to lose the backup than have the database go down.

- -

To start normal archiving again you'll need to remove the stop file which will be located at ${archive-path}/lock/${stanza}-archive.stop where ${archive-path} is the path set in the archive section, and ${stanza} is the backup stanza.

- - - required:n - example:archive-max-mb=1024 - - - - - - - archive section - -

The rentention section defines how long backups will be retained. Expiration only occurs when the number of complete backups exceeds the allowed retention. In other words, if full-retention is set to 2, then there must be 3 complete backups before the oldest will be expired. Make sure you always have enough space for rentention + 1 backups.

- - - - full-retention key - -

Number of full backups to keep. When a full backup expires, all differential and incremental backups associated with the full backup will also expire. When not defined then all full backups will be kept.

- - - required:n - example:full-retention=2 - - - - - - differential-retention key - -

Number of differential backups to keep. When a differential backup expires, all incremental backups associated with the differential backup will also expire. When not defined all differential backups will be kept.

- - - required:n - example:differential-retention=3 - - - - - - archive-retention-type key - -

Type of backup to use for archive retention (full or differential). If set to full, then PgBackRest will keep archive logs for the number of full backups defined by archive-retention. If set to differential, then PgBackRest will keep archive logs for the number of differential backups defined by archive-retention.

- -

If not defined then archive logs will be kept indefinitely. In general it is not useful to keep archive logs that are older than the oldest backup, but there may be reasons for doing so.

- - - required:n - example:archive-retention-type=full - - - - - - archive-retention key - -

Number of backups worth of archive log to keep. If not defined, then full-retention will be used when archive-retention-type=full and differential-retention will be used when archive-retention-type=differential.

- - - required:n - example:archive-retention=2 - - - - - - \ No newline at end of file diff --git a/test/lib/BackRestTest/BackupTest.pm b/test/lib/BackRestTest/BackupTest.pm index aca69c088..7794613e3 100755 --- a/test/lib/BackRestTest/BackupTest.pm +++ b/test/lib/BackRestTest/BackupTest.pm @@ -1964,7 +1964,7 @@ sub BackRestTestBackup_Test # Static backup parameters my $bSynthetic = false; - my $fTestDelay = 1; + my $fTestDelay = .1; # Variable backup parameters my $bDelta = true;