Files
MaxScale/Documentation/Documentation-Contents.md
Markus Makela 0ba4c82fbb Clean up MaxAdmin documentation
The document wraps paragraphs at 80 characters and uses triple backtick
bloks for code sections instead of indentation.

Also fixed a few typos and reworded some parts.
2016-12-14 11:23:17 +02:00

6.6 KiB

Search page for MariaDB MaxScale Documentation

Contents

About MariaDB MaxScale

Getting Started

Upgrading MariaDB MaxScale

Reference

Tutorials

The main tutorial for MariaDB MaxScale consist of setting up MariaDB MaxScale for the environment you are using with either a connection-based or a read/write-based configuration.

These tutorials are for specific use cases and module combinations.

Here are tutorials on monitoring and managing MariaDB MaxScale in cluster environments.

Routers

The routing module is the core of a MariaDB MaxScale service. The router documentation contains all module specific configuration options and detailed explanations of their use.

There are also two diagnostic routing modules. The CLI is for MaxAdmin and the Debug CLI client for Telnet.

Filters

Here are detailed documents about the filters MariaDB MaxScale offers. They contain configuration guides and example use cases. Before reading these, you should have read the filter tutorial so that you know how they work and how to configure them.

Monitors

Common options for all monitor modules.

Module specific documentation.

Protocols

Documentation for MaxScale protocol modules.

Authenticators

A short description of the authentication module type can be found in the Authentication Modules document.

Utilities

Design Documents

Earlier Release Notes