]> git.ipfire.org Git - thirdparty/kea.git/commitdiff
[#1191] Added references to Stork
authorTomek Mrugalski <tomasz@isc.org>
Fri, 24 Apr 2020 10:24:56 +0000 (12:24 +0200)
committerTomek Mrugalski <tomasz@isc.org>
Fri, 24 Apr 2020 10:24:56 +0000 (12:24 +0200)
doc/sphinx/arm/ctrl-channel.rst
doc/sphinx/arm/dhcp4-srv.rst
doc/sphinx/arm/dhcp6-srv.rst
doc/sphinx/arm/keactrl.rst
doc/sphinx/arm/quickstart.rst
doc/sphinx/arm/stats.rst

index 1e8f4298fa64fdcf570cdcdb9454629eb5d0a036..abf5127bb14f1bd7121fb5661ecf48e346704209 100644 (file)
@@ -51,6 +51,10 @@ Control connections over both HTTP and UNIX domain sockets are guarded
 with timeouts. The default timeout value is set to 10 seconds and is not
 configurable.
 
+This API can be used by external tools to manage and monitor Kea operation.
+An example of such a monitoring tool is ISC Stork. For details, see
+:ref:`stork`.
+
 .. _ctrl-channel-syntax:
 
 Data Syntax
index bfa3ec18ab4874abb26e98436e89d8016e38ea93..d64a56d2503cff27fad91c5edb00997d64e0b531 100644 (file)
@@ -5806,6 +5806,9 @@ the default maximum sample count to 1 so only one sample will be kept by:
        ...
    }
 
+Statistics can be retrieved periodically to gain more insight into Kea operations. One tool that
+leverages that capability is ISC Stork. See :ref:`stork` for details.
+
 .. _dhcp4-ctrl-channel:
 
 Management API for the DHCPv4 Server
index 01adba47930b3d67e3f91ded5d8db1d97af4c574..fe8fb6d59fb8bceb28002660222cb90e3da00d9d 100644 (file)
@@ -5834,6 +5834,10 @@ the default maximum sample count to 1 so only one sample will be kept by:
        ...
    }
 
+Statistics can be retrieved periodically to gain more insight into Kea operations. One tool that
+leverages that capability is ISC Stork. See :ref:`stork` for details.
+
+
 .. _dhcp6-ctrl-channel:
 
 Management API for the DHCPv6 Server
index d9728826602df337ad51d2098ee003ea4a6019db..b0e4cff83e947edbe76c0158437f8c120a95aa19 100644 (file)
@@ -276,6 +276,9 @@ Sometimes it is useful to check which servers are running. The
    Kea Netconf configuration file: /usr/local/etc/kea/kea-netconf.conf
    keactrl configuration file: /usr/local/etc/kea/keactrl.conf
 
+``keactrl status`` reporting capabilities are rather basic. If you need more extensive insight
+into the Kea health and status, you may consider deploying Stork. For details, see :ref:`stork`.
+
 .. _keactrl-overriding-servers:
 
 Overriding the Server Selection
index 8dbac538b1858bbcad33857dcb9198999adcde29..3c7c93bb3a1706a22c5a21a21dac23ef20d2f203 100644 (file)
@@ -168,6 +168,9 @@ Knowledgebase <https://kb.isc.org/docs>`__.
 
 The details of ``keactrl`` script usage can be found in :ref:`keactrl`.
 
+Once you have Kea services up and running, you may consider deploying a dashboard solution
+that would monitor running services. For more details, see :ref:`stork`.
+
 .. _quick-start-direct-run:
 
 Running the Kea Servers Directly
index 6a554fdf67a3fdf8bc14d74f858cbf30de60635e..484f9c6c639c48c610bfbc42114d810c4c16eb1d 100644 (file)
@@ -47,6 +47,10 @@ set to a neutral value, typically zero), or even completely remove a
 single statistic or all statistics. See the section :ref:`command-stats`
 for a list of statistics-oriented commands.
 
+Statistics can be used by external tools to monitor Kea. One example of such a tool is Stork.
+See :ref:`stork` for details how to use it to retrieve statistics periodically (and use
+other data sources) to get better insight into Kea health and operational status.
+
 .. _stats-lifecycle:
 
 Statistics Lifecycle