Changeset 0dcde6e


Ignore:
Timestamp:
06/12/2023 04:20:38 PM (12 months ago)
Author:
Thomas Trepl <thomas@…>
Branches:
12.0, 12.1, kea, ken/TL2024, ken/tuningfonts, lazarus, plabs/newcss, python3.11, rahul/power-profiles-daemon, renodr/vulkan-addition, trunk, xry111/llvm18, xry111/xf86-video-removal
Children:
da1d238
Parents:
baf6d5a0
Message:

Add ctrl-agent config as it needs also be tweaked to find the sockets in /run

File:
1 edited

Legend:

Unmodified
Added
Removed
  • networking/connect/kea.xml

    rbaf6d5a0 r0dcde6e  
    99  <!ENTITY kea-md5sum        "64c75b4cdbe7b1208ab0929865d2bd12">
    1010  <!ENTITY kea-size          "9.5 MB">
    11   <!ENTITY kea-buildsize     "1.9 GB">
    12   <!ENTITY kea-time          "5 SBU"> <!-- CHECK -->
     11  <!ENTITY kea-buildsize     "1.1 GB">
     12  <!ENTITY kea-time          "14 SBU"><!-- Thats unexpectedly long -->
    1313  <!ENTITY kea-arm-vers      "2.2.0">
    1414]>
     
    126126            --localstatedir=/var \
    127127            --enable-shell       \
    128             --with-openssl &amp;&amp;
     128            --with-openssl       \
     129            --disable-static &amp;&amp;
    129130make</userinput></screen>
    130131
     
    189190    which is a management dashboard to <application>ISC Kea</application>.</para>
    190191
     192    <para>
     193      If you want to start the DHCP Server at boot, install the
     194      <phrase revision="sysv"><filename>/etc/rc.d/init.d/kea-dhcpd</filename>
     195      init script</phrase>
     196      <phrase revision="systemd"><filename>kea-dhcpd.service</filename>
     197      unit</phrase> included in the
     198      <xref linkend="bootscripts" revision="sysv"/>
     199      <xref linkend="systemd-units" revision="systemd"/>
     200      package:
     201    </para>
     202
     203<screen role="root"><userinput>make install-kea-dhcpd</userinput></screen>
     204
    191205    <sect3 id="kea-dhcp-config">
    192206      <title>Config Files</title>
     
    203217        <primary sortas="e-etc-kea-keactrl.conf">/etc/kea/keactrl.conf</primary>
    204218      </indexterm>
    205 <!--
     219
    206220      <indexterm zone="kea kea-ctrl-agent-config">
    207221        <primary sortas="e-etc-kea-kea-ctrl-agent.conf">/etc/kea/kea-ctrl-agent.conf</primary>
    208222      </indexterm>
    209 -->
     223
    210224      <indexterm zone="kea kea-dhcp4-config">
    211225        <primary sortas="e-etc-kea-dhcp4.conf">/etc/kea/kea-dhcp4.conf</primary>
     
    233247
    234248      <itemizedlist>
     249        <listitem>
     250          <para>Control Agent</para>
     251          <para>The Control Agent is a daemon which allows the
     252          (re)configuration of the Kea DHCP service via REST API.
     253          Set <literal>ctrl_agent=yes</literal> to start the
     254          control agent (service providing a REST API), set
     255          <literal>ctrl_agent=no</literal> in case the control agent
     256          is not needed.</para>
     257        </listitem>
    235258        <listitem>
    236259          <para>IPv4 DHCP server</para>
     
    255278          are not wanted.</para>
    256279        </listitem>
    257         <listitem>
    258           <para>Control Agent</para>
    259           <para>The Control Agent is a daemon which allows the
    260           (re)configuration of the Kea DHCP service via REST API.
    261           Set <literal>ctrl_agent=yes</literal> to start the
    262           control agent (service providing a REST API), set
    263           <literal>ctrl_agent=no</literal> in case the control agent
    264           is not needed.</para>
    265         </listitem>
    266280      </itemizedlist>
    267281
     
    285299    </sect3>
    286300
     301    <sect3 id="kea-ctrl-agent-config">
     302      <title>Control Agent Configuration</title>
     303
     304      <para>
     305        The provided configuration could be used without changes
     306        but in BLFS objects like sockets are stored in
     307        <filename class="directory">/run</filename>
     308        rather than in
     309        <filename class="directory">/tmp</filename>.
     310      </para>
     311
     312<screen role="nodump" ><userinput>cat &gt; /etc/kea/kea-ctrl-agent.conf &lt;&lt; "EOF"
     313<literal>// Begin /etc/kea/kea-ctrl-agent.conf
     314{
     315  // This is a basic configuration for the Kea Control Agent.
     316  // RESTful interface to be available at http://127.0.0.1:8000/
     317  "Control-agent": {
     318    "http-host": "127.0.0.1",
     319    "http-port": 8000,
     320    "control-sockets": {
     321      "dhcp4": {
     322        "socket-type": "unix",
     323        "socket-name": "/run/kea4-ctrl-socket"
     324      },
     325      "dhcp6": {
     326        "socket-type": "unix",
     327        "socket-name": "/run/kea6-ctrl-socket"
     328      },
     329      "d2": {
     330        "socket-type": "unix",
     331        "socket-name": "/run/kea-ddns-ctrl-socket"
     332      }
     333    },
     334
     335    "loggers": [
     336      {
     337        "name": "kea-ctrl-agent",
     338        "output_options": [
     339          {
     340            "output": "/var/log/kea-ctrl-agent.log"
     341            "pattern": "%D{%Y-%m-%d %H:%M:%S.%q} %-5p %m\n"
     342          }
     343        ],
     344        "severity": "INFO",
     345        "debuglevel": 0
     346      }
     347    ]
     348  }
     349}
     350// End /etc/kea/kea-ctrl-agent.conf</literal>
     351EOF</userinput></screen>
     352
     353    </sect3>
     354
    287355    <sect3 id="kea-dhcp4-config">
    288356      <title>IPv4 DHCP Server Configuration</title>
    289 
    290       <para>
    291         If you want to start the DHCP Server at boot, install the
    292         <phrase revision="sysv"><filename>/etc/rc.d/init.d/kea-dhcpd</filename>
    293         init script</phrase>
    294         <phrase revision="systemd"><filename>kea-dhcpd.service</filename>
    295         unit</phrase> included in the
    296         <xref linkend="bootscripts" revision="sysv"/>
    297         <xref linkend="systemd-units" revision="systemd"/>
    298         package:
    299       </para>
    300 
    301 <screen role="root"><userinput>make install-kea-dhcpd</userinput></screen>
    302357
    303358      <para>
     
    319374    "control-socket": {
    320375      "socket-type": "unix",
    321       "socket-name": "/tmp/kea4-ctrl-socket"
     376      "socket-name": "/run/kea4-ctrl-socket"
    322377    },
    323378
     
    402457
    403458      <para>
    404         If there is a <xref linkend="bind"/> server running, <application>ISC Kea</application>
    405         can update the DNS when it gives an IP address to a client.
    406         A sample configuration file is created in <filename>/etc/kea/kea-dhcp-ddns.conf</filename>.
     459        If there is a <xref linkend="bind"/> server running,
     460        <application>ISC Kea</application> can update the DNS when
     461        it gives an IP address to a client. A sample configuration
     462        file is created in <filename>/etc/kea/kea-dhcp-ddns.conf</filename>.
    407463        Adjust the file to suit your needs or overwrite it by using
    408464        the following sample as the <systemitem class="username">root</systemitem>
     
    418474    "control-socket": {
    419475      "socket-type": "unix",
    420       "socket-name": "/tmp/kea-ddns-ctrl-socket"
     476      "socket-name": "/run/kea-ddns-ctrl-socket"
    421477    },
    422478
     
    483539          provided by <xref linkend="bind"/>.
    484540        </para>
     541        <para>
     542          In this sample config it is assumed that the DNS server
     543          runs on the same machine as Kea does (accessable via
     544          <literal>127.0.0.1</literal>) and that this machine has
     545          the IP <literal>192.168.56.2</literal>.
     546        </para>
    485547      </note>
    486548
     
    522584        <listitem>
    523585          <para>
    524             Tool to control the server processes
     586            Tool to control (start/stop) the server processes
    525587          </para>
    526588          <indexterm zone="kea keactrl">
     
    531593
    532594      <!-- ...to be completed... -->
     595      <!--
     596        kea-admin
     597        kea-ctrl-agent
     598        kea-dhcp4
     599        kea-dhcp6
     600        kea-dhcp-ddns
     601        kea-lfc
     602      -->
     603
     604      <varlistentry id="keashell">
     605        <term><command>keashell</command></term>
     606        <listitem>
     607          <para>
     608            RESTful client to the <application>ISC Kea</application>
     609            services.
     610          </para>
     611          <indexterm zone="kea keashell">
     612            <primary sortas="b-keashell">keashell</primary>
     613          </indexterm>
     614        </listitem>
     615      </varlistentry>
    533616
    534617    </variablelist>
Note: See TracChangeset for help on using the changeset viewer.