kea-anterius

• The Anterius project is developed as part of the Google Summer of Code '18 program, with the objective to create a GUI dashboard for the Kea DHCP server that provides monitoring and configuration capabilities to users.

• The GUI and base functionality has been adapted from the GLASS dashboard created for ISC DHCP server.

• Anterius functionality has been modified to support interaction with Kea servers running on remote systems, by incorporating features from the REST API exposed by the Kea Control Agent.

• Anterius currently only supports DHCPv4 server monitoring, and can be interfaced with only a single Kea server instance at a time. DHCPv6 support and multiple servers are features planned to be incorporated in future releases.

Features

Dashboard

The home page provides a monitoring dashboard for the connected server that compiles realtime statistics and critical operating information:

• DHCP Leases per second / minute
• Total Active Leases
• Kea Server Running status
• Shared Network Utilization
• Subnet Utilization

Network Information

• A detailed information page can be viewed for each individual shared network and subnet defined by the server that provides entity specific data such as utilization, pools, total, assigned and available no. of leases.

• Page also presents tables listing the Host Reservations defined in n/w configuration and Lease Information for currently active leases from the network. Shared network page includes a list of subnets contained in the network.

Installation

(Instructions for Debian/Ubuntu based systems)

Install NodeJS (primary dependency)

curl -sL https://deb.nodesource.com/setup_8.x | sudo -E bash -
sudo apt-get install -y nodejs

Install Anterius

• Clone source code from Github

git clone https://github.com/isc-projects/kea-anterius.git
cd kea-anterius

• Install node modules and run

sudo npm install
sudo npm start

• 'npm start' command launches the nodejs server, browse to http://localhost:3000 to use the interface.

Configuration with Kea Server

• Anterius interface can be configured to work with a Kea server instance running either on a remote system or the local machine.

• This characteristic is dependant on the address parameter set for the Kea Control Agent that provides API access to the server.

• To run the Kea Server with its default configuration or specified config file, use the kea control command as shown:

~$ keactrl start -s dhcp4  

~$ keactrl start -s dhcp4 -c /path/to/kea-dhcp4.conf 

• Activate the Kea Control Agent using the following command (change -c conf file path if required):

~$ kea-ctrl-agent -c /usr/local/etc/kea/kea-ctrl-agent.conf

• Check status of Kea DHCPv4 and Kea Control Agent (both must be active) using the command:

~$ keactrl status

• Kea Control Agent(CA) runs on port 8000 by default, defined in the CA config file. Please refer to the Kea Control Agent Documentation for setting CA parameters and addtional info.

• To select mode of operation, from the Anterius Settings option in the menu, set the CA address(host:port) accordingly.

  • For local server (default mode), set address = localhost:8000
  • For remote server, set address = <public_ip:port>