From 7d10a71cc0e80be813aeeea79525440ead744fd7 Mon Sep 17 00:00:00 2001 From: Christian Schwarz Date: Sat, 18 Dec 2021 17:19:59 +0100 Subject: [PATCH] 0.5 changelog + front page update --- docs/changelog.rst | 57 +++++++++++++++++++++++++++------------------- docs/index.rst | 5 ++-- docs/usage.rst | 2 ++ 3 files changed, 39 insertions(+), 25 deletions(-) diff --git a/docs/changelog.rst b/docs/changelog.rst index 4fbdd42..001cfb3 100644 --- a/docs/changelog.rst +++ b/docs/changelog.rst @@ -16,26 +16,44 @@ Changelog The changelog summarizes bugfixes that are deemed relevant for users and package maintainers. Developers should consult the git commit log or GitHub issue tracker. -We use the following annotations for classifying changes: - -* |break_config| Change that breaks the config. - As a package maintainer, make sure to warn your users about config breakage somehow. -* |break| Change that breaks interoperability or persistent state representation with previous releases. - As a package maintainer, make sure to warn your users about config breakage somehow. - Note that even updating the package on both sides might not be sufficient, e.g. if persistent state needs to be migrated to a new format. -* |mig| Migration that must be run by the user. -* |feature| Change that introduces new functionality. -* |bugfix| Change that fixes a bug, no regressions or incompatibilities expected. -* |docs| Change to the documentation. -* |maint| Maintenance changes. - 0.5 --- -* |break_config| |bugfix| Rename mis-spelled :ref:`send option ` ``embbeded_data`` to ``embedded_data``. +* |feature| :ref:`Bandwidth limiting ` (Thanks, Prominic.NET, Inc.) +* |feature| zrepl status: use a ``*`` to indicate which filesystem is currently replicating +* |feature| include daemon environment variables in zrepl status (currently only in ``--raw``) +* |bugfix| **fix encrypt-on-receive + placeholders use case** (:issue:`504`) + + * Before this fix, **plain sends** to a receiver with an encrypted ``root_fs`` **could be received unencrypted** if zrepl needed to create placeholders on the receiver. + * Existing zrepl users should :ref:`read the docs ` and check ``zfs get -r encryption,zrepl:placeholder PATH_TO_ROOTFS`` on the receiver. + * Thanks to `@mologie `_ and `@razielgn `_ for reporting and testing! + +* |bugfix| Rename mis-spelled :ref:`send option ` ``embbeded_data`` to ``embedded_data``. +* |bugfix| zrepl status: replication step numbers should start at 1 +* |bugfix| incorrect bandwidth averaging in ``zrepl status``. +* |bugfix| FreeBSD with OpenZFS 2.0: zrepl would wait indefinitely for zfs send to exit on timeouts. +* |bugfix| fix ``strconv.ParseInt: value out of range`` bug (and use the control RPCs). +* |docs| improve description of multiple pruning rules. +* |docs| document :ref:`platform tests `. +* |docs| quickstart: make users aware that prune rules apply to all snapshots. +* |maint| some platformtests were broken. +* |maint| FreeBSD: release armv7 and arm64 binaries. +* |maint| apt repo: update instructions due to ``apt-key`` deprecation. + +Note to all users: please read up on the following OpenZFS bugs, as you might be affected: + +* `ZFS send/recv with ashift 9->12 leads to data corruption `_. +* Various bugs with encrypted send/recv (`Leadership meeting notes `_) + +Finally, I'd like to point you to the `GitHub discussion `_ about which bugfixes and features should be prioritized in zrepl 0.6 and beyond! + +.. NOTE:: + | zrepl is a spare-time project primarily developed by `Christian Schwarz `_. + | You can support maintenance and feature development through one of the following services: + | |Donate via Patreon| |Donate via GitHub Sponsors| |Donate via Liberapay| |Donate via PayPal| + | Note that PayPal processing fees are relatively high for small donations. + | For SEPA wire transfer and **commercial support**, please `contact Christian directly `_. -Note to all users: please read up on the following OpenZFS bug, as you might be affected: -`ZFS send/recv with ashift 9->12 leads to data corruption `_. 0.4.0 ----- @@ -61,13 +79,6 @@ The following bugfix in 0.3.1 :issue:`caused problems for some users <400>`: * |bugfix| pruning: ``grid``: add all snapshots that do not match the regex to the rule's destroy list. -.. NOTE:: - | zrepl is a spare-time project primarily developed by `Christian Schwarz `_. - | You can support maintenance and feature development through one of the following services: - | |Donate via Patreon| |Donate via GitHub Sponsors| |Donate via Liberapay| |Donate via PayPal| - | Note that PayPal processing fees are relatively high for small donations. - | For SEPA wire transfer and **commercial support**, please `contact Christian directly `_. - 0.3.1 ----- diff --git a/docs/index.rst b/docs/index.rst index 2383f1d..a11c49b 100644 --- a/docs/index.rst +++ b/docs/index.rst @@ -25,10 +25,10 @@ zrepl - ZFS replication Progress: [=========================\----] 246.7 MiB / 264.7 MiB @ 11.5 MiB/s zroot STEPPING (step 1/2, 624 B/1.2 KiB) next: @a => @b zroot/ROOT DONE (step 2/2, 1.2 KiB/1.2 KiB) - zroot/ROOT/default STEPPING (step 1/2, 123.4 MiB/129.3 MiB) next: @a => @b + * zroot/ROOT/default STEPPING (step 1/2, 123.4 MiB/129.3 MiB) next: @a => @b zroot/tmp STEPPING (step 1/2, 29.9 KiB/44.2 KiB) next: @a => @b zroot/usr STEPPING (step 1/2, 624 B/1.2 KiB) next: @a => @b - zroot/usr/home STEPPING (step 1/2, 123.3 MiB/135.3 MiB) next: @a => @b + * zroot/usr/home STEPPING (step 1/2, 123.3 MiB/135.3 MiB) next: @a => @b zroot/var STEPPING (step 1/2, 624 B/1.2 KiB) next: @a => @b zroot/var/audit DONE (step 2/2, 1.2 KiB/1.2 KiB) zroot/var/crash DONE (step 2/2, 1.2 KiB/1.2 KiB) @@ -66,6 +66,7 @@ Main Features * [x] Large blocks send & receive * [x] Embedded data send & receive * [x] Resume state send & receive + * [x] Bandwidth limiting * **Automatic snapshot management** diff --git a/docs/usage.rst b/docs/usage.rst index afc1e1c..cda118e 100644 --- a/docs/usage.rst +++ b/docs/usage.rst @@ -91,6 +91,8 @@ Ops Runbooks usage/runbooks/migrating_sending_side_to_new_zpool.rst +.. _usage-platform-tests: + ============== Platform Tests ==============