1
0
mirror of https://github.com/zrepl/zrepl.git synced 2025-04-26 20:39:21 +02:00

docs: rename properties to send_properties & add note on nfs/smb props ()

This commit is contained in:
Adam Nielsen 2025-01-07 00:36:02 +10:00 committed by GitHub
parent 3755c97a86
commit b5d853885b
No known key found for this signature in database
GPG Key ID: B5690EEEBB952194

View File

@ -84,8 +84,8 @@ If ``encrypted=false``, zrepl expects that filesystems matching ``filesystems``
.. _job-send-options-properties: .. _job-send-options-properties:
``properties`` ``send_properties``
-------------- -------------------
Sends the dataset properties along with snapshots. Sends the dataset properties along with snapshots.
Please be careful with this option and read the :ref:`note on property replication below <job-note-property-replication>`. Please be careful with this option and read the :ref:`note on property replication below <job-note-property-replication>`.
@ -171,7 +171,7 @@ You can send the original properties from the first receiver to another receiver
A Note on Property Replication A Note on Property Replication
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
If a send stream contains properties, as per ``send.properties`` or ``send.backup_properties``, If a send stream contains properties, as per ``send.send_properties`` or ``send.backup_properties``,
the default ZFS behavior is to use those properties on the receiving side, verbatim. the default ZFS behavior is to use those properties on the receiving side, verbatim.
In many use cases for zrepl, this can have devastating consequences. In many use cases for zrepl, this can have devastating consequences.
@ -221,6 +221,14 @@ and property replication is enabled, the receiver must :ref:`inherit the followi
* ``keyformat`` * ``keyformat``
* ``encryption`` * ``encryption``
Sharing
-------
You may not want the replicated filesystem shared in the same way as the source is.
* ``sharenfs``
* ``sharesmb``
.. _job-recv-options--placeholder: .. _job-recv-options--placeholder:
Placeholders Placeholders