Skip to content

Commit

Permalink
Describe EXCLUDE_RECREATE in layout docs better
Browse files Browse the repository at this point in the history
Instead of copying a snippet of default.conf, describe in prose what the
variable does and what is the syntax.
  • Loading branch information
pcahyna committed Jan 9, 2024
1 parent ec47374 commit 36fae11
Showing 1 changed file with 15 additions and 7 deletions.
22 changes: 15 additions & 7 deletions doc/user-guide/06-layout-configuration.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -124,13 +124,21 @@ fs /dev/mapper/backup-backup /backup ext4 uuid=da20354a-dc4c-4bef-817c-1c92894bb
----------------------------------

=== Manual excludes
It seems prudent to prevent the external drives from ever being backed-up or overwritten. The default configuration contains these lines:
----------------------------------
# Exclude components during component recreation
# will be added to EXCLUDE_BACKUP (it is not backed up)
# recreation information gathered, but commented out
EXCLUDE_RECREATE=()
----------------------------------
It seems prudent to prevent the external drives from ever being backed-up or overwritten.
The most generic mechanism for doing this is the +EXCLUDE_RECREATE+
variable. It can contain a list of storage components that will be
excluded from the layout (will be present in the layout file, but
commented out) recursively together with their descendands (components
that depend on the excluded component, like a filesystem on the
underlying logical volume). Each component in the list corresponds to
a component in the layout file, but the syntax is different. To
specify a mounted filesystem, use the +fs:+ prefix:
+fs:+<mountpoint>. To specify swap, use the +swap:+ prefix. The syntax
to specify a volume group to exclude (together with all its logical
volumes and filesystems on them) is +/dev/+<volume group name>. Consult
the +/var/lib/rear/layout/disktodo.conf+ file created together with
the layout file for the full list of components in a compatible
syntax.

To prevent an inadvertently mounted backup filesystem being added to
the layout file and recreated, the easiest way is to add the filesystem to the +EXCLUDE_RECREATE+ array.
Expand Down

0 comments on commit 36fae11

Please sign in to comment.