From: Daniel Salzman Date: Fri, 5 Sep 2025 08:30:49 +0000 (+0200) Subject: doc: add a warning to zone-begin and improve other related parts X-Git-Tag: v3.5.0~17 X-Git-Url: http://git.ipfire.org/cgi-bin/gitweb.cgi?a=commitdiff_plain;h=746d4fc1a535793a5706d515ed9d3cf78a900c08;p=thirdparty%2Fknot-dns.git doc: add a warning to zone-begin and improve other related parts --- diff --git a/doc/man_knotc.rst b/doc/man_knotc.rst index c3a7ec40a6..595c2f84a1 100644 --- a/doc/man_knotc.rst +++ b/doc/man_knotc.rst @@ -207,9 +207,9 @@ Actions Get zone data that are currently being presented. **zone-begin** *zone*... [**+benevolent**] - Begin a zone transaction. If **+benevolent** is used, the zone transaction will - be committed even when it contains removals of non-existing or additions of - existing records. + Begin a zone transaction. If **+benevolent** is used, the transaction will + be committed even if it contains removals of non-existent records or additions + of existing records. **zone-commit** *zone*... Commit the zone transaction. All changes are applied to the zone. diff --git a/doc/operation.rst b/doc/operation.rst index 1488014bbd..68b488ccb7 100644 --- a/doc/operation.rst +++ b/doc/operation.rst @@ -205,12 +205,6 @@ Reading and editing zones Knot DNS allows you to read or change zone contents online using the server control interface. -.. WARNING:: - Avoid concurrent zone access from a third party software when a zone event - (zone file load, refresh, DNSSEC signing, dynamic update) is in progress or - pending. In such a case, zone events must be frozen before. For more - information on how to freeze the zone read :ref:`Editing zone file`. - To get contents of all configured zones, or a specific zone contents, or zone records with a specific owner, or even with a specific record type:: @@ -232,6 +226,12 @@ Now you can list all nodes within the transaction using the ``zone-get`` command, which always returns current data with all changes included. The command has the same syntax as ``zone-read``. +.. WARNING:: + If a zone transaction is open, all zone events that modify the zone + (e.g. DNSSEC signing) are blocked until the transaction is eithe committed + or aborted. It is therefore advisable to finish the transaction quickly and + commit without delay. + Within the transaction, you can add a record to a specific zone or to all zones with an open transaction::