From e72d947e6868c1e1cca160ea7ca0d51c394a3eab Mon Sep 17 00:00:00 2001 From: Martin Montes Date: Thu, 8 Feb 2024 12:31:55 +0100 Subject: [PATCH] Intro section --- docs/HA.md | 4 +++- docs/MAXSCALE.md | 8 ++++++-- 2 files changed, 9 insertions(+), 3 deletions(-) diff --git a/docs/HA.md b/docs/HA.md index c2d9cd29..42f7335b 100644 --- a/docs/HA.md +++ b/docs/HA.md @@ -13,4 +13,6 @@ Whenever the primary changes, either by the user or by the operator, both the `< The primary may be manually changed by the user at any point by updating the `spec.[replication|galera].primary.podIndex` field. Alternatively, automatic primary failover can be enabled by setting `spec.[replication|galera].primary.automaticFailover`, which will make the operator to switch primary whenever the primary `Pod` goes down. -Although using the Kubernetes services for addressing the primary and secondary works, the most highly available setup we can offer relies on [MaxScale](https://mariadb.com/docs/server/products/mariadb-maxscale/), our advanced database proxy. Please take a look at the [MaxScale docs](./MAXSCALE.md). \ No newline at end of file +## MaxScale + +While Kubernetes services can be utilized to dynamically address primary and secondary instances, the most robust high availability configuration we recommend relies on [MaxScale](https://mariadb.com/docs/server/products/mariadb-maxscale/). Please refer to [MaxScale docs](./MAXSCALE.md) for further details. \ No newline at end of file diff --git a/docs/MAXSCALE.md b/docs/MAXSCALE.md index 8f473f7d..b44da266 100644 --- a/docs/MAXSCALE.md +++ b/docs/MAXSCALE.md @@ -3,9 +3,13 @@ > [!WARNING] > This documentation applies to `mariadb-operator` version >= v0.0.25 -## MaxScale docs +MaxScale is a sophisticated database proxy, router, and load balancer designed specifically for MariaDB. It provides a range of features that ensure optimal high availability: +- Query based routing: Transparently route write queries to the primary nodes and read queries to the replica nodes. +- Connection based routing: Load balance connection between multiple servers. +- Automatic primary failover based on MariaDB internals. +- Replay pending transactions when a server goes down. -https://mariadb.com/kb/en/maxscale/ +To better understand what MaxScale is capable of you may check the [product page](https://mariadb.com/docs/server/products/mariadb-maxscale/) and the [documentation](https://mariadb.com/kb/en/maxscale/). ## MaxScale resources