[#3477] Addressed comments

isc-projects · Aug 21, 2024 · b27b3b6 · b27b3b6
1 parent 5ef7c6f
commit b27b3b6
Show file tree

Hide file tree

Showing 5 changed files with 22 additions and 20 deletions.
diff --git a/ChangeLog b/ChangeLog
@@ -1,4 +1,4 @@
-2271. [func] func
+2271. [func] fdupont
  Extended the control-socket entry taking a map
  specifying a UNIX/LOCAL control socket for DHCPv4,
  DHCPv6 and DHCP-DDNS servers to a control-sockets

diff --git a/doc/sphinx/arm/agent.rst b/doc/sphinx/arm/agent.rst
@@ -169,7 +169,7 @@ authorized.
 When the ``clients`` authentication list is configured and not empty,
 basic HTTP authentication is required. Each element of the list
 specifies a user ID and a password. The user ID is mandatory, must
-be not empty, and must not contain the colon (:) character. The
+not be empty, and must not contain the colon (:) character. The
 password is optional; when it is not specified an empty password
 is used.
 

diff --git a/doc/sphinx/arm/ddns.rst b/doc/sphinx/arm/ddns.rst
@@ -375,7 +375,7 @@ An example command may look like this:
 HTTP/HTTPS Control Socket
 ~~~~~~~~~~~~~~~~~~~~~~~~~
 
-The ``socket-type`` must be ``http`` or ``https`` (whe the type is ``https``
+The ``socket-type`` must be ``http`` or ``https`` (when the type is ``https``
 TLS is required). The ``socket-address`` (default ``127.0.0.1``) and
 ``socket-port`` (default 8000) specify an IP address and port to which
 the HTTP service will be bound.
@@ -401,7 +401,7 @@ but the client is not authorized.
 When the ``clients`` authentication list is configured and not empty,
 basic HTTP authentication is required. Each element of the list
 specifies a user ID and a password. The user ID is mandatory, must
-be not empty, and must not contain the colon (:) character. The
+not be empty, and must not contain the colon (:) character. The
 password is optional; when it is not specified an empty password
 is used.
 

diff --git a/doc/sphinx/arm/dhcp4-srv.rst b/doc/sphinx/arm/dhcp4-srv.rst
@@ -7564,10 +7564,12 @@ The management API allows the issuing of specific management commands,
 such as statistics retrieval, reconfiguration, or shutdown. For more
 details, see :ref:`ctrl-channel`. By default there are no sockets
 open; to instruct Kea to open a socket, the following entry in the
-configuration file can be used: ::
+configuration file can be used:
+
+::
 
  "Dhcp4": {
- "control-socket": [
+ "control-sockets": [
  {
  "socket-type": "unix",
  "socket-name": "/path/to/the/unix/socket"
@@ -7649,7 +7651,7 @@ as described in :ref:`command-stats`.
 HTTP/HTTPS Control Socket
 -------------------------
 
-The ``socket-type`` must be ``http`` or ``https`` (whe the type is ``https``
+The ``socket-type`` must be ``http`` or ``https`` (when the type is ``https``
 TLS is required). The ``socket-address`` (default ``127.0.0.1``) and
 ``socket-port`` (default 8000) specify an IP address and port to which
 the HTTP service will be bound.
@@ -7675,7 +7677,7 @@ but the client is not authorized.
 When the ``clients`` authentication list is configured and not empty,
 basic HTTP authentication is required. Each element of the list
 specifies a user ID and a password. The user ID is mandatory, must
-be not empty, and must not contain the colon (:) character. The
+not be empty, and must not contain the colon (:) character. The
 password is optional; when it is not specified an empty password
 is used.
 
@@ -7707,7 +7709,7 @@ to detect configuration errors as soon as possible.
  "control-sockets": [
  {
  "socket-type": "https",
- "socket-name": "10.20.30.40",
+ "socket-address": "10.20.30.40",
  "socket-port": 8004,
  "trust-anchor": "/path/to/the/ca-cert.pem",
  "cert-file": "/path/to/the/agent-cert.pem",

diff --git a/doc/sphinx/arm/dhcp6-srv.rst b/doc/sphinx/arm/dhcp6-srv.rst
@@ -7377,7 +7377,7 @@ configuration file can be used:
 ::
 
  "Dhcp6": {
- "control-socket": [
+ "control-sockets": [
  {
  "socket-type": "unix",
  "socket-name": "/path/to/the/unix/socket"
@@ -7459,7 +7459,7 @@ as described in :ref:`command-stats`.
 HTTP/HTTPS Control Socket
 -------------------------
 
-The ``socket-type`` must be ``http`` or ``https`` (whe the type is ``https``
+The ``socket-type`` must be ``http`` or ``https`` (when the type is ``https``
 TLS is required). The ``socket-address`` (default ``::1``) and
 ``socket-port`` (default 8000) specify an IP address and port to which
 the HTTP service will be bound.
@@ -7485,7 +7485,7 @@ but the client is not authorized.
 When the ``clients`` authentication list is configured and not empty,
 basic HTTP authentication is required. Each element of the list
 specifies a user ID and a password. The user ID is mandatory, must
-be not empty, and must not contain the colon (:) character. The
+not be empty, and must not contain the colon (:) character. The
 password is optional; when it is not specified an empty password
 is used.
 
@@ -7517,20 +7517,20 @@ to detect configuration errors as soon as possible.
  "control-sockets": [
  {
  "socket-type": "https",
- "socket-name": "2010:30:40::50",
+ "socket-address": "2010:30:40::50",
  "socket-port": 8005,
  "trust-anchor": "/path/to/the/ca-cert.pem",
  "cert-file": "/path/to/the/agent-cert.pem",
  "key-file": "/path/to/the/agent-key.pem",
  "cert-required": true,
  "authentication": {
- "type": "basic",
- "realm": "kea-control-agent",
- "clients": [
- {
- "user": "admin",
- "password": "1234"
- } ]
+  "type": "basic",
+  "realm": "kea-control-agent",
+  "clients": [
+  {
+  "user": "admin",
+  "password": "1234"
+  } ]
  }
  }
  ],