ff467e218a
Tentative documentation. With the 'switchover' config variable the switchover functionality can be enabled. If enabled a REST API endpoint will appear, using which that switchover can be initiated. Switchover can only be performed when MaxScale is in active mode and failover will be disabled for the duration of the switchover. Only if the switchover succeeds, will failover be enabled again. Might be easier to expose that REST API always and only change the behaviour when calling it, instead of making it appear and re-appear.
MaxScale by MariaDB Corporation
The MariaDB Corporation MaxScale is an intelligent proxy that allows forwarding of database statements to one or more database servers using complex rules, a semantic understanding of the database statements and the roles of the various servers within the backend cluster of databases.
MaxScale is designed to provide load balancing and high availability functionality transparently to the applications. In addition it provides a highly scalable and flexible architecture, with plugin components to support different protocols and routing decisions.
MaxScale is implemented in C and makes extensive use of the asynchronous I/O capabilities of the Linux operating system. The epoll system is used to provide the event driven framework for the input and output via sockets.
The protocols are implemented as external shared object modules which can be loaded at runtime. These modules support a fixed interface, communicating the entries points via a structure consisting of a set of function pointers. This structure is called the "module object".
The code that routes the queries to the database servers is also loaded as external shared objects and are referred to as routing modules.
An Google Group exists for MaxScale that can be used to discuss ideas, issues and communicate with the MaxScale community.
We're also on the #maria and #maxscale channels on FreeNode.
Please report all feature requests, improvements and bugs in the MariaDB Jira.
Documentation
For information about installing and using MaxScale, please refer to the documentation. The official documentation can be found on the MariaDB Knowledge Base.
- MariaDB MaxScale 2.1 Documentation
- MariaDB MaxScale 2.0 Documentation
- MariaDB MaxScale 1.4 Documentation
The module and configuration documentation can be found in the Documentation directory of the source tree.
Contributing Code
Read the Contributing page on the wiki for more information on how to do pull request and where to do them.