Skip to content

Commit b27b3b6

Browse files
committed
[#3477] Addressed comments
1 parent 5ef7c6f commit b27b3b6

File tree

5 files changed

+22
-20
lines changed

5 files changed

+22
-20
lines changed

ChangeLog

+1-1
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
1-
2271. [func] func
1+
2271. [func] fdupont
22
Extended the control-socket entry taking a map
33
specifying a UNIX/LOCAL control socket for DHCPv4,
44
DHCPv6 and DHCP-DDNS servers to a control-sockets

doc/sphinx/arm/agent.rst

+1-1
Original file line numberDiff line numberDiff line change
@@ -169,7 +169,7 @@ authorized.
169169
When the ``clients`` authentication list is configured and not empty,
170170
basic HTTP authentication is required. Each element of the list
171171
specifies a user ID and a password. The user ID is mandatory, must
172-
be not empty, and must not contain the colon (:) character. The
172+
not be empty, and must not contain the colon (:) character. The
173173
password is optional; when it is not specified an empty password
174174
is used.
175175

doc/sphinx/arm/ddns.rst

+2-2
Original file line numberDiff line numberDiff line change
@@ -375,7 +375,7 @@ An example command may look like this:
375375
HTTP/HTTPS Control Socket
376376
~~~~~~~~~~~~~~~~~~~~~~~~~
377377

378-
The ``socket-type`` must be ``http`` or ``https`` (whe the type is ``https``
378+
The ``socket-type`` must be ``http`` or ``https`` (when the type is ``https``
379379
TLS is required). The ``socket-address`` (default ``127.0.0.1``) and
380380
``socket-port`` (default 8000) specify an IP address and port to which
381381
the HTTP service will be bound.
@@ -401,7 +401,7 @@ but the client is not authorized.
401401
When the ``clients`` authentication list is configured and not empty,
402402
basic HTTP authentication is required. Each element of the list
403403
specifies a user ID and a password. The user ID is mandatory, must
404-
be not empty, and must not contain the colon (:) character. The
404+
not be empty, and must not contain the colon (:) character. The
405405
password is optional; when it is not specified an empty password
406406
is used.
407407

doc/sphinx/arm/dhcp4-srv.rst

+7-5
Original file line numberDiff line numberDiff line change
@@ -7564,10 +7564,12 @@ The management API allows the issuing of specific management commands,
75647564
such as statistics retrieval, reconfiguration, or shutdown. For more
75657565
details, see :ref:`ctrl-channel`. By default there are no sockets
75667566
open; to instruct Kea to open a socket, the following entry in the
7567-
configuration file can be used: ::
7567+
configuration file can be used:
7568+
7569+
::
75687570

75697571
"Dhcp4": {
7570-
"control-socket": [
7572+
"control-sockets": [
75717573
{
75727574
"socket-type": "unix",
75737575
"socket-name": "/path/to/the/unix/socket"
@@ -7649,7 +7651,7 @@ as described in :ref:`command-stats`.
76497651
HTTP/HTTPS Control Socket
76507652
-------------------------
76517653

7652-
The ``socket-type`` must be ``http`` or ``https`` (whe the type is ``https``
7654+
The ``socket-type`` must be ``http`` or ``https`` (when the type is ``https``
76537655
TLS is required). The ``socket-address`` (default ``127.0.0.1``) and
76547656
``socket-port`` (default 8000) specify an IP address and port to which
76557657
the HTTP service will be bound.
@@ -7675,7 +7677,7 @@ but the client is not authorized.
76757677
When the ``clients`` authentication list is configured and not empty,
76767678
basic HTTP authentication is required. Each element of the list
76777679
specifies a user ID and a password. The user ID is mandatory, must
7678-
be not empty, and must not contain the colon (:) character. The
7680+
not be empty, and must not contain the colon (:) character. The
76797681
password is optional; when it is not specified an empty password
76807682
is used.
76817683

@@ -7707,7 +7709,7 @@ to detect configuration errors as soon as possible.
77077709
"control-sockets": [
77087710
{
77097711
"socket-type": "https",
7710-
"socket-name": "10.20.30.40",
7712+
"socket-address": "10.20.30.40",
77117713
"socket-port": 8004,
77127714
"trust-anchor": "/path/to/the/ca-cert.pem",
77137715
"cert-file": "/path/to/the/agent-cert.pem",

doc/sphinx/arm/dhcp6-srv.rst

+11-11
Original file line numberDiff line numberDiff line change
@@ -7377,7 +7377,7 @@ configuration file can be used:
73777377
::
73787378

73797379
"Dhcp6": {
7380-
"control-socket": [
7380+
"control-sockets": [
73817381
{
73827382
"socket-type": "unix",
73837383
"socket-name": "/path/to/the/unix/socket"
@@ -7459,7 +7459,7 @@ as described in :ref:`command-stats`.
74597459
HTTP/HTTPS Control Socket
74607460
-------------------------
74617461

7462-
The ``socket-type`` must be ``http`` or ``https`` (whe the type is ``https``
7462+
The ``socket-type`` must be ``http`` or ``https`` (when the type is ``https``
74637463
TLS is required). The ``socket-address`` (default ``::1``) and
74647464
``socket-port`` (default 8000) specify an IP address and port to which
74657465
the HTTP service will be bound.
@@ -7485,7 +7485,7 @@ but the client is not authorized.
74857485
When the ``clients`` authentication list is configured and not empty,
74867486
basic HTTP authentication is required. Each element of the list
74877487
specifies a user ID and a password. The user ID is mandatory, must
7488-
be not empty, and must not contain the colon (:) character. The
7488+
not be empty, and must not contain the colon (:) character. The
74897489
password is optional; when it is not specified an empty password
74907490
is used.
74917491

@@ -7517,20 +7517,20 @@ to detect configuration errors as soon as possible.
75177517
"control-sockets": [
75187518
{
75197519
"socket-type": "https",
7520-
"socket-name": "2010:30:40::50",
7520+
"socket-address": "2010:30:40::50",
75217521
"socket-port": 8005,
75227522
"trust-anchor": "/path/to/the/ca-cert.pem",
75237523
"cert-file": "/path/to/the/agent-cert.pem",
75247524
"key-file": "/path/to/the/agent-key.pem",
75257525
"cert-required": true,
75267526
"authentication": {
7527-
"type": "basic",
7528-
"realm": "kea-control-agent",
7529-
"clients": [
7530-
{
7531-
"user": "admin",
7532-
"password": "1234"
7533-
} ]
7527+
"type": "basic",
7528+
"realm": "kea-control-agent",
7529+
"clients": [
7530+
{
7531+
"user": "admin",
7532+
"password": "1234"
7533+
} ]
75347534
}
75357535
}
75367536
],

0 commit comments

Comments
 (0)