Skip to content

Commit 31754d8

Browse files
Razvan Becheriutmarkwalder
Razvan Becheriu
authored andcommitted
[#3587] addressed review
1 parent bc9a6f0 commit 31754d8

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

55 files changed

+1296
-1312
lines changed

doc/examples/kea4/all-keys.json

+2-2
Original file line numberDiff line numberDiff line change
@@ -95,8 +95,8 @@
9595
"name": "late",
9696

9797
// Boolean flag indicating whether the class expression is only evaluated
98-
// when the selected configuration (i.e. pool,subnet, shared-network)
99-
// includes this class name in an "evaluate-additional-classes" list. The
98+
// when the selected configuration (i.e. pool, subnet, shared-network)
99+
// includes this class name in its "evaluate-additional-classes" list. The
100100
// default value false means that the class test expression must
101101
// always be evaluated.
102102
"only-in-additional-list": true,

doc/examples/kea4/classify2.json

+1-1
Original file line numberDiff line numberDiff line change
@@ -23,7 +23,7 @@
2323
"client-classes": [
2424

2525
// This class is included by the second subnet in its 'evaluate-additional-classes'
26-
// list so only-in-addtional-list is enabled. This ensures the class will only
26+
// list so 'only-in-additional-list' is enabled. This ensures the class will only
2727
// be evaluated if the second subnet is selected. The test expression returns true.
2828
// Note it is not possible to depend on VoIP class because it is not yet
2929
// defined.

doc/examples/kea6/classify2.json

+3-2
Original file line numberDiff line numberDiff line change
@@ -24,8 +24,9 @@
2424
// One packet can belong to zero or more classes.
2525
"client-classes": [
2626

27-
// This class is required by the second subnet and is evaluated only
28-
// if it is required. The test expression returns true.
27+
// This class is included by the second subnet in its 'evaluate-additional-classes'
28+
// list so 'only-in-additional-list' is enabled. This ensures the class will only
29+
// be evaluated if the second subnet is selected. The test expression returns true.
2930
// Note it is not possible to depend on cable-modems class because it
3031
// is not yet defined.
3132
{

doc/sphinx/arm/classify.rst

+3-4
Original file line numberDiff line numberDiff line change
@@ -742,8 +742,8 @@ A client class definition can contain the following properties:
742742
- The ``only-in-additional-list`` flag is not mandatory; when its value is set to
743743
``false`` (the default), membership is determined during classification and is
744744
available for subnet selection, for instance. When the value is set to
745-
``true``, membership is evaluated only if the class appears in an ``evaluate-
746-
additional-classes`` list and is usable only for option configuration.
745+
``true``, membership is evaluated only if the class appears in an
746+
``evaluate-additional-classes`` list and is usable only for option configuration.
747747
- The ``user-context`` is not mandatory and represents a map with user-defined data
748748
and possibly configuration options for hook libraries.
749749
- The ``next-server`` parameter is not mandatory and configures the ``siaddr`` field in
@@ -1294,15 +1294,14 @@ the option to members of class "melon":
12941294
}]
12951295
}
12961296

1297-
12981297
Clients that match class "melon" will have a value of 123 for option "foo",
12991298
while clients that do not match "melon" will have a value of 456 for option
13001299
"foo".
13011300

13021301
.. note::
13031302

13041303
Though examples above are for DHCPv4, class-tagging syntax and
1305-
behavior is the same for DHPCv6.
1304+
behavior is the same for DHCPv6.
13061305

13071306
Classes and Hooks
13081307
=================

doc/sphinx/arm/dhcp4-srv.rst

+4-2
Original file line numberDiff line numberDiff line change
@@ -3474,12 +3474,12 @@ over ``option-data`` in a class. If ``option-data`` is moved to a
34743474
required class and required in the subnet, a class evaluated earlier
34753475
may take precedence.
34763476

3477-
Additional evaluation is also available at the shared network and pool levels.
3477+
Additional evaluation is also available at shared network and pool levels.
34783478
The order in which additional classes are considered is: pool, subnet,
34793479
and shared network, i.e. in the same order from the way in which
34803480
``option-data`` is processed.
34813481

3482-
Since Kea version 2.7.4 additional client classes configured without
3482+
Since Kea version 2.7.4 additional classes configured without
34833483
a test expression are unconditionally added, i.e. they are considered
34843484
to always be evaluated to ``true``.
34853485

@@ -8311,6 +8311,8 @@ at which it is currently supported.
83118311
+-----------------------------+----------------------------+--------------+-------------+-------------+-------------+
83128312
| require-client-classes | no | n/a | yes | yes | yes |
83138313
+-----------------------------+----------------------------+--------------+-------------+-------------+-------------+
8314+
| evaluate-additional-classes | no | n/a | yes | yes | yes |
8315+
+-----------------------------+----------------------------+--------------+-------------+-------------+-------------+
83148316
| reservations-global | yes | n/a | yes | yes | n/a |
83158317
+-----------------------------+----------------------------+--------------+-------------+-------------+-------------+
83168318
| reservations-in-subnet | yes | n/a | yes | yes | n/a |

doc/sphinx/arm/dhcp6-srv.rst

+9-7
Original file line numberDiff line numberDiff line change
@@ -4668,22 +4668,22 @@ For example:
46684668
]
46694669
}
46704670

