Browse Source

Consider ZFS hook as a beta feature (#261).

Dan Helfman 7 months ago
parent
commit
9fe7db320a
2 changed files with 14 additions and 6 deletions
  1. 1 1
      NEWS
  2. 13 5
      docs/how-to/snapshot-your-filesystems.md

+ 1 - 1
NEWS

@@ -1,5 +1,5 @@
 1.9.3.dev0
- * #261: Add a ZFS hook for snapshotting ZFS datasets and backing them up.
+ * #261 (beta): Add a ZFS hook for snapshotting ZFS datasets and backing them up.
  * Add a "--deleted" flag to the "repo-list" action for listing deleted archives that haven't
    yet been compacted (Borg 2 only).
 

+ 13 - 5
docs/how-to/snapshot-your-filesystems.md

@@ -15,16 +15,18 @@ almost instantly.
 
 ### ZFS
 
-borgmatic supports taking and backing up snapshots with the ZFS filesystem.
-First, you need one or more mounted ZFS datasets. Then, enable ZFS within
-borgmatic by adding the following line to your configuration file:
+<span class="minilink minilink-addedin">New in version 1.9.3</span> <span
+class="minilink minilink-addedin">Beta feature</span> borgmatic supports
+taking and backing up snapshots with the ZFS filesystem. First, you need one
+or more mounted ZFS datasets. Then, enable ZFS within borgmatic by adding the
+following line to your configuration file:
 
 ```yaml
 zfs:
 ```
 
-No other options are necessary, but if desired you can override some of the
-commands used by the ZFS hook. For instance:
+No other options are necessary to enable ZFS support, but if desired you can
+override some of the commands used by the ZFS hook. For instance:
 
 ```yaml
 zfs:
@@ -33,6 +35,12 @@ zfs:
     umount_command: /usr/local/bin/umount
 ```
 
+As long as the ZFS hook is in beta, it may be subject to breaking changes
+and/or may not work well for your use cases. But feel free to use it in
+production if you're okay with these caveats, and please [provide any
+feedback](https://torsion.org/borgmatic/#issues) you have on this feature.
+
+
 #### Dataset discovery
 
 You have a couple of options for borgmatic to find and backup your ZFS datasets: