Documentation Index

replication-manager

replication-manager is an open-source, high-availability replication manager for MariaDB and MySQL. This documentation covers installation, configuration, monitoring, security, alerting, provisioning, and more.

Table of Contents

1. Introduction

   • 1.1. Overview
   • 1.2. About Leader Election
   • 1.3. License

2. Getting Started

   • 2.1. Installation
     • 2.1.1. Overview
     • 2.1.2. Install from Embedded Binary
     • 2.1.3. Install from Repository
     • 2.1.4. Install from Docker
     • 2.1.5. Install from Source
     • 2.1.6. Install Orchestrators
     • 2.1.7. Install Dependencies
     • 2.1.8. What Was Installed
   • 2.2. First Config
   • 2.3. First Login
   • 2.4. Migrating from 2.x to 3.x
   • 2.5. Registration & SSO
   • 2.6. Network Ports
   • 2.7. Database Grants

3. First Use

   • 3.1. Start & Stop Monitoring
   • 3.2. Command Line Client
   • 3.3. Web Interface
   • 3.4. API
     • 3.4.1. API Client Usage
     • 3.4.2. API Client Usage (v3)
     • 3.4.3. API Client Usage (v2 and older)
   • 3.5. Provisioning Agent
   • 3.6. Logs

4. High Availability

   • 4.1. Overview
   • 4.2. Switchover Workflow
   • 4.3. Failover WorkFlow
   • 4.4. Topologies
     • 4.4.1. Positional vs GTID
     • 4.4.2. Master Slave
     • 4.4.3. Master Master
     • 4.4.4. Multi Tier Slaves
     • 4.4.5. Multi Master Ring
     • 4.4.6. Multi Master Galera
     • 4.4.7. Multi Master Group Replication
     • 4.4.8. Multi Domains
     • 4.4.9. Binlog Server
     • 4.4.10. Multi Source
     • 4.4.11. Sharding Cluster
     • 4.4.12. Staging Cluster
     • 4.4.13. Active-Passive Topology
   • 4.5. Configuration Guide
     • 4.5.1. Databases
     • 4.5.2. Failover
     • 4.5.3. Switchover
     • 4.5.4. Replication
     • 4.5.5. Routing
       • HAProxy
       • ProxySQL
       • MaxScale
       • Sharding
       • Consul
       • External
       • External Checks
     • 4.5.6. Checks & Enforce
   • 4.6. Troubleshooting

5. Monitoring

   • 5.1. Overview
   • 5.2. Monitoring Configuration Guide
     • 5.2.1. Daemon Monitoring
     • 5.2.2. Metrics Monitoring
     • 5.2.3. Processlist & Transaction Monitoring
     • 5.2.4. Performance Schema Monitoring
     • 5.2.5. Multi node monitoring
   • 5.3. Logs and Troubleshooting

6. Maintenance

   • 6.1. Overview
   • 6.2. Configuration Guide
     • 6.2.1. Scheduler
     • 6.2.2. Backups
     • 6.2.3. Schema & Data Checks
     • 6.2.4. Reseeding

7. Security

   • 7.1. Overview
   • 7.2. Configuration Guide
   • 7.3. SBOM and CRA Compliance
   • 7.4. HTTPS Bastion and Terminal

8. Alerting

   • 8.1. Overview
   • 8.2. Configuration Guide

9. Provisioning

   • 9.1. Overview
   • 9.2. Orchestrators
     • 9.2.1. OpenSVC
       • Collector API
       • Cluster API
       • Advanced Config
     • 9.2.2. SlapOS
     • 9.2.3. Kubernetes
     • 9.2.4. Local
     • 9.2.5. Scripts
     • 9.2.6. OnPremise
   • 9.3. Software Configurator
     • 9.3.1. Overview
     • 9.3.2. Tag Reference
     • 9.3.3. Config Tracking
     • 9.3.4. Configuration Guide
   • 9.4. Service Plan

10. Contribute

    • 10.1. Build
    • 10.2. Testing
    • 10.3. Report Bugs
    • 10.4. Profiling

11. Plugins

    • 11.1. Plugin Architecture
    • 11.2. Built-in Log Plugins
    • 11.3. Workload Plugins
    • 11.4. Security Plugins
    • 11.5. Score Plugins
    • 11.6. Developing Plugins

12. HOWTO

    • 12.1. Replication Best Practices
    • 12.2. Enforce Best Practices
    • 12.3. Troubleshoot Crashes

13. Change Logs

    • 13.1. 1.0 Features
    • 13.2. 1.1 Features
    • 13.3. 2.0 Features
    • 13.4. 2.1 Features
    • 13.5. 2.2 Features
    • 13.6. 2.3 Features
    • 13.7. 3.0 Features
    • 13.8. 3.1 Features
    • 13.9. Roadmap

14. FAQ

    • Frequently Asked Questions

Download PDF

A PDF version of this documentation is generated automatically on each release.

Download latest PDF