Skip to content

Commit ce96fca

Browse files
mariadb-udaydubeygitbook-bot
authored andcommitted
GITBOOK-149: docs-5899/Added-a-new-page-description-for-maxscale-architecture-landing-pages-and-subpages
1 parent dfdaafa commit ce96fca

File tree

3 files changed

+30
-63
lines changed

3 files changed

+30
-63
lines changed

maxscale/maxscale-architecture/README.md

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,8 +1,8 @@
11
---
22
description: >-
3-
Understand MariaDB MaxScale's architecture. Explore its components, including
4-
monitors, routers, and filters, and how they work together to provide advanced
5-
database proxy capabilities.
3+
Understand the architecture of MariaDB MaxScale. This section details the core
4+
components, including routers, monitors, and filters, that power the database
5+
proxy.
66
icon: house-blank
77
---
88

maxscale/maxscale-architecture/mariadb-maxscale-guide.md

Lines changed: 16 additions & 32 deletions
Original file line numberDiff line numberDiff line change
@@ -1,51 +1,35 @@
1+
---
2+
description: >-
3+
Learn the fundamental concepts of MariaDB MaxScale. This guide explains its
4+
role as a database proxy, its plugin-based architecture, and how it manages
5+
database connections.
6+
---
7+
18
# About MariaDB MaxScale
29

310
## About MariaDB MaxScale
411

5-
**MariaDB MaxScale** is a database proxy that forwards database statements to
6-
one or more database servers.
12+
**MariaDB MaxScale** is a database proxy that forwards database statements to one or more database servers.
713

8-
The forwarding is performed using rules based on the semantic understanding of
9-
the database statements and on the roles of the servers within the backend
10-
cluster of databases.
14+
The forwarding is performed using rules based on the semantic understanding of the database statements and on the roles of the servers within the backend cluster of databases.
1115

12-
MariaDB MaxScale is designed to provide, transparently to applications, load
13-
balancing and high availability functionality. MariaDB MaxScale has a scalable
14-
and flexible architecture, with plugin components to support different protocols
15-
and routing approaches.
16+
MariaDB MaxScale is designed to provide transparent to applications, load balancing and high availability functionality. MariaDB MaxScale has a scalable and flexible architecture, with plugin components to support different protocols and routing approaches.
1617

17-
MariaDB MaxScale makes extensive use of the asynchronous I/O capabilities of the
18-
Linux operating system, combined with a fixed number of worker threads. _epoll_
19-
is used to provide the event driven framework for the input and output via
20-
sockets.
18+
MariaDB MaxScale makes extensive use of the asynchronous I/O capabilities of the Linux operating system, combined with a fixed number of worker threads. _epoll_ is used to provide an event-driven framework for the input and output via sockets.
2119

22-
Many of the services provided by MariaDB MaxScale are implemented as external
23-
shared object modules loaded at runtime. These modules support a fixed
24-
interface, communicating the entry points via a structure consisting of a set of
25-
function pointers. This structure is called the "module object". Additional
26-
modules can be created to work with MariaDB MaxScale.
20+
Many of the services provided by MariaDB MaxScale are implemented as external shared object modules loaded at runtime. These modules support a fixed interface, communicating the entry points via a structure consisting of a set of function pointers. This structure is called the "module object". Additional modules can be created to work with MariaDB MaxScale.
2721

28-
Commonly used module types are _protocol_, _router_ and _filter_. Protocol
29-
modules implement the communication between clients and MariaDB MaxScale, and
30-
between MariaDB MaxScale and backend servers. Routers inspect the queries from
31-
clients and decide the target backend. The decisions are usually based on
32-
routing rules and backend server status. Filters work on data as it passes
33-
through MariaDB MaxScale. Filter are often used for logging queries or modifying
34-
server responses.
22+
Commonly used module types are _protocol_, _router,_ and _filter_. Protocol modules implement the communication between clients and MariaDB MaxScale, and between MariaDB MaxScale and backend servers. Routers inspect the queries from clients and decide the target backend. The decisions are usually based on routing rules and backend server status. Filters work on data as it passes through MariaDB MaxScale. Filters are often used for logging queries or modifying server responses.
3523

