Skip to content
GitLab
Projects
Groups
Snippets
/
Help
Help
Support
Community forum
Keyboard shortcuts
?
Submit feedback
Contribute to GitLab
Sign in / Register
Toggle navigation
Menu
Open sidebar
ISC Open Source Projects
Kea
Commits
1a4d847e
Commit
1a4d847e
authored
Mar 31, 2017
by
Thomas Markwalder
Browse files
[5175] Fixed some typos minor word-play
parent
8152b76e
Changes
2
Hide whitespace changes
Inline
Side-by-side
doc/guide/agent.xml
View file @
1a4d847e
...
...
@@ -10,7 +10,7 @@
<section
id=
"agent-overview"
>
<title>
Overview
</title>
<para>
Kea Control Agent (CA) is a daemon, first included in Kea 1.2, which
exposes RESTful control interface for managing Kea servers. The d
e
amon
exposes
a
RESTful control interface for managing Kea servers. The da
e
mon
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
<xref
linkend=
"ctrl-channel"
/>
.
</para>
<para>
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
<ulink
url=
"https://jenkins.isc.org/job/Kea_doc/doxygen/"
>
Kea Developer's Guide
</ulink>
.
</para>
</section>
...
...
@@ -87,7 +88,7 @@
<para>
It has been mentioned in the
<xref
linkend=
"agent-overview"
/>
that
CA can forward
some
received commands to the
re
spec
tive
Kea servers for
CA can forward received commands to the spec
ific
Kea servers for
processing. For example,
<command>
config-get
</command>
is sent to
retrieve configuration of one of the Kea services. When CA receives
this command, including a
<command>
service
</command>
parameter
...
...
@@ -106,7 +107,7 @@
of the configuration above, the CA will connect to the DHCPv4 server
via
<filename>
/path/to/the/unix/socket-v4
</filename>
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
<xref
linkend=
"dhcp4-ctrl-channel"
/>
and the
<xref
linkend=
"dhcp6-ctrl-channel"
/>
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
<command>
hooks-libraries
</command>
list contains
hooks librarie
s
that should be loaded by the CA, along with their configuration
<command>
hooks-libraries
</command>
list contains
the list of hook
s
libraries
that should be loaded by the CA, along with their configuration
information specified with
<command>
parameters
</command>
.
</para>
...
...
doc/guide/ctrl-channel.xml
View file @
1a4d847e
...
...
@@ -32,7 +32,7 @@
see
<xref
linkend=
"dhcp4-ctrl-channel"
/>
and
<xref
linkend=
"dhcp6-ctrl-channel"
/>
. 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.
</para>
...
...
@@ -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
<xref
linkend=
"agent-configuration"
/>
.
</para>
...
...
@@ -158,7 +158,7 @@
<simpara>
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
separate
lly. Thus, the CA response to the
command to each service
individua
lly. Thus, the CA response to the
controlling client will contain an array of individual responses.
</simpara>
</note>
...
...
@@ -168,10 +168,10 @@
<section
id=
"ctrl-channel-client"
>
<title>
Using the Control Channel
</title>
<para>
Kea development team is actively working on
the
providing
implement
ations
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
<para>
Kea development team is actively working on providing
client applic
ations
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
<command>
socat
</command>
and
<command>
curl
</command>
.
</para>
<para>
In order to control the given Kea service via unix domain socket, use
...
...
Write
Preview
Supports
Markdown
0%
Try again
or
attach a new file
.
Cancel
You are about to add
0
people
to the discussion. Proceed with caution.
Finish editing this message first!
Cancel
Please
register
or
sign in
to comment