Operations Documentation

This section contains operational runbooks, procedures, and guides for deploying and maintaining OpenGSLB in production environments.

Quick Links

Need to…	Go to…
Deploy an agent	Agent Deployment
Deploy Overwatch	Overwatch Deployment
Set up HA	HA Setup Guide
Use Docker	Docker Deployment
Upgrade OpenGSLB	Upgrade Procedures
Respond to incident	Incident Playbook
Secure deployment	Security Hardening
Plan capacity	Capacity Planning

Documentation Structure

Deployment Guides

Step-by-step instructions for initial deployment:

Agent Deployment - Deploy agents on application servers
Overwatch Deployment - Deploy DNS-serving Overwatch nodes
HA Setup Guide - Multi-Overwatch high availability
Docker Deployment - Container-based deployments

Maintenance Procedures

Day-to-day operations and lifecycle management:

Upgrade Procedures - Upgrading to new versions
Rollback Procedures - Rolling back failed upgrades
Backup and Restore - Data protection
GeoIP Updates - Maintaining GeoIP database

Incident Response

Troubleshooting and incident management:

Incident Response Playbook - General response framework
Specific Scenarios:

Security

Security configuration and procedures:

Security Hardening - Comprehensive security checklist
DNSSEC Key Rotation - Rotating DNSSEC keys
Certificate Rotation - Agent certificate management

Capacity Planning

Sizing and performance guidance:

Capacity Planning - Sizing guidelines
Benchmarks - Performance benchmarks

Runbook Conventions

All runbooks in this documentation follow these conventions:

Severity Levels

Level	Description	Response Time
SEV1	Complete service outage	Immediate
SEV2	Partial outage or degraded	15 minutes
SEV3	Minor issues, limited impact	1 hour
SEV4	Informational	Next business day

Command Notation

# Commands with sudo require root privileges
sudo systemctl restart opengslb-overwatch

# Variables in UPPERCASE should be replaced
curl http://OVERWATCH_IP:9090/api/v1/ready

# Optional parameters in [brackets]
opengslb-cli status [--api http://localhost:9090]

Verification Steps

Each procedure includes verification steps marked with checkboxes:

Step completed successfully
Metric within expected range
No errors in logs

Prerequisites

Before using these runbooks, ensure you have:

Access credentials
- SSH access to OpenGSLB servers
- API endpoint access
- Secrets (gossip key, tokens)
Tools installed
- opengslb-cli - CLI management tool
- dig - DNS query tool
- curl - HTTP client
- jq - JSON processor
Monitoring access
- Prometheus/Grafana dashboards
- Alerting system access
- Log aggregation system

Getting Help

Documentation Issues: File issues at GitHub
Community Support: Discussions
Security Issues: security@opengslb.org

Contributing

Found an issue with these runbooks? Contributions welcome:

Fork the repository
Edit files in docs/operations/
Submit a pull request

Document Version: 1.0 Last Updated: December 2025