From b5d853885b868bd0df4677ab6ec6752d4947231b Mon Sep 17 00:00:00 2001 From: Adam Nielsen Date: Tue, 7 Jan 2025 00:36:02 +1000 Subject: [PATCH] docs: rename `properties` to `send_properties` & add note on nfs/smb props (#859) --- docs/configuration/sendrecvoptions.rst | 16 ++++++++++++---- 1 file changed, 12 insertions(+), 4 deletions(-) diff --git a/docs/configuration/sendrecvoptions.rst b/docs/configuration/sendrecvoptions.rst index 906b5cd..c547b80 100644 --- a/docs/configuration/sendrecvoptions.rst +++ b/docs/configuration/sendrecvoptions.rst @@ -12,7 +12,7 @@ Send Options :ref:`Source` and :ref:`push` jobs have an optional ``send`` configuration section. :: - + jobs: - type: push filesystems: ... @@ -84,8 +84,8 @@ If ``encrypted=false``, zrepl expects that filesystems matching ``filesystems`` .. _job-send-options-properties: -``properties`` --------------- +``send_properties`` +------------------- Sends the dataset properties along with snapshots. Please be careful with this option and read the :ref:`note on property replication below `. @@ -171,7 +171,7 @@ You can send the original properties from the first receiver to another receiver 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. 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`` * ``encryption`` +Sharing +------- + +You may not want the replicated filesystem shared in the same way as the source is. + +* ``sharenfs`` +* ``sharesmb`` + .. _job-recv-options--placeholder: Placeholders