add UI

Signed-off-by: SK Ali Arman <[email protected]>

Author: sheikh-arman

docs/guides/mariadb/clustering/mariadb-replication/examples/maxscale-homepage.png

@@ -315,6 +315,25 @@ pod/sample-mariadb-mx-2   1/1     Running   0          3m9s
 
 ```
 
+## Check the Cluster Status
+
+Now, we are ready to check newly created cluster status. Connect to maxscale pod and run the following commands from any of the maxscale pod and you will get the same result.
+
+```bash
+$ kubectl exec -it -n demo svc/sample-mariadb-mx -- bash
+bash-4.4$ maxctrl list servers
+┌─────────┬─────────────────────────────────────────────────────────────┬──────┬─────────────┬─────────────────┬─────────┬────────────────────┐
+│ Server  │ Address                                                     │ Port │ Connections │ State           │ GTID    │ Monitor            │
+├─────────┼─────────────────────────────────────────────────────────────┼──────┼─────────────┼─────────────────┼─────────┼────────────────────┤
+│ server1 │ sample-mariadb-0.sample-mariadb-pods.demo.svc.cluster.local │ 3306 │ 0           │ Master, Running │ 0-1-125 │ ReplicationMonitor │
+├─────────┼─────────────────────────────────────────────────────────────┼──────┼─────────────┼─────────────────┼─────────┼────────────────────┤
+│ server2 │ sample-mariadb-1.sample-mariadb-pods.demo.svc.cluster.local │ 3306 │ 0           │ Slave, Running  │ 0-1-125 │ ReplicationMonitor │
+├─────────┼─────────────────────────────────────────────────────────────┼──────┼─────────────┼─────────────────┼─────────┼────────────────────┤
+│ server3 │ sample-mariadb-2.sample-mariadb-pods.demo.svc.cluster.local │ 3306 │ 0           │ Slave, Running  │ 0-1-125 │ ReplicationMonitor │
+└─────────┴─────────────────────────────────────────────────────────────┴──────┴─────────────┴─────────────────┴─────────┴────────────────────┘
+
+```
+
 ## Connect with MariaDB database
 
 Once the database is in running state we can conncet to each of three nodes. We will use login credentials `MYSQL_ROOT_USERNAME` and `MYSQL_ROOT_PASSWORD` saved as container's environment variable.
@@ -323,7 +342,7 @@ Once the database is in running state we can conncet to each of three nodes. We
 We recommend using a non-root user for production environments. The root user has extensive privileges, which can pose security risks. Therefore, it is advisable to create a dedicated user with appropriate permissions for production use.
 
 ```bash
-kubectl exec -it -n demo svc/sample-mariadb -- bash
+$ kubectl exec -it -n demo svc/sample-mariadb -- bash
 root@sample-mariadb-0:/ mariadb -u${MYSQL_ROOT_USERNAME} -p${MYSQL_ROOT_PASSWORD}
 Welcome to the MariaDB monitor.  Commands end with ; or \g.
 Your MariaDB connection id is 11
@@ -349,9 +368,10 @@ Bye
 root@sample-mariadb-0:/ exit
 exit
 ```
+## Insert and Query Data using Test User
 
 ```bash
-# First Node
+# Master Node
 $ kubectl exec -it -n demo svc/sample-mariadb -- bash
 root@sample-mariadb-0:/ mariadb -utestuser -ptestpassword
 Welcome to the MariaDB monitor.  Commands end with ; or \g.
@@ -374,7 +394,7 @@ MariaDB [(none)]> quit;
 Bye
 
 
-# Second Node
+# Slave Node
 $ kubectl exec -it -n demo svc/sample-mariadb-standby -- bash
 root@sample-mariadb-1:/ mariadb -utestuser -ptestpassword
 Welcome to the MariaDB monitor.  Commands end with ; or \g.
@@ -396,48 +416,11 @@ MariaDB [(none)]> SELECT 1;
 MariaDB [(none)]> quit;
 Bye
 
-
-# Third Node
-$ kubectl exec -it -n demo sample-mariadb-2 -- bash
-root@sample-mariadb-2:/ mariadb -utestuser -ptestpassword
-Welcome to the MariaDB monitor.  Commands end with ; or \g.
-Your MariaDB connection id is 78
-Server version: 10.5.23-MariaDB-1:10.5.23+maria~focal mariadb.org binary distribution
-
-Copyright (c) 2000, 2018, Oracle, MariaDB Corporation Ab and others.
-
-Type 'help;' or '\h' for help. Type '\c' to clear the current input statement.
-
-MariaDB [(none)]> SELECT 1;
-+---+
-| 1 |
-+---+
-| 1 |
-+---+
-1 row in set (0.000 sec)
-
 MariaDB [(none)]> quit;
 Bye
 ```
 
-## Check the Cluster Status
-
-Now, we are ready to check newly created cluster status. Connect to maxscale pod and run the following commands from any of the maxscale pod and you will get the same result.
-
-```bash
-$ kubectl exec -it -n demo sample-mariadb-mx-0 -- bash
-bash-4.4$ maxctrl list servers
-┌─────────┬─────────────────────────────────────────────────────────────┬──────┬─────────────┬─────────────────┬─────────┬────────────────────┐
-│ Server  │ Address                                                     │ Port │ Connections │ State           │ GTID    │ Monitor            │
-├─────────┼─────────────────────────────────────────────────────────────┼──────┼─────────────┼─────────────────┼─────────┼────────────────────┤
-│ server1 │ sample-mariadb-0.sample-mariadb-pods.demo.svc.cluster.local │ 3306 │ 0           │ Master, Running │ 0-1-125 │ ReplicationMonitor │
-├─────────┼─────────────────────────────────────────────────────────────┼──────┼─────────────┼─────────────────┼─────────┼────────────────────┤
-│ server2 │ sample-mariadb-1.sample-mariadb-pods.demo.svc.cluster.local │ 3306 │ 0           │ Slave, Running  │ 0-1-125 │ ReplicationMonitor │
-├─────────┼─────────────────────────────────────────────────────────────┼──────┼─────────────┼─────────────────┼─────────┼────────────────────┤
-│ server3 │ sample-mariadb-2.sample-mariadb-pods.demo.svc.cluster.local │ 3306 │ 0           │ Slave, Running  │ 0-1-125 │ ReplicationMonitor │
-└─────────┴─────────────────────────────────────────────────────────────┴──────┴─────────────┴─────────────────┴─────────┴────────────────────┘
 
