Chapter 1. Using MariaDB
The MariaDB server is an open source fast and robust database server that is based on the MySQL technology. MariaDB is a relational database that converts data into structured information and provides an SQL interface for accessing data. It includes multiple storage engines and plugins, as well as geographic information system (GIS), and JavaScript Object Notation (JSON) features.
Learn how to install and configure MariaDB on a RHEL system, how to back up MariaDB data, how to migrate from an earlier MariaDB version, and how to replicate a database by using the MariaDB Galera Cluster.
1.1. Installing MariaDB
RHEL 10 provides MariaDB 10.11 as the initial version of the Application Stream, which can be installed easily as an RPM package. Additional MariaDB versions are provided as modules with a shorter life cycle in minor releases of RHEL 10.
By design, you can install only one version (stream) of the same module and, because of conflicting RPM packages, you cannot install MariaDB and MySQL on the same host. As an alternative, you can run the database server services in a container.
Procedure
Install MariaDB server packages:
# dnf install mariadb-server
Enable and start the
mariadb
service:# systemctl enable --now mariadb.service
1.2. Configuring network access to MariaDB
If clients in your network need to access the MariaDB server remotely, you must configure the MariaDB service to listen on the corresponding interfaces.
Procedure
Edit the
[mysqld]
section of the/etc/my.cnf.d/mariadb-server.cnf
file. You can set the following configuration directives:bind-address
- is the address on which the server listens. Possible options are:- a host name
- an IPv4 address
- an IPv6 address
skip-networking
- controls whether the server listens for TCP/IP connections. Possible values are:- 0 - to listen for all clients
- 1 - to listen for local clients only
-
port
- the port on which MariaDB listens for TCP/IP connections.
To ensure that clients can access the database server on the network, open the port in the firewall:
# firewall-cmd --permanent --add-service=mysql # firewall-cmd --reload
Restart the
mariadb
service:# systemctl restart mariadb.service
1.3. Setting up TLS encryption on a MariaDB server
By default, MariaDB uses unencrypted connections. For secure connections, enable TLS support on the MariaDB server and configure your clients to establish encrypted connections.
1.3.1. Placing the CA certificate, server certificate, and private key on the MariaDB server
Before you can enable TLS encryption in the MariaDB server, store the certificate authority (CA) certificate, the server certificate, and the private key on the MariaDB server.
Prerequisites
The following files in Privacy Enhanced Mail (PEM) format have been copied to the server:
-
The private key of the server:
server.example.com.key.pem
-
The server certificate:
server.example.com.crt.pem
-
The Certificate Authority (CA) certificate:
ca.crt.pem
For details about creating a private key and certificate signing request (CSR), as well as about requesting a certificate from a CA, see your CA’s documentation.
-
The private key of the server:
Procedure
Store the CA and server certificates in the
/etc/pki/tls/certs/
directory:# mv <path>/server.example.com.crt.pem /etc/pki/tls/certs/ # mv <path>/ca.crt.pem /etc/pki/tls/certs/
Set permissions on the CA and server certificate that enable the MariaDB server to read the files:
# chmod 644 /etc/pki/tls/certs/server.example.com.crt.pem /etc/pki/tls/certs/ca.crt.pem
Because certificates are part of the communication before a secure connection is established, any client can retrieve them without authentication. Therefore, you do not need to set strict permissions on the CA and server certificate files.
Store the server’s private key in the
/etc/pki/tls/private/
directory:# mv <path>/server.example.com.key.pem /etc/pki/tls/private/
Set secure permissions on the server’s private key:
# chmod 640 /etc/pki/tls/private/server.example.com.key.pem # chgrp mysql /etc/pki/tls/private/server.example.com.key.pem
If unauthorized users have access to the private key, connections to the MariaDB server are no longer secure.
Restore the SELinux context:
# restorecon -Rv /etc/pki/tls/
1.3.2. Configuring TLS on a MariaDB server
To improve security, enable TLS support on the MariaDB server. As a result, clients can transmit data with the server by using TLS encryption.
Prerequisites
- You installed the MariaDB server.
-
The
mariadb
service is running. The following files in Privacy Enhanced Mail (PEM) format exist on the server and are readable by the
mysql
user:-
The private key of the server:
/etc/pki/tls/private/server.example.com.key.pem
-
The server certificate:
/etc/pki/tls/certs/server.example.com.crt.pem
-
The Certificate Authority (CA) certificate
/etc/pki/tls/certs/ca.crt.pem
-
The private key of the server:
- The subject distinguished name (DN) or the subject alternative name (SAN) field in the server certificate matches the server’s host name.
- If the FIPS mode is enabled, clients must either support the Extended Master Secret (EMS) extension or use TLS 1.3. TLS 1.2 connections without EMS fail. For more information, see the Red Hat Knowledgebase solution TLS extension "Extended Master Secret" enforced enforced on RHEL 9.2 and later.
Procedure
Create the
/etc/my.cnf.d/mariadb-server-tls.cnf
file:Add the following content to configure the paths to the private key, server and CA certificate:
[mariadb] ssl_key = /etc/pki/tls/private/server.example.com.key.pem ssl_cert = /etc/pki/tls/certs/server.example.com.crt.pem ssl_ca = /etc/pki/tls/certs/ca.crt.pem
If you have a Certificate Revocation List (CRL), configure the MariaDB server to use it:
ssl_crl = /etc/pki/tls/certs/example.crl.pem
Optional: Reject connection attempts without encryption. To enable this feature, append:
require_secure_transport = on
Optional: Set the TLS versions the server should support. For example, to support TLS 1.2 and TLS 1.3, append:
tls_version = TLSv1.2,TLSv1.3
By default, the server supports TLS 1.1, TLS 1.2, and TLS 1.3.
Restart the
mariadb
service:# systemctl restart mariadb
Verification
To simplify troubleshooting, perform the following steps on the MariaDB server before you configure the local client to use TLS encryption:
Verify that MariaDB now has TLS encryption enabled:
# mysql -u root -p -e "SHOW GLOBAL VARIABLES LIKE 'have_ssl';" +---------------+-----------------+ | Variable_name | Value | +---------------+-----------------+ | have_ssl | YES | +---------------+-----------------+
If the
have_ssl
variable is set toyes
, TLS encryption is enabled.If you configured the MariaDB service to only support specific TLS versions, display the
tls_version
variable:# mysql -u root -p -e "SHOW GLOBAL VARIABLES LIKE 'tls_version';" +---------------+-----------------+ | Variable_name | Value | +---------------+-----------------+ | tls_version | TLSv1.2,TLSv1.3 | +---------------+-----------------+
1.3.3. Requiring TLS encrypted connections for specific user accounts on a MariaDB server
Users that have access to sensitive data should always use a TLS-encrypted connection to avoid sending data unencrypted over the network.
If you cannot configure on the server that a secure transport is required for all connections (require_secure_transport = on
), configure individual user accounts to require TLS encryption.
Prerequisites
- The MariaDB server has TLS support enabled.
- The user you configure to require secure transport exists.
Procedure
Connect as an administrative user to the MariaDB server:
# mysql -u root -p -h server.example.com
If your administrative user has no permissions to access the server remotely, perform the command on the MariaDB server and connect to
localhost
.Use the
REQUIRE SSL
clause to enforce that a user must connect by using a TLS-encrypted connection:MariaDB [(none)]> ALTER USER 'example'@'%' REQUIRE SSL;
Verification
Connect to the server as the
example
user by using TLS encryption:# mysql -u example -p -h server.example.com --ssl ... MariaDB [(none)]>
If no error is shown and you have access to the interactive MariaDB console, the connection with TLS succeeds.
Attempt to connect as the
example
user with TLS disabled:# mysql -u example -p -h server.example.com --skip-ssl ERROR 1045 (28000): Access denied for user 'example'@'server.example.com' (using password: YES)
The server rejected the login attempt because TLS is required for this user but disabled (
--skip-ssl
).
1.4. Configuring the MariaDB client to use TLS encryption by default
On RHEL, you can globally configure that the MariaDB client uses TLS encryption and verifies that the Common Name (CN) in the server certificate matches the hostname the user connects to. This prevents man-in-the-middle attacks.
Prerequisites
- The MariaDB server has TLS support enabled.
- If the certificate authority (CA) that issued the server’s certificate is not trusted by RHEL, the CA certificate has been copied to the client.
- If the FIPS mode is enabled, this client supports the Extended Master Secret (EMS) extension or uses TLS 1.3. TLS 1.2 connections without EMS fail. For more information, see the Red Hat Knowledgebase solution TLS extension "Extended Master Secret" enforced on RHEL 9.2 and later.
Procedure
If RHEL does not trust the CA that issued the server’s certificate:
Copy the CA certificate to the
/etc/pki/ca-trust/source/anchors/
directory:# cp <path>/ca.crt.pem /etc/pki/ca-trust/source/anchors/
Set permissions that enable all users to read the CA certificate file:
# chmod 644 /etc/pki/ca-trust/source/anchors/ca.crt.pem
Rebuild the CA trust database:
# update-ca-trust
Create the
/etc/my.cnf.d/mariadb-client-tls.cnf
file with the following content:[client-mariadb] ssl ssl-verify-server-cert
These settings define that the MariaDB client uses TLS encryption (
ssl
) and that the client compares the hostname with the CN in the server certificate (ssl-verify-server-cert
).
Verification
Connect to the server by using the hostname, and display the server status:
# mysql -u root -p -h server.example.com -e status ... SSL: Cipher in use is TLS_AES_256_GCM_SHA384
If the
SSL
entry containsCipher in use is…
, the connection is encrypted.Note that the user you use in this command has permissions to authenticate remotely.
If the hostname you connect to does not match the hostname in the TLS certificate of the server, the
ssl-verify-server-cert
parameter causes the connection to fail. For example, if you connect tolocalhost
:# mysql -u root -p -h localhost -e status ERROR 2026 (HY000): SSL connection error: Validation of SSL server certificate failed
1.5. Backing up MariaDB data
There are two main ways to back up data from a MariaDB database:
- Logical backup
A logical backup consists of the SQL statements necessary to restore the data. This type of backup exports information and records in plain text files.
The main advantage of logical backup over physical backup is portability and flexibility. The data can be restored on other hardware configurations, MariaDB versions or Database Management System (DBMS), which is not possible with physical backups.
Note that a logical backup can only be performed if the
mariadb.service
is running. Logical backup does not include log and configuration files.- Physical backup
A physical backup consists of copies of files and directories that store the content.
Physical backup has the following advantages compared to logical backup:
- Output is more compact.
- Backup is smaller in size.
- Backup and restore are faster.
Backup includes log and configuration files.
Note that physical backup must be performed when the
mariadb.service
is not running or all tables in the database are locked to prevent changes during the backup.
You can use one of the following MariaDB backup approaches to back up data from a MariaDB database:
-
Logical backup with
mariadb-dump
-
Physical online backup by using the
Mariabackup
utility - File system backup
- Replication as a backup solution
1.5.1. Performing logical backup with mariadb-dump
The mariadb-dump
client is a backup utility, which can be used to dump a database or a collection of databases for the purpose of a backup or transfer to another database server. The output of mariadb-dump
typically consists of SQL statements to re-create the server table structure, populate it with data, or both. mariadb-dump
can also generate files in other formats, including XML and delimited text formats, such as CSV.
To perform the mariadb-dump
backup, you can use one of the following options:
- Back up one or more selected databases
- Back up all databases
- Back up a subset of tables from one database
Procedure
To dump a single database, run:
# mariadb-dump [options] --databases db_name > backup-file.sql
To dump multiple databases at once, run:
# mariadb-dump [options] --databases db_name1 [db_name2 ...] > backup-file.sql
To dump all databases, run:
# mariadb-dump [options] --all-databases > backup-file.sql
To load one or more dumped full databases back into a server, run:
# mariadb < backup-file.sql
To load a database to a remote MariaDB server, run:
# mariadb --host=remote_host < backup-file.sql
To dump a subset of tables from one database, add a list of the chosen tables at the end of the
mariadb-dump
command:# mariadb-dump [options] db_name [tbl_name ...] > backup-file.sql
To load a subset of tables dumped from one database, run:
# mariadb db_name < backup-file.sql
NoteThe db_name database must exist at this point.
To see a list of the options that mariadb-dump supports, run:
$ mariadb-dump --help
Additional resources
1.5.2. Performing physical online backup by using the mariabackup
utility
The mariabackup
utility is based on the Percona XtraBackup technology, which enables performing physical online backups of InnoDB, Aria, and MyISAM tables. The utility supports full backup capability for MariaDB server, which includes encrypted and compressed data.
Prerequisites
-
The
mariadb-backup
package is installed on the system: -
You must provide
mariabackup
with credentials for the user under which the backup will be run. You can provide the credentials either on the command line or by a configuration file. -
Users of
mariabackup
must have theRELOAD
,LOCK TABLES
, andREPLICATION CLIENT
privileges.
Procedure
Use one of the following options to create a backup:
To create a backup while providing credentials on the command line, enter:
$ mariabackup --backup --target-dir <backup_directory> --user <backup_user> --password <backup_passwd>
The
target-dir
option defines the directory where the backup files are stored. If you want to perform a full backup, the target directory must be empty or not exist.The
user
andpassword
options allow you to configure the user name and the password.To create a backup with credentials set in a configuration file:
-
Create a configuration file in the
/etc/my.cnf.d/
directory, for example,/etc/my.cnf.d/mariabackup.cnf
. Add the following content to the file:
[mysqld] user=<backup_username> password=<password>
Perform the backup:
$ mariabackup --backup --target-dir <backup_directory>
-
Create a configuration file in the
Additional resources
1.5.3. Restoring data by using the mariabackup
utility
If you have a MariaDB backup created by the mariabackup
utility, you can use the same utility to restore the data.
Prerequisites
-
The
mariadb
service is stopped. - The data directory is empty.
-
Users of
mariabackup
must have theRELOAD
,LOCK TABLES
, andREPLICATION CLIENT
privileges.
Procedure
Use one of the following options to restore the data:
To restore data from the backup in the
/var/mariadb/backup/
directory and keep the original backup files, enter:$ mariabackup --copy-back --target-dir=/var/mariadb/backup/
To restore data from the backup in the
/var/mariadb/backup/
directory and remove the original backup files, enter:$ mariabackup --move-back --target-dir=/var/mariadb/backup/
Fix the file permissions. For example, to recursively change ownership of the files to the
mysql
user and group, enter:# chown -R mysql:mysql /var/lib/mysql/
When restoring a database,
mariabackup
preserves the file and directory privileges of the backup. However,mariabackup
writes the files to disk as the user and group restoring the database. Therefore, after restoring a backup, you must adjust the owner of the data directory to match the user and group for the MariaDB server.Start the
mariadb
service:# systemctl start mariadb.service
Additional resources
1.5.4. Performing a file system backup on a MariaDB server
To create a file system backup of MariaDB data files, copy the content of the MariaDB data directory to your backup location.
To back up also your current configuration or the log files, use the optional steps of the following procedure.
Procedure
Stop the
mariadb
service:# systemctl stop mariadb.service
Copy the data files:
# cp -rp /var/lib/mysql/ /backup-location/data/
Copy the configuration files:
# cp -rp /etc/my.cnf /etc/my.cnf.d/ /backup-location/configuration/
Optional: Copy the log files:
# cp -p /var/log/mariadb/* /backup-location/logs/
Start the
mariadb
service:# systemctl start mariadb.service
When loading the backed up data from the backup location to the
/var/lib/mysql
directory, ensure thatmysql:mysql
is an owner of all data in/var/lib/mysql
:# chown -R mysql:mysql /var/lib/mysql/
1.5.5. Replication as a backup solution
If a source server replicates to a replica server, backups can be run on the replica without any impact on the source. The source can still run while you shut down the replica and back the data up from the replica.
Replication itself is not a sufficient backup solution. Replication protects source servers against hardware failures, but it does not ensure protection against data loss.
Additional resources
1.6. Replicating MariaDB with Galera
You can replicate a MariaDB database by using the Galera solution on Red Hat Enterprise Linux.
1.6.1. Introduction to MariaDB Galera Cluster
Galera replication is based on the creation of a synchronous multi-source MariaDB Galera Cluster consisting of multiple MariaDB servers. Unlike the traditional primary/replica setup where replicas are usually read-only, nodes in the MariaDB Galera Cluster can be all writable.
The interface between Galera replication and a MariaDB database is defined by the write set replication API (wsrep API).
The main features of MariaDB Galera Cluster are:
- Synchronous replication
- Active-active multi-source topology
- Read and write to any cluster node
- Automatic membership control, failed nodes drop from the cluster
- Automatic node joining
- Parallel replication on row level
- Direct client connections: users can log on to the cluster nodes, and work with the nodes directly while the replication runs
Synchronous replication means that a server replicates a transaction at commit time by broadcasting the write set associated with the transaction to every node in the cluster. The client (user application) connects directly to the Database Management System (DBMS), and experiences behavior that is similar to native MariaDB.
Synchronous replication guarantees that a change that happened on one node in the cluster happens on other nodes in the cluster at the same time.
Therefore, synchronous replication has the following advantages over asynchronous replication:
- No delay in propagation of the changes between particular cluster nodes
- All cluster nodes are always consistent
- The latest changes are not lost if one of the cluster nodes crashes
- Transactions on all cluster nodes are executed in parallel
- Causality across the whole cluster
1.6.2. Components to build MariaDB Galera Cluster
To build MariaDB Galera Cluster, you must install the following packages on your system:
-
mariadb-server-galera
- contains support files and scripts for MariaDB Galera Cluster. -
mariadb-server
- is patched by MariaDB upstream to include the write set replication API (wsrep API). This API provides the interface between Galera replication and MariaDB. galera
- is patched by MariaDB upstream to add full support for MariaDB. Thegalera
package contains the following:- Galera Replication Library provides the whole replication functionality.
- The Galera Arbitrator utility can be used as a cluster member that participates in voting in split-brain scenarios. However, Galera Arbitrator cannot participate in the actual replication.
-
Galera Systemd service and Galera wrapper script which are used for deploying the Galera Arbitrator utility. RHEL 10 provides the upstream version of these files, located at
/usr/lib/systemd/system/garbd.service
and/usr/sbin/garb-systemd
.
Additional resources
1.6.3. Deploying MariaDB Galera Cluster
You can deploy the MariaDB Galera Cluster packages and update the configuration. To form a new cluster, you must bootstrap the first node of the cluster.
Prerequisites
- All of the nodes in the cluster have TLS set up.
All certificates on all nodes must have the
Extended Key Usage
field set to:TLS Web Server Authentication, TLS Web Client Authentication
Procedure
Install the MariaDB Galera Cluster packages:
# dnf install mariadb-server-galera
As a result, the following packages are installed together with their dependencies:
-
mariadb-server-galera
-
mariadb-server
galera
For more information about these packages required to build MariaDB Galera Cluster, see Components to build MariaDB Cluster.
-
Update the MariaDB server replication configuration before the system is added to a cluster for the first time. The default configuration is distributed in the
/etc/my.cnf.d/galera.cnf
file. Before deploying MariaDB Galera Cluster, set thewsrep_cluster_address
option in the/etc/my.cnf.d/galera.cnf
file on all nodes to start with the following string:gcomm://
For the initial node, it is possible to set
wsrep_cluster_address
as an empty list:wsrep_cluster_address="gcomm://"
For all other nodes, set
wsrep_cluster_address
to include an address to any node which is already a part of the running cluster. For example:wsrep_cluster_address="gcomm://10.0.0.10"
For more information about how to set Galera Cluster address, see Galera Cluster Address.
-
Enable the
wsrep
API on every node by setting thewsrep_on=1
option in the/etc/my.cnf.d/galera.cnf
configuration file. Add the
wsrep_provider_options
variable to the Galera configuration file with the TLS keys and certificates. For example:wsrep_provider_options="socket.ssl_cert=/etc/pki/tls/certs/source.crt;socket.ssl_key=/etc/pki/tls/private/source.key;socket.ssl_ca=/etc/pki/tls/certs/ca.crt”
Bootstrap a first node of a new cluster by running the following wrapper on that node:
# galera_new_cluster
This wrapper ensures that the MariaDB server daemon (
mariadbd
) runs with the--wsrep-new-cluster
option. This option provides the information that there is no existing cluster to connect to. Therefore, the node creates a new UUID to identify the new cluster.NoteThe
mariadb
service supports a systemd method for interacting with multiple MariaDB server processes. Therefore, in cases with multiple running MariaDB servers, you can bootstrap a specific instance by specifying the instance name as a suffix:# galera_new_cluster mariadb@node1
Connect other nodes to the cluster by running the following command on each of the nodes:
# systemctl start mariadb
As a result, the node connects to the cluster, and synchronizes itself with the state of the cluster.
Additional resources
1.6.4. Adding a new node to MariaDB Galera Cluster
To add a new node to MariaDB Galera Cluster, use the following procedure.
Note that you can also use this procedure to reconnect an already existing node.
Procedure
On the particular node, provide an address to one or more existing cluster members in the
wsrep_cluster_address
option within the[mariadb]
section of the/etc/my.cnf.d/galera.cnf
configuration file :[mariadb] wsrep_cluster_address="gcomm://192.168.0.1"
When a new node connects to one of the existing cluster nodes, it is able to see all nodes in the cluster.
However, preferably list all nodes of the cluster in
wsrep_cluster_address
.As a result, any node can join a cluster by connecting to any other cluster node, even if one or more cluster nodes are down. When all members agree on the membership, the cluster’s state is changed. If the new node’s state is different from the state of the cluster, the new node requests either an Incremental State Transfer (IST) or a State Snapshot Transfer (SST) to ensure consistency with the other nodes.
1.6.5. Restarting MariaDB Galera Cluster
If you shut down all nodes at the same time, you stop the cluster, and the running cluster no longer exists. However, the cluster’s data still exist.
To restart the cluster, bootstrap a first node as described in Deploying MariaDB Galera Cluster
If the cluster is not bootstrapped, and mariadb
on the first node is started with only the systemctl start mariadb
command, the node tries to connect to at least one of the nodes listed in the wsrep_cluster_address
option in the /etc/my.cnf.d/galera.cnf
file. If no nodes are currently running, the restart fails.
Additional resources