Skip to content

Commit 6671e30

Browse files
author
Razvan Becheriu
committed
[#2959] addressed comments
1 parent 23f7d80 commit 6671e30

File tree

10 files changed

+8484
-8981
lines changed

10 files changed

+8484
-8981
lines changed

doc/examples/kea4/reservations.json

Lines changed: 8 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -48,10 +48,10 @@
4848
// to the dynamic pool. Kea is able to handle this case, but it is not
4949
// recommended from a performance perspective, as Kea would not only need to
5050
// check if a given address is free, but also whether it is reserved.
51-
// To avoid this check, one can set "reservations-out-of-pool", beside
52-
// the "reservations-in-subnet". If a subnet does not have reservations at all,
53-
// the reservation lookup can be skipped altogether by disabling
54-
// "reservations-in-subnet".
51+
// To avoid this check, one can set "reservations-out-of-pool" to true, beside
52+
// the "reservations-in-subnet" which should be also set to true. If a subnet
53+
// does not have reservations at all, the reservation lookup can be skipped
54+
// altogether by setting "reservations-in-subnet" to false.
5555

5656
// Note that the second reservation is for an address which is within the
5757
// range of the pool of the dynamically allocated address. The server will
@@ -65,18 +65,20 @@
6565
"interface": "eth0",
6666
// This directive tells Kea that reservations may be made both in-pool
6767
// and out-of-pool. For improved performance, you may move all reservations
68-
// out of the dynamic pool and set "reservations-out-of-pool".
68+
// out of the dynamic pool and set "reservations-out-of-pool" to true.
6969
// Kea will then be able to skip querying for host reservations when
7070
// assigning leases from dynamic pool.
7171

7272
// Specify whether the server should look up global reservations.
73+
// Defaults to false.
7374
"reservations-global": false,
7475

7576
// Specify whether the server should look up in-subnet reservations.
77+
// Defaults to true.
7678
"reservations-in-subnet": true,
7779

7880
// Specify whether the server can assume that all reserved addresses
79-
// are out-of-pool.
81+
// are out-of-pool. Defaults to false.
8082
// Ignored when reservations-in-subnet is false.
8183
// If specified, it is inherited by "shared-networks" and
8284
// "subnet4" levels.

doc/examples/kea6/reservations.json

Lines changed: 4 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -47,18 +47,20 @@
4747

4848
// This directive tells Kea that reservations may be made both in-pool
4949
// and out-of-pool. For improved performance, you may move all reservations
50-
// out of the dynamic pool and set "reservations-out-of-pool".
50+
// out of the dynamic pool and set "reservations-out-of-pool" to true.
5151
// Kea will then be able to skip querying for host reservations when
5252
// assigning leases from dynamic pool.
5353

5454
// Specify whether the server should look up global reservations.
55+
// Defaults to false.
5556
"reservations-global": false,
5657

5758
// Specify whether the server should look up in-subnet reservations.
59+
// Defaults to true.
5860
"reservations-in-subnet": true,
5961

6062
// Specify whether the server can assume that all reserved addresses
61-
// are out-of-pool.
63+
// are out-of-pool. Defaults to false.
6264
// Ignored when reservations-in-subnet is false.
6365
// If specified, it is inherited by "shared-networks" and
6466
// "subnet6" levels.

doc/sphinx/arm/dhcp4-srv.rst

Lines changed: 14 additions & 14 deletions
Original file line numberDiff line numberDiff line change
@@ -5324,27 +5324,27 @@ allocating or renewing a lease for the client.
53245324

53255325
Configuration flags are:
53265326

5327-
- ``reservations-in-subnet`` - enables in-pool host reservation types. This
5328-
setting is the default value, and is the safest and most flexible. However,
5329-
as all checks are conducted, it is also the slowest. It does not check
5330-
against global reservations.
5331-
5332-
- ``reservations-out-of-pool`` - allows only out-of-pool host reservations.
5333-
With this setting in place, the server assumes that all host reservations are
5334-
for addresses that do not belong to the dynamic pool. Therefore, it can skip
5335-
the reservation checks when dealing with in-pool addresses, thus improving
5336-
performance. Do not use this mode if any reservations use in-pool addresses.
5337-
Caution is advised when using this setting; Kea does not sanity-check the
5338-
reservations against ``reservations-out-of-pool`` and misconfiguration may
5339-
cause problems.
5327+
- ``reservations-in-subnet`` - when set to true, it enables in-pool host
5328+
reservation types. This setting is the default value, and is the safest and
5329+
most flexible. However, as all checks are conducted, it is also the slowest.
5330+
It does not check against global reservations. This flag defaults to true.
5331+
5332+
- ``reservations-out-of-pool`` - when set to true, it allows only out-of-pool
5333+
host reservations. In this case the server assumes that all host reservations
5334+
are for addresses that do not belong to the dynamic pool. Therefore, it can
5335+
skip the reservation checks when dealing with in-pool addresses, thus
5336+
improving performance. Do not use this mode if any reservations use in-pool
5337+
addresses. Caution is advised when using this setting; Kea does not
5338+
sanity-check the reservations against ``reservations-out-of-pool`` and
5339+
misconfiguration may cause problems. This flag defaults to false.
53405340

53415341
- ``reservations-global`` - allows global host reservations. With this setting
53425342
in place, the server searches for reservations for a client among the defined
53435343
global reservations. If an address is specified, the server skips the
53445344
reservation checks carried out in other modes, thus improving performance.
53455345
Caution is advised when using this setting; Kea does not sanity-check the
53465346
reservations when ``reservations-global`` is set, and misconfiguration may
5347-
cause problems.
5347+
cause problems. This flag defaults to false.
53485348

53495349
Note: disabling all flags disables host reservation support. As there are no
53505350
reservations, the server skips all checks. Any reservations defined are

doc/sphinx/arm/dhcp6-srv.rst

Lines changed: 14 additions & 14 deletions
Original file line numberDiff line numberDiff line change
@@ -4622,27 +4622,27 @@ allocating or renewing a lease for the client.
46224622

46234623
Configuration flags are:
46244624

4625-
- ``reservations-in-subnet`` - enables in-pool host reservation types. This
4626-
setting is the default value, and is the safest and most flexible. However,
4627-
as all checks are conducted, it is also the slowest. It does not check
4628-
against global reservations.
4629-
4630-
- ``reservations-out-of-pool`` - allows only out-of-pool host reservations.
4631-
With this setting in place, the server assumes that all host reservations are
4632-
for addresses that do not belong to the dynamic pool. Therefore, it can skip
4633-
the reservation checks when dealing with in-pool addresses, thus improving
4634-
performance. Do not use this mode if any reservations use in-pool addresses.
4635-
Caution is advised when using this setting; Kea does not sanity-check the
4636-
reservations against ``reservations-out-of-pool`` and misconfiguration may
4637-
cause problems.
4625+
- ``reservations-in-subnet`` - when set to true, it enables in-pool host
4626+
reservation types. This setting is the default value, and is the safest and
4627+
most flexible. However, as all checks are conducted, it is also the slowest.
4628+
It does not check against global reservations. This flag defaults to true.
4629+
4630+
- ``reservations-out-of-pool`` - when set to true, it allows only out-of-pool
4631+
host reservations. In this case the server assumes that all host reservations
4632+
are for addresses that do not belong to the dynamic pool. Therefore, it can
4633+
skip the reservation checks when dealing with in-pool addresses, thus
4634+
improving performance. Do not use this mode if any reservations use in-pool
4635+
addresses. Caution is advised when using this setting; Kea does not
4636+
sanity-check the reservations against ``reservations-out-of-pool`` and
4637+
misconfiguration may cause problems. This flag defaults to false.
46384638

46394639
- ``reservations-global`` - allows global host reservations. With this setting
46404640
in place, the server searches for reservations for a client among the defined
46414641
global reservations. If an address is specified, the server skips the
46424642
reservation checks carried out in other modes, thus improving performance.
46434643
Caution is advised when using this setting; Kea does not sanity-check the
46444644
reservations when ``reservations-global`` is set, and misconfiguration may
4645-
cause problems.
4645+
cause problems. This flag defaults to false.
46464646

46474647
Note: disabling all flags disables host reservation support. As there are no
46484648
reservations, the server skips all checks. Any reservations defined are

0 commit comments

Comments
 (0)