Stork Administrator Reference Manual

Stork is an ISC project with the aim of delivering a use and monitoring dashboard for ISC Kea DHCP, and eventually for ISC BIND 9. It is the spiritual successor of the earlier projects Kittiwake and Anterius.

This is the reference guide for Stork version 0.22.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. Installing from Packages
    • 2.3.1. Installing the Stork Server
      • 2.3.1.1. Installing on Debian/Ubuntu
      • 2.3.1.2. Installing on CentOS/RHEL/Fedora
      • 2.3.1.3. Setup
    • 2.3.2. Installing the Stork Agent
      • 2.3.2.1. Agent Configuration Settings
      • 2.3.2.2. Securing Connections Between Stork Server and Stork Agents
      • 2.3.2.3. Securing Connections Between Stork Agent and Kea Control Agent
      • 2.3.2.4. Installation from Cloudsmith and Registration with an Agent Token
      • 2.3.2.5. Installation with a Script and Registration with a Server Token
      • 2.3.2.6. Installation with a Script and Registration with an Agent Token
      • 2.3.2.7. Installation from Cloudsmith and Registration with a Server Token
      • 2.3.2.8. Registration Methods Summary
      • 2.3.2.9. Agent Setup Summary
      • 2.3.2.10. Inspecting Keys and Certificates
      • 2.3.2.11. Using External Keys and Certificates
    • 2.3.3. Upgrading
  • 2.4. Installing From Sources
    • 2.4.1. Compilation Prerequisites
    • 2.4.2. Download Sources
    • 2.4.3. Building
  • 2.5. Database Migration Tool (optional)
  • 2.6. Integration With Prometheus and Grafana
    • 2.6.1. Prometheus Integration
    • 2.6.2. Grafana Integration
    • 2.6.3. Subnet identification
• 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. Deleting a Machine
  • 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. Leases Search
    • 3.5.8. Kea High Availability Status
    • 3.5.9. Viewing the Kea Log
    • 3.5.10. Viewing the Kea Configuration as JSON Tree
  • 3.6. Dashboard
    • 3.6.1. DHCP Panel
    • 3.6.2. Events Panel
  • 3.7. Events Page
• 4. Backend API
• 5. Developer’s Guide
  • 5.1. Rakefile
  • 5.2. Generating Documentation
  • 5.3. Setting Up the Development Environment
    • 5.3.1. Installing Git Hooks
  • 5.4. Agent API
  • 5.5. REST API
  • 5.6. Backend Unit Tests
    • 5.6.1. Unit Tests Database
    • 5.6.2. Unit Tests Coverage
    • 5.6.3. Benchmarks
    • 5.6.4. Short Testing Mode
  • 5.7. Web UI Unit Tests
  • 5.8. System Tests
    • 5.8.1. Dependencies
    • 5.8.2. LXD Installation
      • 5.8.2.1. LXD troubleshooting on Arch
    • 5.8.3. Running System Tests
    • 5.8.4. Developing System Tests
  • 5.9. Docker Containers for Development
  • 5.10. Packaging
  • 5.11. Implementation details
    • 5.11.1. Agent Registration Process
• 6. Demo
  • 6.1. Requirements
  • 6.2. Setup Steps
    • 6.2.1. Premium Features
  • 6.3. Demo Containers
  • 6.4. Initialization
  • 6.5. Stork Environment Simulator
  • 6.6. Prometheus
  • 6.7. Grafana

Appendices

• Manual Pages

Indices and tables

• Index
• Module Index
• Search Page