From: Aram Sargsyan <aram@isc.org>
Date: Mon, 10 Jun 2024 16:49:56 +0000 (+0000)
Subject: Document the min-transfer-rate-in configuration option
X-Git-Tag: ondrej/lock-free-qpzone-reads-v1~45^2~2
X-Git-Url: http://git.ipfire.org/cgi-bin/gitweb.cgi?a=commitdiff_plain;h=f6dfff01ab453e91b1f563f13660b4e07efa632e;p=thirdparty%2Fbind9.git

Document the min-transfer-rate-in configuration option

Add a new section in ARM describing min-transfer-rate-in.
---

diff --git a/doc/arm/reference.rst b/doc/arm/reference.rst
index 27e789dd425..d541d705d60 100644
--- a/doc/arm/reference.rst
+++ b/doc/arm/reference.rst
@@ -3324,6 +3324,16 @@ options apply to zone transfers.
    global :any:`also-notify` list are not sent NOTIFY messages for that
    zone. The default is the empty list (no global notification list).
 
+.. namedconf:statement:: min-transfer-rate-in
+   :tags: transfer
+   :short: Specifies the minimum traffic rate below which inbound zone transfers are terminated.
+
+   Inbound zone transfers running slower than the given amount of bytes in the
+   given amount of minutes are terminated. This option takes two non-zero integer values.
+   A check is performed periodically every time the configured time interval
+   passes. The default value is ``10240 5``, i.e. 10240 bytes in 5 minutes.
+   The maximum time value is 28 days (40320 minutes).
+
 .. namedconf:statement:: max-transfer-time-in
    :tags: transfer
    :short: Specifies the number of minutes after which inbound zone transfers are terminated.
@@ -7068,6 +7078,9 @@ Zone Options
 :any:`max-records`
    See the description of :any:`max-records` in :ref:`server_resource_limits`.
 
+:any:`min-transfer-rate-in`
+   See the description of :any:`min-transfer-rate-in` in :ref:`zone_transfers`.
+
 :any:`max-transfer-time-in`
    See the description of :any:`max-transfer-time-in` in :ref:`zone_transfers`.