Nexus GSLB Documentation¶

Comprehensive documentation for the Nexus Global Server Load Balancer (GSLB).

Start Here¶

New to Nexus GSLB? Read the Architecture overview first to understand how it works, then follow the Getting Started guide to run it in under 10 minutes.
Installing for production? See the Installation guide for systemd, Docker, and manual build options.
Kubernetes deployment? See the Kubernetes guide.

Task-oriented guides for operators and SREs deploying and running Nexus GSLB in production.

Guide	Description
Getting Started	Build, configure, and verify Nexus GSLB in under 10 minutes
Installation	Install via systemd, Docker, or build from source
Architecture	How Nexus GSLB works: DNS server, load balancer, health checking, state sync
Configuration Guide	YAML configuration examples for common setups
Authentication & User Management	Named users, sessions, TOTP, RBAC, first-run setup
GitOps	Manage configuration via GPG-signed Git commits
State Synchronization	Multi-node health and membership sync via NATS + JetStream
Kubernetes	Deploy on Kubernetes with StatefulSet and NATS state sync
Metrics & Observability	Prometheus metrics and scrape configuration
Security Guide	TLS, GitOps signing, NATS mTLS, DNSSEC, auth, secrets
Operations & Troubleshooting	Day-2 runbooks, health checks, common issues
FAQ	Frequently asked questions

Detailed technical reference for developers and operators.

Reference	Description
Configuration	All YAML configuration fields
REST API	API endpoints for pools, members, services, health checks
Deployment	CI/CD pipeline, container images, multi-arch build
Health Checks	TCP/HTTP checks, score window, TLS verification
State Sync	NATS/JetStream subjects, KV buckets, health policies
Metrics	Prometheus metrics catalog
Multi-Tenancy	Admin/tenant model, API key authentication
Licensing	License format, RPS limits, licensegen CLI
Usage Metering	Per-tenant usage counters and API
Performance Tuning	Algorithm selection, SQLite tuning, cluster topology
Operations	Monitoring, logs, key rotation runbooks
Troubleshooting	Deep-dive troubleshooting guide
WebUI	Next.js dashboard, WebSocket updates, building

PlantUML architectural diagrams are available in diagrams/. Render with:

plantuml ./diagrams/*.puml ./diagrams/*.umlb

Or use the VS Code / JetBrains PlantUML plugin.

Configuration examples are YAML and align with internal/config/config.go defaults.
Metrics include constant cluster and node labels when configured.
Security defaults are secure-by-default (e.g., HTTPS health checks verify TLS by default).