Reference Manuals

This reference manual provides detailed information on every feature, setting, and command available within ClusterControl, ensuring you have the knowledge needed to maximize the platform’s capabilities.

What You’ll Find in This Manual

This manual serves as an essential resource for Database Administrators (DBAs), DevOps Engineers, IT Managers, and Developers looking to optimize their database clusters and streamline their operational workflows. Here’s an overview of what each section covers:

ClusterControl Components

A detailed documentation on all ClusterControl components on configuring ClusterControl, including requirements, supported environments, and integration options. From initial setup to configuring essential components, this section helps you build a strong foundation.

Feature Reference

An in-depth look at ClusterControl’s features, from cluster deployment and scaling to monitoring, backup, and failover. Each feature is broken down to show how it works, its benefits, and example use cases to help you understand when and why to use each function.

Command and API Reference

Detailed documentation on every available command and API endpoint within ClusterControl. This is especially useful for users looking to integrate ClusterControl with other tools or automate tasks, as well as those utilizing the CLI for greater control over their environment.

Troubleshooting and Support

Practical advice and solutions for common issues, error codes, and known limitations. This section also provides guidance on accessing support resources and engaging with the ClusterControl community for additional help.