extern/zrepl
1
0
Fork 0
mirror of https://github.com/zrepl/zrepl.git synced 2025-02-02 03:29:13 +01:00
Code Issues Actions Packages Projects Releases Wiki Activity

docs: add warnings of changing semantics for manually created snapshots in 0.1

Browse Source
This commit is contained in:
Christian Schwarz 2018-10-13 18:29:40 +02:00
parent eadb6f823d
commit f13749380d
2 changed files with 11 additions and 0 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

8
docs/changelog.rst
View File

@ -29,6 +29,14 @@ We use the following annotations for classifying changes:
This release is a milestone for zrepl and required significant refactoring if not rewrites of substantial parts of the application. This release is a milestone for zrepl and required significant refactoring if not rewrites of substantial parts of the application.
It breaks both configuration and transport format, and thus requires manual intervention and updates on both sides of a replication setup. It breaks both configuration and transport format, and thus requires manual intervention and updates on both sides of a replication setup.
.. DANGER::
The changes in the pruning system for this release require you to explicitly define **keep rules**:
for any snapshot that you want to keep, at least one rule must match.
This is different from previous releases where pruning only affected snapshots with the configured snapshotting prefix.
Make sure that snapshots to be kept or ignored by zrepl are covered, e.g. by using the ``regex`` keep rule.
:ref:`Learn more in the config docs... <prune>`
Notes to Package Maintainers Notes to Package Maintainers
~~~~~~~~~~~~~~~~~~~~~~~~~~~~ ~~~~~~~~~~~~~~~~~~~~~~~~~~~~

3
docs/configuration/prune.rst
View File

@ -45,6 +45,9 @@ Example Configuration:
regex: "^zrepl_.*" regex: "^zrepl_.*"
# manually created snapshots will be kept forever on receiver # manually created snapshots will be kept forever on receiver
.. DANGER::
You might have **existing snapshots** of filesystems affected by pruning which you want to keep, i.e. not be destroyed by zrepl.
Make sure to actually add the necessary ``regex`` keep rules on both sides, like with ``manual`` in the example above.
.. ATTENTION:: .. ATTENTION::