From: Thomas Markwalder Date: Fri, 31 Mar 2017 15:29:56 +0000 (-0400) Subject: [5175] Fixed some typos minor word-play X-Git-Tag: trac5196_base~9^2~3 X-Git-Url: http://git.ipfire.org/cgi-bin/gitweb.cgi?a=commitdiff_plain;h=1a4d847ec1e14a7fc887d5054f8264d2a66a4e0d;p=thirdparty%2Fkea.git [5175] Fixed some typos minor word-play --- diff --git a/doc/guide/agent.xml b/doc/guide/agent.xml index 00bb9416a8..50f8ceb312 100644 --- a/doc/guide/agent.xml +++ b/doc/guide/agent.xml @@ -10,7 +10,7 @@
Overview Kea Control Agent (CA) is a daemon, first included in Kea 1.2, which - exposes RESTful control interface for managing Kea servers. The deamon + exposes a RESTful control interface for managing Kea servers. The daemon can receive control commands over HTTP and either forward these commands to the respective Kea servers or handle these commands on its own. The determination whether the command should be handled by the CA or forwarded @@ -19,9 +19,10 @@ supported commands as well as their structures are provided in . Hook libraries can be attached to the CA to provide support for - additional commands. Such hook libraries must implement callouts - for 'control_command_receive' hook point. Details about creating new - hook libraries and supported hook points can be found in + additional commands or custom behavior of existing commands. Such hook + libraries must implement callouts for 'control_command_receive' hook point. + Details about creating new hook libraries and supported hook points can be + found in Kea Developer's Guide.
@@ -87,7 +88,7 @@ It has been mentioned in the that - CA can forward some received commands to the respective Kea servers for + CA can forward received commands to the specific Kea servers for processing. For example, config-get is sent to retrieve configuration of one of the Kea services. When CA receives this command, including a service parameter @@ -106,7 +107,7 @@ of the configuration above, the CA will connect to the DHCPv4 server via /path/to/the/unix/socket-v4 to forward the commands to it. Obviously, the DHCPv4 server must be configured to - listen to connections via this socket. In other words, the command + listen to connections via this same socket. In other words, the command socket configuration for the DHCPv4 server and CA (for this server) must match. Consult the and the to learn how the socket @@ -118,8 +119,8 @@ DHCPv4 and DHCPv6 servers. It currently supports one hook point 'control_command_receive' which makes it possible to delegate processing of some commands to the hooks library. The - hooks-libraries list contains hooks libraries - that should be loaded by the CA, along with their configuration + hooks-libraries list contains the list of hooks + libraries that should be loaded by the CA, along with their configuration information specified with parameters. diff --git a/doc/guide/ctrl-channel.xml b/doc/guide/ctrl-channel.xml index e1a816c2d4..d057752cc6 100644 --- a/doc/guide/ctrl-channel.xml +++ b/doc/guide/ctrl-channel.xml @@ -32,7 +32,7 @@ see and . While it is possible control the servers directly using unix domain sockets it requires that - the controlling client is either running on the same machine as + the controlling client be running on the same machine as the server. In order to connect remotely SSH is usually used to connect to the controlled machine. @@ -40,7 +40,7 @@ of a RESTful API to control the servers, rather than using unix domain sockets directly. Therefore, as of Kea 1.2.0 release, Kea includes a new component called Control Agent (or CA) which - exposes RESTful API to the controlling clients and can forward + exposes a RESTful API to the controlling clients and can forward commands to the respective Kea services over the unix domain sockets. The CA configuration has been described in . @@ -158,7 +158,7 @@ When sending commands via Control Agent, it is possible to specify multiple services at which the command is targetted. CA will forward this - command to each service separatelly. Thus, the CA response to the + command to each service individually. Thus, the CA response to the controlling client will contain an array of individual responses. @@ -168,10 +168,10 @@
Using the Control Channel - Kea development team is actively working on the providing implementations - of the client applications which can be used to control the servers. However, - these clients have certain limitations as of Kea 1.2.0 release. The easiest - way to start playing with the control API is to use common Unix/Linux tools + Kea development team is actively working on providing client applications + which can be used to control the servers. These applications are, however, in the + early stages of development and as of Kea 1.2.0 release have certain limitatins. + The easiest way to start playing with the control API is to use common Unix/Linux tools such as socat and curl. In order to control the given Kea service via unix domain socket, use