Skip to content

Commit 42415e5

Browse files
committed
[#3262] reword RADIUS doc
1 parent 70daa9a commit 42415e5

File tree

1 file changed

+17
-16
lines changed

1 file changed

+17
-16
lines changed

doc/sphinx/arm/ext-radius.rst

+17-16
Original file line numberDiff line numberDiff line change
@@ -173,11 +173,12 @@ flags:
173173
persistent storage for accounting session history.
174174

175175
- ``thread-pool-size`` (default ``0``) indicates the number of threads that
176-
should be used for sending asynchronous RADIUS requests for both access and
177-
accounting services. A value of ``0`` instructs the RADIUS hook library to
178-
use the same number of threads used for DHCP processing. This value is only
179-
relevant if Kea core is configured as multi-threaded. Single-threaded Kea
180-
core makes the RADIUS hook library also be single-threaded.
176+
is used for sending RADIUS requests and processing RADIUS responses for both
177+
access and accounting services before passing it to the core thread pool. A
178+
value of ``0`` instructs the RADIUS hook library to use the same number of
179+
threads used for core DHCP processing. This value is only relevant if Kea
180+
core is configured as multi-threaded. Single-threaded Kea core results in
181+
single-threaded RADIUS processing.
181182

182183
- ``timeout`` (default ``10``) - is the number of seconds during which a
183184
response is awaited.
@@ -227,17 +228,17 @@ At the service level, three sections can be configured:
227228

228229
Attributes are supported only for the access service.
229230

230-
- The ``peer-updates`` boolean flag controls whether lease updates coming from
231-
an active High-Availability (HA) partner should result in an accounting
232-
request. This may be desirable to remove duplicates if HA partners are
233-
configured to send request to the same RADIUS server. The flag is enabled by
234-
default and only supported by the accounting service. The lease
235-
synchronization process at the startup of an HA node does not trigger a RADIUS
236-
accounting request, regardless of the value of this flag.
237-
238-
- The ``max-pending-requests`` positive integer value limits the number
239-
of pending RADIUS requests, the value ``0`` means no limit. It is supported
240-
only by the access service, its default is ``0`` (can change to e.g. 64?).
231+
- The ``peer-updates`` boolean flag (default ``true``) controls whether lease
232+
updates coming from an active High-Availability (HA) partner should result in
233+
an accounting request. This may be desirable to remove duplicates if HA
234+
partners are configured to send request to the same RADIUS server. The flag is
235+
only supported by the accounting service. The lease synchronization process at
236+
the startup of an HA node does not trigger a RADIUS accounting request,
237+
regardless of the value of this flag.
238+
239+
- The ``max-pending-requests`` positive integer (default ``0``) limits the
240+
number of pending RADIUS requests. The value ``0`` means no limit. It is
241+
supported only by the access service. ``64`` can be a good value to set it to.
241242

242243
For example, to specify a single access server available on localhost
243244
that uses ``"xyz123"`` as a secret, and tell Kea to send three additional

0 commit comments

Comments
 (0)