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 reference guide for Stork version 1.10.0. Links to the most up-to-date version of this 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. Supported Systems
  • 2.2. Installation Prerequisites
  • 2.3. Stork Tool
  • 2.4. Preparing Stork Server Database
  • 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. 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. 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.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.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.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
• 5. Backend API
• 6. Developer’s Guide
  • 6.1. Rakefile
  • 6.2. Generating Documentation
  • 6.3. Setting Up the Development Environment
    • 6.3.1. Updating dependencies
    • 6.3.2. Installing Git Hooks
  • 6.4. Agent API
  • 6.5. RESTful API
  • 6.6. Backend Unit Tests
    • 6.6.1. Unit Tests Database
    • 6.6.2. Unit Tests Coverage
    • 6.6.3. Benchmarks
    • 6.6.4. Short Testing Mode
  • 6.7. Web UI Unit Tests
  • 6.8. System Tests
    • 6.8.1. Dependencies
    • 6.8.2. Initial steps
    • 6.8.3. Running System Tests
    • 6.8.4. System Tests Framework Structure
    • 6.8.5. System Test Structure
    • 6.8.6. System Tests with a Custom Service
    • 6.8.7. Update Packages in System Tests
    • 6.8.8. Using perfdhcp to Generate Traffic
    • 6.8.9. Debugging System Tests
    • 6.8.10. System Test Commands
    • 6.8.11. Running Tests Alpine Linux
  • 6.9. Docker Containers for Development
  • 6.10. Packaging
  • 6.11. Storybook
    • 6.11.1. Writing a Story
    • 6.11.2. HTTP Mocks
    • 6.11.3. Toast messages
  • 6.12. Implementation details
    • 6.12.1. Agent Registration Process
  • 6.13. Generated Code for DHCP Option Definitions
• 7. Demo
  • 7.1. Requirements
  • 7.2. Setup Steps
    • 7.2.1. Premium Features
    • 7.2.2. Detached Mode
  • 7.3. Demo Containers
  • 7.4. Initialization
  • 7.5. Stork Environment Simulator
  • 7.6. Prometheus
  • 7.7. Grafana

Appendices

• Manual Pages