From dd673bf923e71756781a464c5c23e0deb7bd6d36 Mon Sep 17 00:00:00 2001 From: Christian Schwarz Date: Sun, 17 Mar 2019 21:29:09 +0100 Subject: [PATCH] docs: condense snap job overview table row --- docs/configuration/jobs.rst | 34 ++++++++++++++++------------------ docs/configuration/prune.rst | 1 + 2 files changed, 17 insertions(+), 18 deletions(-) diff --git a/docs/configuration/jobs.rst b/docs/configuration/jobs.rst index 4e63fac..63fccb7 100644 --- a/docs/configuration/jobs.rst +++ b/docs/configuration/jobs.rst @@ -23,24 +23,22 @@ For communication, the active side connects to the passive side using a :ref:`tr The following table shows how different job types can be combined to achieve both push and pull mode setups: -+-----------------------+--------------+----------------------------------+-----------------------------------------------+ -| Setup name | active side | passive side | use case | -+=======================+==============+==================================+===============================================+ -| Push mode | ``push`` | ``sink`` | * Laptop backup | -| | | | * NAS behind NAT to offsite | -+-----------------------+--------------+----------------------------------+-----------------------------------------------+ -| Pull mode | ``pull`` | ``source`` | * Central backup-server for many nodes | -| | | | * Remote server to NAS behind NAT | -+-----------------------+--------------+----------------------------------+-----------------------------------------------+ -| Local replication | | ``push`` + ``sink`` in one config | * Backup FreeBSD boot pool | -| | | with :ref:`local transport ` | | -+-----------------------+--------------+----------------------------------+-----------------------------------------------+ -| SnapJob | ``snap`` | N/A | * Data requires versioning but no backups | -| | | | * Combined with a ``push`` or ``pull`` job: | -| | | | | -| | | | * High frequency local snapshotting | -| | | | * Low frequency replication | -+-----------------------+--------------+----------------------------------+-----------------------------------------------+ ++-----------------------+--------------+----------------------------------+------------------------------------------------------------------------------------+ +| Setup name | active side | passive side | use case | ++=======================+==============+==================================+====================================================================================+ +| Push mode | ``push`` | ``sink`` | * Laptop backup | +| | | | * NAS behind NAT to offsite | ++-----------------------+--------------+----------------------------------+------------------------------------------------------------------------------------+ +| Pull mode | ``pull`` | ``source`` | * Central backup-server for many nodes | +| | | | * Remote server to NAS behind NAT | ++-----------------------+--------------+----------------------------------+------------------------------------------------------------------------------------+ +| Local replication | | ``push`` + ``sink`` in one config | * Backup FreeBSD boot pool | +| | | with :ref:`local transport ` | | ++-----------------------+--------------+----------------------------------+------------------------------------------------------------------------------------+ +| Snap & prune-only | ``snap`` | N/A | * | Snapshots & pruning but no replication | +| | | | | required | +| | | | * Workaround for :ref:`source-side pruning ` | ++-----------------------+--------------+----------------------------------+------------------------------------------------------------------------------------+ How the Active Side Works ~~~~~~~~~~~~~~~~~~~~~~~~~ diff --git a/docs/configuration/prune.rst b/docs/configuration/prune.rst index a725f91..d6ab343 100644 --- a/docs/configuration/prune.rst +++ b/docs/configuration/prune.rst @@ -158,6 +158,7 @@ Policy ``regex`` Like all other regular expression fields in prune policies, zrepl uses Go's `regexp.Regexp `_ Perl-compatible regular expressions (`Syntax `_). The optional `negate` boolean field inverts the semantics: Use it if you want to keep all snapshots that *do not* match the given regex. +.. _prune-workaround-source-side-pruning: Source-side snapshot pruning ----------------------------