Stork Administrator Reference Manual

Stork is a new project led by ISC with the aim of delivering an ISC BIND 9 and ISC Kea DHCP use and monitoring dashboard. It is intended to be a spiritual successor of the earlier attempts Kittiwake and Anterius.

This is the reference guide for Stork version 0.12.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 readthedocs .

• 1. Overview
  • 1.1. Goals
  • 1.2. Architecture
• 2. Installation
  • 2.1. Prerequisites
  • 2.2. Database Migration Tool (optional)
  • 2.3. Installing from Packages
    • 2.3.1. Installing on Debian/Ubuntu
    • 2.3.2. Installing on CentOS/RHEL/Fedora
    • 2.3.3. Initial Setup of the Stork Server
    • 2.3.4. Initial Setup of the Stork Agent
  • 2.4. Installing from Sources
    • 2.4.1. Prerequisites
    • 2.4.2. Download Sources
    • 2.4.3. Building
• 3. Using Stork
  • 3.1. Managing Users
  • 3.2. Changing a User Password
  • 3.3. Deploying Stork Agent
  • 3.4. Connecting and Monitoring Machines
    • 3.4.1. Registering a New Machine
    • 3.4.2. Monitoring a Machine
    • 3.4.3. Deleting a Machine
  • 3.5. Monitoring Applications
    • 3.5.1. Application Status
    • 3.5.2. IPv4 and IPv6 Subnets per Kea Application
    • 3.5.3. IPv4 and IPv6 Subnets in the Whole Network
    • 3.5.4. IPv4 and IPv6 Networks
    • 3.5.5. Host Reservations
    • 3.5.6. Sources of Host Reservations
    • 3.5.7. Kea High Availability Status
    • 3.5.8. Viewing Kea Log
  • 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.7. Docker Containers
  • 5.8. Packaging
• 6. Demo
  • 6.1. Requirements
  • 6.2. Installation Steps
    • 6.2.1. Premium Features
  • 6.3. Initialization
  • 6.4. Stork Environment Simulator
  • 6.5. Prometheus
  • 6.6. Grafana

Appendices

• Manual Pages

Indices and tables

• Index
• Module Index
• Search Page