psw/borgmatic
1
0
Fork 0
Code Issues Pull requests Projects Releases Packages Wiki Activity Actions

Clarify database documentation about excluding named pipes and character/block devices to prevent hangs.

Browse source
This commit is contained in:
Dan Helfman 2020-07-13 10:45:58 -07:00
parent 6f82c9979b
commit 2ac58670d5
2 changed files with 14 additions and 0 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

2
NEWS
View file

@ -1,5 +1,7 @@
1.5.9.dev0 1.5.9.dev0
* #339: Fix for intermittent timing-related test failure of logging function. * #339: Fix for intermittent timing-related test failure of logging function.
* Clarify database documentation about excluding named pipes and character/block devices to prevent
hangs.
1.5.8 1.5.8
* #336: Fix for traceback when running Cronitor, Cronhub, and PagerDuty monitor hooks. * #336: Fix for traceback when running Cronitor, Cronhub, and PagerDuty monitor hooks.

12
docs/how-to/backup-your-databases.md
View file

@ -34,6 +34,7 @@ in the `location` section of borgmatic's configuration.
Also note that using a database hook implicitly enables both the Also note that using a database hook implicitly enables both the
`read_special` and `one_file_system` configuration settings (even if they're `read_special` and `one_file_system` configuration settings (even if they're
disabled in your configuration) to support this dump and restore streaming. disabled in your configuration) to support this dump and restore streaming.
See Limitations below for more on this.
Here's a more involved example that connects to remote databases: Here's a more involved example that connects to remote databases:
@ -167,6 +168,11 @@ borgmatic's own configuration file. So include your configuration file in
backups to avoid getting caught without a way to restore a database. backups to avoid getting caught without a way to restore a database.
3. borgmatic does not currently support backing up or restoring multiple 3. borgmatic does not currently support backing up or restoring multiple
databases that share the exact same name on different hosts. databases that share the exact same name on different hosts.
4. Because database hooks implicitly enable the `read_special` configuration
setting to support dump and restore streaming, you'll need to ensure that any
special files are excluded from backups (named pipes, block devices, and
character devices). Common directories to exclude are `/dev` and `/run`, but
that may not be exhaustive.
### Manual restoration ### Manual restoration
@ -205,6 +211,12 @@ hooks:
options: "--single-transaction --quick" options: "--single-transaction --quick"
``` ```
### borgmatic hangs during backup
See Limitations above about `read_special`. You may need to exclude certain
paths with named pipes, block devices, or character devices. Common
directories to exclude are `/dev` and `/run`, but that may not be exhaustive.
## Related documentation ## Related documentation