Stork Administrator Reference Manual

Stork is an open source monitoring application and dashboard for ISC’s Kea DHCP; eventually it will be extended to provide similar functionality for ISC’s BIND 9. It is the spiritual successor of the earlier projects Kittiwake and Anterius.

This is the reference guide for Stork version 2.0.0. Links to the most up-to-date version of the Stork ARM document, along with other Stork resources, can be found on ISC’s Stork project homepage or at Read the Docs .

• 1. Overview
  • 1.1. Goals
  • 1.2. Architecture
  • 1.3. Preprocessing the Kea and BIND 9 Statistics for the Prometheus Server
  • 1.4. Monitoring the Status of Services
  • 1.5. Browsing the Logs
  • 1.6. Viewing the DHCP Data
  • 1.7. Managing the DHCP Configuration
  • 1.8. Reviewing the Kea Configuration
  • 1.9. Searching for Leases
  • 1.10. Monitoring the BIND 9 Service
  • 1.11. Security Design
• 2. Installation
  • 2.1. Compatible Systems
  • 2.2. Installation Prerequisites
  • 2.3. The Stork Tool
  • 2.4. Preparing the Stork Server Database
    • 2.4.1. Tuning Database Timeouts
  • 2.5. Installing From Packages
    • 2.5.1. Installing the Stork Server
      • 2.5.1.1. Installing on Debian/Ubuntu
      • 2.5.1.2. Installing on CentOS/RHEL/Fedora
      • 2.5.1.3. Installing on Alpine
      • 2.5.1.4. Setup
      • 2.5.1.5. Stork UI Behind a Reverse Proxy
      • 2.5.1.6. Securing the Database Connection
    • 2.5.2. Installing the Stork Agent
      • 2.5.2.1. Agent Configuration Settings
      • 2.5.2.2. Logging Settings
      • 2.5.2.3. Securing Connections Between the Stork Server and a Stork Agent
      • 2.5.2.4. Securing Connections Between stork-agent and the Kea Control Agent
      • 2.5.2.5. Installation From Cloudsmith and Registration With an Agent Token
      • 2.5.2.6. Installation With a Script and Registration With a Server Token
      • 2.5.2.7. Installation With a Script and Registration With an Agent Token
      • 2.5.2.8. Installation From Cloudsmith and Registration With a Server Token
      • 2.5.2.9. Registration Methods Summary
      • 2.5.2.10. Agent Setup Summary
      • 2.5.2.11. Inspecting Keys and Certificates
      • 2.5.2.12. Using External Keys and Certificates
    • 2.5.3. Installing the Hooks
    • 2.5.4. Upgrading
  • 2.6. Installing From Sources
    • 2.6.1. Compilation Prerequisites
    • 2.6.2. Download Sources
    • 2.6.3. Building
    • 2.6.4. Installing on FreeBSD
    • 2.6.5. Installing on OpenBSD
    • 2.6.6. Cross-compilation
  • 2.7. Security Checklist for Stork Configurations
    • 2.7.1. The Stork Server
    • 2.7.2. The Stork Agent
      • 2.7.2.1. Monitoring Kea
      • 2.7.2.2. Monitoring BIND 9
    • 2.7.3. PostgreSQL
  • 2.8. Integration With Prometheus and Grafana
    • 2.8.1. Prometheus Integration
    • 2.8.2. Alerting in Prometheus
    • 2.8.3. Grafana Integration
    • 2.8.4. Subnet Identification
    • 2.8.5. Alerting in Grafana
  • 2.9. Configuring Deployment-Specific Views
    • 2.9.1. Login Page Welcome Message
• 3. Using Stork
  • 3.1. Dashboard
    • 3.1.1. The DHCP Panel
    • 3.1.2. The Events Panel
    • 3.1.3. The Service Status Panel
  • 3.2. Managing Users
    • 3.2.1. Changing a User Password
  • 3.3. Runtime Configuration Settings
  • 3.4. Connecting and Monitoring Machines
    • 3.4.1. Monitoring a Machine
    • 3.4.2. Disconnecting From a Machine
    • 3.4.3. Dumping Diagnostic Information Into a File
    • 3.4.4. Communication Status With the Monitored Machines
  • 3.5. Monitoring Applications
    • 3.5.1. Application Status
    • 3.5.2. Friendly App Names
    • 3.5.3. IPv4 and IPv6 Subnets per Kea Application
    • 3.5.4. IPv4 and IPv6 Subnets in the Whole Network
    • 3.5.5. IPv4 and IPv6 Networks
    • 3.5.6. Host Reservations
      • 3.5.6.1. Listing Host Reservations
      • 3.5.6.2. Host Reservation Usage Status
      • 3.5.6.3. Sources of Host Reservations
    • 3.5.7. Lease Search
    • 3.5.8. Kea High Availability Status
    • 3.5.9. Viewing the Kea Log
    • 3.5.10. Viewing the Kea Configuration as a JSON Tree
    • 3.5.11. Configuration Review
    • 3.5.12. Synchronizing Kea Configurations
  • 3.6. The Events Page
  • 3.7. The Software Versions Page
    • 3.7.1. Summary of ISC Software Versions Detected by Stork
    • 3.7.2. Kea, BIND 9, and Stork Current Releases
    • 3.7.3. Data Source
    • 3.7.4. The Version Status Icon
• 4. Managing Kea Configuration
  • 4.1. Host Reservations
    • 4.1.1. Creating Host Reservations
    • 4.1.2. Updating Host Reservations
    • 4.1.3. Deleting Host Reservations
  • 4.2. Subnets
    • 4.2.1. Creating Subnets
    • 4.2.2. Updating Subnets
    • 4.2.3. Deleting Subnets
  • 4.3. Shared Networks
    • 4.3.1. Creating Shared Networks
    • 4.3.2. Updating Shared Networks
    • 4.3.3. Deleting Shared Networks
• 5. Troubleshooting
  • 5.1. stork-agent
  • 5.2. stork-server
  • 5.3. High Virtual Memory Usage
• 6. Backend API
• 7. Demo
  • 7.1. Requirements
  • 7.2. Setup Steps
    • 7.2.1. Additional Features
    • 7.2.2. Detached Mode
  • 7.3. Demo Containers
  • 7.4. Initialization
  • 7.5. Stork Environment Simulator
  • 7.6. Prometheus
  • 7.7. Grafana
  • 7.8. Login Page Welcome Message
• 8. Stork Developer’s Guide

Appendices

• Glossary
• Manual Pages