36-
A Google Group exists for MariaDB MaxScale. The Group is used to discuss ideas,
37-
issues and communicate with the MariaDB MaxScale community. Send email to [[email protected]](mailto:[email protected]) or use the [forum](https://groups.google.com/forum/#!forum/maxscale) interface.
24+
A Google Group exists for MariaDB MaxScale. The Group is used to discuss ideas, issues, and communicate with the MariaDB MaxScale community. Send an email to [[email protected]](mailto:[email protected]) or use the [forum](https://groups.google.com/forum/#!forum/maxscale) interface.
3825

3926
Bugs can be reported in the MariaDB Jira [jira.mariadb.org](https://jira.mariadb.org)
4027

4128
### Installing MariaDB MaxScale
4229

43-
Information about installing MariaDB MaxScale, either from a repository or by
44-
building from source code, is included in the [MariaDB MaxScale Installation
45-
Guide](../maxscale-management/installation-and-configuration/maxscale-installation-guide.md).
30+
Information about installing MariaDB MaxScale, either from a repository or by building from source code, is included in the [MariaDB MaxScale Installation Guide](../maxscale-management/installation-and-configuration/maxscale-installation-guide.md).
4631

47-
The same guide also provides basic information on running MariaDB MaxScale. More
48-
detailed information about configuring MariaDB MaxScale can be found in the [Configuration Guide](../maxscale-management/deployment/maxscale-configuration-guide.md).
32+
The same guide also provides basic information on running MariaDB MaxScale. More detailed information about configuring MariaDB MaxScale can be found in the [Configuration Guide](../maxscale-management/deployment/maxscale-configuration-guide.md).
4933

5034
<sub>_This page is licensed: CC BY-SA / Gnu FDL_</sub>
5135

maxscale/maxscale-architecture/mariadb-maxscale-overview.md

Lines changed: 11 additions & 28 deletions
Original file line numberDiff line numberDiff line change
@@ -1,8 +1,8 @@
11
---
22
description: >-
3-
Get an overview of MariaDB MaxScale. This section introduces its core
4-
functionalities, including intelligent routing, load balancing, and high
5-
availability, for managing and optimizing deployment.
3+
Get a high-level view of MariaDB MaxScale features. Explore how it handles
4+
load balancing, high availability, and security to optimize your database
5+
infrastructure.
66
---
77

88
# MariaDB MaxScale Overview
@@ -11,40 +11,23 @@ description: >-
1111

1212
MariaDB MaxScale is an advanced proxy, router, and load balancer:
1313

14-
* MaxScale performs automated failover for MariaDB replication. When the primary
15-
server fails, MaxScale promotes a replica to be the new primary and redirects
16-
the remaining replicas to it.
17-
* MaxScale's ReadWriteSplit router performs query-based load balancing.
18-
ReadWriteSplit routes each write statement to the current primary server
19-
and load balances read statements by routing them to the replica servers.
20-
* MaxScale's ReadConnRoute router performs connection-based load balancing.
21-
ReadConnRoute routes each connection to a single primary or replica node,
22-
depending on configuration.
23-
* MaxScale can import data from Kafka and export data into Kafka. MaxScale's
24-
KafkaCDC router streams data from MariaDB database products to a Kafka broker.
25-
MaxScale's KafkaImporter router streams data from Kafka to MariaDB database products.
26-
* MaxScale provides built-in mechanisms to perform server maintenance without
27-
disrupting applications or clients. Servers can be set to maintenance mode
28-
using the command-line interface with MaxCtrl, a web browser with MaxGUI, or REST API.
14+
* MaxScale performs automated failover for MariaDB replication. When the primary server fails, MaxScale promotes a replica to be the new primary and redirects the remaining replicas to it.
15+
* MaxScale's ReadWriteSplit router performs query-based load balancing. ReadWriteSplit routes each write statement to the current primary server and load balances read statements by routing them to the replica servers.
16+
* MaxScale's ReadConnRoute router performs connection-based load balancing. ReadConnRoute routes each connection to a single primary or replica node, depending on configuration.
17+
* MaxScale can import data from Kafka and export data into Kafka. MaxScale's KafkaCDC router streams data from MariaDB database products to a Kafka broker. MaxScale's KafkaImporter router streams data from Kafka to MariaDB database products.
18+
* MaxScale provides built-in mechanisms to perform server maintenance without disrupting applications or clients. Servers can be set to maintenance mode using the command-line interface with MaxCtrl, a web browser with MaxGUI, or REST API.
2919
* MaxScale's Cache filter can improve SELECT performance by caching and reusing results.
30-
* Security and traffic controls for database connections and queries can be implemented
31-
with MaxScale. MaxScale's QLAfilter can be used to create an audit trail by logging
32-
all queries. MaxScale's RegexFilter can also perform audit logging or protect
33-
against SQL injection by matching queries against a regular expression and
34-
performing various actions on the query, such as logging it, modifying it, or
35-
routing it to a specific server.
20+
* Security and traffic controls for database connections and queries can be implemented with MaxScale. MaxScale's QLAfilter can be used to create an audit trail by logging all queries. MaxScale's RegexFilter can also perform audit logging or protect against SQL injection by matching queries against a regular expression and performing various actions on the query, such as logging it, modifying it, or routing it to a specific server.
3621

3722
MariaDB MaxScale can be deployed in the cloud or on-premises.
3823

3924
## Scheduled Releases
4025

41-
MariaDB MaxScale follows the MariaDB Enterprise release schedule, which can be found
42-
[here](../../release-notes/enterprise-server/enterprise-server-release-schedule.md).
26+
MariaDB MaxScale follows the MariaDB Enterprise release schedule, which can be found [here](../../release-notes/enterprise-server/enterprise-server-release-schedule.md).
4327

4428
## Software Releases
4529

46-
The supported MaxScale versions can be found from the latest
47-
[MariaDB Engineering Policy](https://mariadb.com/engineering-policies/).
30+
The supported MaxScale versions can be found in the latest [MariaDB Engineering Policy](https://mariadb.com/engineering-policies/).
4831

4932
<sub>_This page is: Copyright © 2025 MariaDB. All rights reserved._</sub>
5033

0 commit comments

Comments
 (0)