4671-
The ``only-in-additional-list`` parameter is needed here to force
4672-
evaluation of the class after the lease has been allocated and thus the
4673-
reserved class has been also assigned.
4671+
The ``only-in-additional-list`` parameter is needed here to force evaluation
4672+
of the class after the lease has been allocated and thus the reserved
4673+
class has been also assigned.
46744674

46754675
.. note::
46764676

46774677
The classes specified in non-global host reservations
46784678
are assigned to the processed packet after all classes with the
4679-
``only-in-additional-list` parameter set to ``false`` have been evaluated.
4679+
``only-in-additional-list`` parameter set to ``false`` have been evaluated.
46804680
This means that these classes must not depend on the
46814681
statically assigned classes from the host reservations. If
4682-
such a dependency is needed, the ``only-in-addtional-list`` must
4682+
such a dependency is needed, the ``only-in-additional-list`` parameter must
46834683
be set to ``true`` for the dependent classes. Such classes are
46844684
evaluated after the static classes have been assigned to the packet.
46854685
This, however, imposes additional configuration overhead, because
4686-
all classes marked as ``only-in-addtional-list`` must be listed in the
4686+
all classes marked as ``only-in-additional-list`` must be listed in the
46874687
``evaluate-additional-classes`` list for every subnet where they are used.
46884688

46894689
.. note::
@@ -8059,7 +8059,9 @@ at which it is currently supported.
80598059
+-----------------------------+----------------------------+-----------+-----------+-----------+-----------+------------+
80608060
| renew-timer | yes | n/a | yes | yes | n/a | n/a |
80618061
+-----------------------------+----------------------------+-----------+-----------+-----------+-----------+------------+
8062-
| require-client-classes | n/a | n/a | yes | yes | yes | yes |
8062+
| require-client-classes | no | n/a | yes | yes | yes | yes |
8063+
+-----------------------------+----------------------------+-----------+-----------+-----------+-----------+------------+
8064+
| evaluate-additional-classes | no | n/a | yes | yes | yes | yes |
80638065
+-----------------------------+----------------------------+-----------+-----------+-----------+-----------+------------+
80648066
| reservations-global | yes | n/a | yes | yes | n/a | n/a |
80658067
+-----------------------------+----------------------------+-----------+-----------+-----------+-----------+------------+

doc/sphinx/arm/hooks-class-cmds.rst

+1-1
Original file line numberDiff line numberDiff line change
@@ -260,4 +260,4 @@ returned if they are not specified for the class.
260260
``only-in-additional-list`` and deprecated. In order to allow users time
261261
to migrate class commands will still accept it as input but translate it
262262
to ``only-in-additional-list`` on output. Eventually support for the
263-
old name wil be removed.
263+
old name will be removed.

doc/sphinx/arm/hooks-ha.rst

+1-1
Original file line numberDiff line numberDiff line change
@@ -1746,7 +1746,7 @@ lease, it parks the client response until the peers acknowledge the lease
17461746
update. At that point, the server unparks the response and sends it to the
17471747
client. This applies to client queries that cause lease changes, such as
17481748
DHCPREQUEST for DHCPv4 and Request, Renew, and Rebind for DHCPv6. It does not
1749-
apply to DHPCDISCOVERs (v4) or Solicits (v6).
1749+
apply to DHCPDISCOVERs (v4) or Solicits (v6).
17501750

17511751
.. _ha-maintenance:
17521752

doc/sphinx/umls.rst

+1-1
Original file line numberDiff line numberDiff line change
@@ -22,7 +22,7 @@ These diagrams are focused on those aspects of Kea processing that will be most
2222
Main Loop
2323
^^^^^^^^^
2424

25-
The main loop is common to both DHCPv4 and DHPCv6 servers.
25+
The main loop is common to both DHCPv4 and DHCPv6 servers.
2626

2727
.. figure:: uml/main-loop.*
2828

src/bin/admin/tests/mysql_tests.sh.in

+4-6
Original file line numberDiff line numberDiff line change
@@ -73,8 +73,8 @@ mysql_wipe() {
7373
}
7474

7575
# Checks that a column in a table exists.
76-
# param table name of table containgin the column
7776
# param column name of the column to check
77+
# param table name of table containing the column
7878
check_table_column() {
7979
column=$1;shift
8080
table=$1;shift
@@ -966,16 +966,14 @@ mysql_upgrade_25_to_26_test() {
966966
# client_classes been added to dhcp6_options
967967
check_table_column client_classes dhcp6_options
968968

969-
# check rename of require_client_classes to evaluate_additaionl_classes.
970-
check_table_column evaluate_additional_classes dhcp4_shared_network
971-
check_table_column evaluate_additional_classes dhcp4_shared_network
969+
# check rename of require_client_classes to evaluate_additional_classes.
972970
check_table_column evaluate_additional_classes dhcp4_shared_network
973971
check_table_column evaluate_additional_classes dhcp4_subnet
972+
check_table_column evaluate_additional_classes dhcp4_pool
974973
check_table_column evaluate_additional_classes dhcp6_shared_network
975974
check_table_column evaluate_additional_classes dhcp6_subnet
976-
check_table_column evaluate_additional_classes dhcp4_pool
977-
check_table_column evaluate_additional_classes dhcp6_pd_pool
978975
check_table_column evaluate_additional_classes dhcp6_pool
976+
check_table_column evaluate_additional_classes dhcp6_pd_pool
979977

980978
# check rename of only_if_required to only_in_additional_list.
981979
check_table_column only_in_additional_list dhcp4_client_class

src/bin/admin/tests/pgsql_tests.sh.in

+6-8
Original file line numberDiff line numberDiff line change
@@ -61,8 +61,8 @@ run_statement() {
6161
}
6262

6363
# Checks that a column in a table exists.
64-
# param table name of table containgin the column
6564
# param column name of the column to check
65+
# param table name of table containing the column
6666
check_table_column() {
6767
column=$1;shift
6868
table=$1;shift
@@ -1053,21 +1053,19 @@ pgsql_upgrade_24_to_25_test() {
10531053

10541054
pgsql_upgrade_25_to_26_test() {
10551055
# client_classes been added to dhcp4_options
1056-
check_table_column client_classes dhcp4_options;
1056+
check_table_column client_classes dhcp4_options
10571057

10581058
# client_classes been added to dhcp6_options
1059-
check_table_column client_classes dhcp6_options;
1059+
check_table_column client_classes dhcp6_options
10601060

1061-
# check rename of require_client_classes to evaluate_additaionl_classes.
1062-
check_table_column evaluate_additional_classes dhcp4_shared_network
1063-
check_table_column evaluate_additional_classes dhcp4_shared_network
1061+
# check rename of require_client_classes to evaluate_additional_classes.
10641062
check_table_column evaluate_additional_classes dhcp4_shared_network
10651063
check_table_column evaluate_additional_classes dhcp4_subnet
1064+
check_table_column evaluate_additional_classes dhcp4_pool
10661065
check_table_column evaluate_additional_classes dhcp6_shared_network
10671066
check_table_column evaluate_additional_classes dhcp6_subnet
1068-
check_table_column evaluate_additional_classes dhcp4_pool
1069-
check_table_column evaluate_additional_classes dhcp6_pd_pool
10701067
check_table_column evaluate_additional_classes dhcp6_pool
1068+
check_table_column evaluate_additional_classes dhcp6_pd_pool
10711069

10721070
# check rename of only_if_required to only_in_additional_list.
10731071
check_table_column only_in_additional_list dhcp4_client_class

0 commit comments

Comments
 (0)