summaryrefslogtreecommitdiffstats
diff options
context:
space:
mode:
authorzDEFz <a-development@posteo.de>2023-11-13 13:45:19 +0100
committerGitHub <noreply@github.com>2023-11-13 13:45:19 +0100
commit6bbd327dc2cee184cd05bcfef41a50585229c764 (patch)
tree98754de57f7d5df073910bd69cc181d82986cc1b
parent8ebeb3ccc7412acd157262ecd35ea223ea2af999 (diff)
Added backup by serial method documentation (#7932)
docs: create disk/partition sector backup by disk serial number
-rw-r--r--docs/deployment/image-backup.rst37
1 files changed, 36 insertions, 1 deletions
diff --git a/docs/deployment/image-backup.rst b/docs/deployment/image-backup.rst
index e0cbae29d..5e09fdf5f 100644
--- a/docs/deployment/image-backup.rst
+++ b/docs/deployment/image-backup.rst
@@ -8,6 +8,41 @@ Backing up disk images can still be efficient with Borg because its `deduplicati
technique makes sure only the modified parts of the file are stored. Borg also has
optional simple sparse file support for extract.
+It is of utmost importancy to pin down the disk you want to backup.
+You need to use the SERIAL for that.
+Use:
+
+.. code-block:: bash
+
+ # You can find the short disk serial by:
+ # udevadm info --query=property --name=nvme1n1 | grep ID_SERIAL_SHORT | cut -d '=' -f 2
+
+ DISK_SERIAL="7VS0224F"
+ DISK_ID=$(readlink -f /dev/disk/by-id/*"${DISK_SERIAL}") # Returns /dev/nvme1n1
+
+ mapfile -t PARTITIONS < <(lsblk -o NAME,TYPE -p -n -l "$DISK_ID" | awk '$2 == "part" {print $1}')
+ echo "Partitions of $DISK_ID:"
+ echo "${PARTITIONS[@]}"
+ echo "Disk Identifier: $DISK_ID"
+
+ # Use the following line to perform a borg backup for the full disk:
+ # borg create --read-special /path/to/repo::{now} "$DISK_ID"
+
+ # Use the following to perform a borg backup for all partitions of the disk
+ # borg create --read-special /path/to/repo::{now} "${PARTITIONS[@]}"
+
+ # Example output:
+ # Partitions of /dev/nvme1n1:
+ # /dev/nvme1n1p1
+ # /dev/nvme1n1p2
+ # /dev/nvme1n1p3
+ # Disk Identifier: /dev/nvme1n1
+ # borg create --read-special /path/to/repo::{now} /dev/nvme1n1
+ # borg create --read-special /path/to/repo::{now} /dev/nvme1n1p1 /dev/nvme1n1p2 /dev/nvme1n1p3
+
+
+
+
Decreasing the size of image backups
------------------------------------
@@ -116,4 +151,4 @@ way to create application-consistent backups.
Borg doesn't intend to address these issues due to their huge complexity and
platform/software dependency. Combining Borg with the mechanisms provided by the platform
-(snapshots, hypervisor features) will be the best approach to start tackling them. \ No newline at end of file
+(snapshots, hypervisor features) will be the best approach to start tackling them.