Stork Administrator Reference Manual

Stork is an open source monitoring application and dashboard for ISC’s Kea DHCP, and eventually for ISC’s BIND 9. It is the spiritual successor of the earlier projects Kittiwake and Anterius.

This is the developer’s guide for Stork version 1.18.0 and is aimed at Stork developers, external contributors, and anyone who wants to understand the internal operation of Stork. Programming background is assumed.

For the user’s guide, see the Stork Administrator Reference Manual. Links to the most up-to-date version of the Stork ARM document, along with other documents for Stork, can be found on ISC’s Stork project homepage or at Read the Docs .

• 1. Overview
  • 1.1. Goals
  • 1.2. Architecture
• 2. Installation
  • 2.1. Compatible Systems
  • 2.2. Installation Prerequisites
  • 2.3. Stork Tool
  • 2.4. Preparing 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. Integration With Prometheus and Grafana
    • 2.7.1. Prometheus Integration
    • 2.7.2. Alerting in Prometheus
    • 2.7.3. Grafana Integration
    • 2.7.4. Subnet Identification
    • 2.7.5. Alerting in Grafana
• 3. Using Stork
  • 3.1. Managing Users
  • 3.2. Changing a User Password
  • 3.3. 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.6.4. Creating Host Reservations
      • 3.5.6.5. Updating Host Reservations
      • 3.5.6.6. Deleting Host Reservations
    • 3.5.7. Leases 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. Dashboard
    • 3.6.1. DHCP Panel
    • 3.6.2. Events Panel
  • 3.7. Events Page
• 4. Troubleshooting
  • 4.1. stork-agent
  • 4.2. stork-server
  • 4.3. High Virtual Memory Usage
• 5. Backend API
• 6. Demo
  • 6.1. Requirements
  • 6.2. Setup Steps
    • 6.2.1. Premium Features
    • 6.2.2. Detached Mode
  • 6.3. Demo Containers
  • 6.4. Initialization
  • 6.5. Stork Environment Simulator
  • 6.6. Prometheus
  • 6.7. Grafana

Appendices

• Manual Pages