-```
 
 ## Data Availability
 
@@ -802,9 +785,27 @@ MariaDB [playground]> SELECT * FROM test_db.t1;
 
 # write query is only running on master node.
 ```
-
 We can see the queries are successfully executed through the Maxscale Proxy server and read write split is working as expected.
 
+## Access and Explore the MaxScale UI
+To enable the MaxScale UI, set `spec.topology.maxscale.enableUI: true` in the configuration. The MaxScale UI runs on port 8989. To access it, use the following kubectl command to forward the port:
+
+```bash
+➤ kubectl port-forward -n demo service/sample-mariadb-mx 8989:8989
+Forwarding from 127.0.0.1:8989 -> 8989
+Forwarding from [::1]:8989 -> 8989
+```
+
+The MaxScale UI is accessible at http://127.0.0.1:8989.
+
+Use the default credentials to log in:
+- Username: admin
+- Password: mariadb
+
+After logging in, you will be greeted by an intuitive dashboard showcasing servers list and current node state.
+
+![Maxscale Dashboard](/docs/guides/mariadb/clustering/mariadb-replication/examples/maxscale-homepage.png)
+
 ## Cleaning up
 
 Clean what we created in this tutorial.

docs/guides/mariadb/clustering/mariadb-replication/index.md

@@ -14,13 +14,16 @@ section_menu_id: guides
 
 # MariaDB Clustering
 
-KubeDB currently supports two cluster modes: Multi-Master MariaDB Galera Cluster and Master-Slave MariaDB Standard Replication.
+KubeDB supports two primary clustering modes for MariaDB: Multi-Master MariaDB Galera Cluster and Master-Slave MariaDB Standard Replication. Below, we explore key concepts of these clustering approaches, highlighting their mechanisms, benefits, and use cases in a distributed database environment.
 
-Here we'll discuss some concepts about Cluster.
+Below, we explore key concepts of MariaDB clustering, focusing on the two clustering modes supported by KubeDB: Multi-Master MariaDB Galera Cluster and Master-Slave MariaDB Standard Replication
 
-## So What is Replication
+## What is Replication
 
-Replication involves copying data from one MariaDB server to one or more other MariaDB servers, rather than storing it on a single server. The replication mode determines read and write capabilities. In a multi-master setup, you can perform read and write operations on any server. In a master and slave architecture, read and write operations are supported on the master host, while slave hosts support only read operations.
+Replication in MariaDB involves duplicating data from one MariaDB server (the source) to one or more other MariaDB servers (replicas), rather than storing it on a single server. This process enhances data availability, scalability, and fault tolerance. The replication mode determines the read and write capabilities of each server in the cluster. MariaDB supports two primary replication architectures: multi-master and master-slave.
+
+- Multi-Master Replication: In a multi-master setup, every server in the cluster can handle both read and write operations. This architecture, exemplified by the MariaDB Galera Cluster, ensures high availability and scalability by allowing applications to distribute workloads across all nodes.
+- Master-Slave Replication: In a master-slave architecture, the master server supports both read and write operations, while slave servers are limited to read operations. This setup is ideal for read-heavy workloads, with slaves providing scalability for queries and serving as backups.
 
 The following figure shows a cluster of four MariaDB servers of multi-master replication:
 
@@ -52,7 +55,7 @@ There are some limitations in MariaDB Galera Cluster that are listed [here](http
 
 ## MariaDB Standard Replication
 
-MariaDB Standard Replication is a widely used mechanism for copying data from one MariaDB server (the master) to one or more other MariaDB servers (the slaves). This replication mode ensures data redundancy, enhances availability, and supports read scalability by distributing read operations across multiple servers. It operates in a single-master and slave architecture, where the master server handles both read and write operations, while slave servers are limited to read operations.
+MariaDB Standard Replication is a widely used mechanism for copying data from one MariaDB server (master) to one or more other MariaDB servers (slave). This replication mode ensures data redundancy, enhances availability, and supports read scalability by distributing read operations across multiple servers. It operates in a single-master and slave architecture, where the master server handles both read and write operations, while slave servers are limited to read operations.
 
 Ref: [About MariadDB Standard Replication](https://mariadb.com/kb/en/replication-overview/#standard-replication)
 
@@ -65,7 +68,7 @@ Ref: [About MariadDB Standard Replication](https://mariadb.com/kb/en/replication
 - Active-passive single-master topology
 - Read and write to master, and read only to slave node
 - Automatic node joining
-- Automatic failover using maxscale proxy
+- Automatic failover using Maxscale Proxy Server
 - Binary Log-Based replication
 - Direct client connections, native MariaDB look & feel
 - Load Balance using Maxscale Proxy Server