- Quick Start: get orchestrator running in 5 minutes
- Tutorials: step-by-step guides for common tasks
- User Manual: comprehensive guide to all features
- Reference Manual: every config field, CLI command, and API endpoint
- Installation: installing the service/binary
- Configuration: breakdown of major configuration variables by topic.
- Execution: running the
orchestratorservice. - Executing via command line
- Using the web interface
- Using the web API: achieving automation via HTTP GET requests
- API v2: versioned REST API with structured JSON responses
- Using orchestrator-client: a no binary/config needed script that wraps API calls
- Scripting samples
- High availability: making
orchestratorhighly available - Deployment instructions, hints and tips
- Shared backend DB deployment
- orchestrator/raft deployment
- Failure detection: how
orchestratordetects failure, types of failures it can handle - Topology recovery: recovery process, promotion and hooks.
- Key-Value stores: master discovery for your apps
- ProxySQL hooks: built-in ProxySQL failover integration
- Named replication channels: multi-source replication with named channels
- Observability: Prometheus metrics and Kubernetes health endpoints
- Status Checks
- Tags
- Understanding CI
- Building and testing
- Releasing and publishing packages
- System test environment
- Docker
- Contributions
- Database providers: database abstraction layer for multi-database support
- Raft evaluation: upstream migration assessment
- Security
- SSL and TLS
- Pseudo GTID: refactoring and high availability without using GTID.
- Agents
- FAQ
- First steps, a quick introduction to
orchestrator