Calinora Pilot Documentation is Live
We’ve launched the official documentation site for Calinora Pilot at docs.calinora.io . Whether you’re evaluating Pilot for the first time or running it in production, this is your reference for everything from initial setup to advanced configuration.
What’s Covered
Getting Started
Three guides to get you running quickly:
- Installation - Pull the Docker image and verify it for your platform (amd64/arm64)
- Quick Start - Connect Pilot to an existing cluster in under 5 minutes
- Docker Quick Start - Spin up a full multi-broker Kafka cluster locally with Docker Compose for testing
Feature Documentation
Every Pilot feature has its own page with usage examples, API endpoints, and UI walkthroughs:
- Rebalancing Proposals - How the multi-phase pipeline generates optimal partition moves across leaders, replicas, disk usage, and activity
- What-If Simulator - Model broker failures, rack outages, and traffic spikes before they happen
- Self-Healing - Three independent healing loops for URP fixes, rack violations, and replication factor increases
- Maintenance Mode - Safe broker offline procedures for upgrades and decommissioning
- AI Chat Assistant - Natural language cluster management with approval gates for mutations
- MCP Integration - 67+ tools for connecting external AI agents to your cluster
- Message Browser - Inspect Kafka messages without setting up a separate consumer
Plus consumer groups, client quotas, ACL management, and more.
Configuration
Pilot is configured entirely through environment variables - no config files to manage. The docs cover every scenario:
- SASL Authentication - PLAIN, SCRAM, GSSAPI, and OAUTHBEARER
- TLS/SSL - Client TLS, mutual TLS, inline PEM certificates
- OAuth for Kafka - Token-based auth with Azure AD, Keycloak, and Okta
- UI Authentication - Secure the dashboard with Microsoft Entra ID, Google, GitHub, or any OIDC provider (Keycloak, AD FS, Okta)
- Audit Logging - Track every action to a Kafka topic for compliance
Deployment
Whether you’re running a quick test or deploying to production:
- Docker - Minimal distroless image at ~20MB
- Docker Compose - Pre-built stacks with SASL, TLS, and OAuth variants
- Kubernetes - Deployment manifests with health probes, resource limits, and Prometheus annotations
Guides
Step-by-step tutorials for common workflows:
- Your First Rebalance - Walk through generating, reviewing, and applying a proposal
- Monitoring Setup - Prometheus configuration and Grafana dashboards
- Production Checklist - Security, performance, and operational validation before go-live
- Troubleshooting - Common issues and their solutions
Reference
- Full API Reference - Complete OpenAPI documentation for all REST endpoints
- Prometheus Metrics - Every metric Pilot exposes, grouped by category
- Environment Variables - Alphabetical reference of all configuration options
- Changelog - Version history and release notes
Feedback Welcome
Found something missing or unclear? We’d love to hear from you at [email protected].
