From 2ac58670d548d5f1120e8ca3b2f08eeeb373ab39 Mon Sep 17 00:00:00 2001 From: Dan Helfman Date: Mon, 13 Jul 2020 10:45:58 -0700 Subject: [PATCH] Clarify database documentation about excluding named pipes and character/block devices to prevent hangs. --- NEWS | 2 ++ docs/how-to/backup-your-databases.md | 12 ++++++++++++ 2 files changed, 14 insertions(+) diff --git a/NEWS b/NEWS index 71abecc22..5342b5277 100644 --- a/NEWS +++ b/NEWS @@ -1,5 +1,7 @@ 1.5.9.dev0 * #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 * #336: Fix for traceback when running Cronitor, Cronhub, and PagerDuty monitor hooks. diff --git a/docs/how-to/backup-your-databases.md b/docs/how-to/backup-your-databases.md index 0c660157b..e73a276ce 100644 --- a/docs/how-to/backup-your-databases.md +++ b/docs/how-to/backup-your-databases.md @@ -34,6 +34,7 @@ in the `location` section of borgmatic's configuration. Also note that using a database hook implicitly enables both the `read_special` and `one_file_system` configuration settings (even if they're 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: @@ -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. 3. borgmatic does not currently support backing up or restoring multiple 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 @@ -205,6 +211,12 @@ hooks: 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