summaryrefslogtreecommitdiffstats
path: root/doc/sphinx
diff options
context:
space:
mode:
authorAndrei Pavel <andrei@isc.org>2023-06-13 18:56:46 +0200
committerAndrei Pavel <andrei@isc.org>2023-06-14 19:26:11 +0200
commit0ccda2a19f7a055b5497746b805d6be9a2cf326e (patch)
tree61fa9af81db40d12350efbb57f507ad36856bc36 /doc/sphinx
parent[#2554] add notes about each hook library's packaging (diff)
downloadkea-0ccda2a19f7a055b5497746b805d6be9a2cf326e.tar.xz
kea-0ccda2a19f7a055b5497746b805d6be9a2cf326e.zip
[#2554] more iscman references in ARM
Diffstat (limited to 'doc/sphinx')
-rw-r--r--doc/sphinx/arm/agent.rst6
-rw-r--r--doc/sphinx/arm/ext-gss-tsig.rst5
-rw-r--r--doc/sphinx/arm/hooks-radius.rst4
3 files changed, 7 insertions, 8 deletions
diff --git a/doc/sphinx/arm/agent.rst b/doc/sphinx/arm/agent.rst
index 5167d2173d..31be5f73e2 100644
--- a/doc/sphinx/arm/agent.rst
+++ b/doc/sphinx/arm/agent.rst
@@ -189,12 +189,12 @@ password, these values can be read from files. The syntax is extended by:
When files are used, they are read when the configuration is loaded,
to detect configuration errors as soon as possible.
-Hook libraries can be loaded by the Control Agent in the same way as
-they are loaded by the DHCPv4 and DHCPv6 servers. The CA currently
+Hook libraries can be loaded by :iscman:`kea-ctrl-agent` in the same way as
+they are loaded by :iscman:`kea-dhcp4` and :iscman:`kea-dhcp6`. The CA currently
supports one hook point - ``control_command_receive`` - which makes it
possible to delegate the processing of some commands to the hook library.
The ``hooks-libraries`` list contains the list of hook libraries that
-should be loaded by the CA, along with their configuration information
+should be loaded by :iscman:`kea-ctrl-agent`, along with their configuration information
specified with ``parameters``.
Please consult :ref:`logging` for the details on how to configure
diff --git a/doc/sphinx/arm/ext-gss-tsig.rst b/doc/sphinx/arm/ext-gss-tsig.rst
index e754d8911b..404a15ee04 100644
--- a/doc/sphinx/arm/ext-gss-tsig.rst
+++ b/doc/sphinx/arm/ext-gss-tsig.rst
@@ -117,8 +117,7 @@ detection, similar to this:
available.
7. After compilation, :ischooklib:`libddns_gss_tsig.so` is available in the
- ``premium/src/hooks/d2/gss_tsig`` directory. It can be loaded by
- the Kea DHCP-DDNS (D2) daemon.
+ ``premium/src/hooks/d2/gss_tsig`` directory. It can be loaded by :iscman:`kea-dhcp-ddns`.
:ischooklib:`libddns_gss_tsig.so` was developed using the MIT Kerberos 5 implementation, but
Heimdal is also supported. Note that Heimdal is picky about
@@ -464,7 +463,7 @@ Using GSS-TSIG
There are a number of steps required to enable the GSS-TSIG mechanism:
-1. :ischooklib:`libddns_gss_tsig.so` must be loaded by the D2 server.
+1. :ischooklib:`libddns_gss_tsig.so` must be loaded by :iscman:`kea-dhcp-ddns`.
2. The GSS-TSIG-capable DNS servers must be specified with their parameters.
An excerpt from a D2 server configuration is provided below; more examples are available in the
diff --git a/doc/sphinx/arm/hooks-radius.rst b/doc/sphinx/arm/hooks-radius.rst
index 927aac4537..9e8377c6ab 100644
--- a/doc/sphinx/arm/hooks-radius.rst
+++ b/doc/sphinx/arm/hooks-radius.rst
@@ -309,8 +309,8 @@ option is recommended to speed up the build.
RADIUS Hook Configuration
~~~~~~~~~~~~~~~~~~~~~~~~~
-The RADIUS hook is a library that must be loaded by either DHCPv4 or
-DHCPv6 Kea servers. Unlike some other available hook libraries, this one
+The RADIUS hook is a library that must be loaded by either :iscman:`kea-dhcp4` or
+:iscman:`kea-dhcp6` servers. Unlike some other available hook libraries, this one
takes many parameters. For example, this configuration could be used:
::