Quickstart Guide

Prepare a machine for Enterprise Manager installation

Machine requirements (minimal hardware resources for evaluation):

• CPU: 2 cores (or 2 vCPUs) with x86-64 or ARM64 architecture

• RAM: 4 GB

• Storage: 100 GB

Other requirements:

• 64-bit Linux OS with either of the supported container engines

  • Docker with Docker Compose https://docs.docker.com/engine/install

  • Podman with Podman Compose

    • The podman-docker compatibility package is required to enable the docker CLI for Podman. All commands in this guide documented for Docker work similarly with Podman.

• Network ports 8090 and 4318 opened for inbound traffic

Obtain MariaDB Customer Download Token

1. Navigate to the Customer Download Token at the MariaDB Customer Portal

2. Log in using your MariaDB ID

3. Copy the Customer Download Token — you will use it as the password when logging in to the MariaDB Enterprise Docker Registry

Setup MariaDB Enterprise Repository - "MariaDB Enterprise Tools"

Set up the repository for each monitored MariaDB Server and MaxScale

Login to the MariaDB Enterprise Docker Registry

Use your MariaDB ID as username and Customer Download Token as password.

• Docker:

docker login docker.mariadb.com

• Podman:

podman login --compat-auth-file .docker/config.json docker.mariadb.com

Download the installer

Insert your Customer Download Token into the download URL and download the installer:

wget https://dlm.mariadb.com/<Customer_Download_Token>/enterprise-release-helpers/install-enterprise-manager.sh

Make the installer executable

chmod +x install-enterprise-manager.sh

Run the installer with default options

./install-enterprise-manager.sh

Access Enterprise Manager UI

Open in a browser:

https://<Enterprise_Manager_IP>:8090

At the login screen, use the default username admin and the generated password displayed after the installation finishes.

Create monitoring user for each MariaDB Server (Enterprise Manager access)

Run on each MariaDB server (replace <Enterprise_Manager_IP> ):

CREATE USER 'monitor'@'<Enterprise_Manager_IP>' IDENTIFIED BY '<password>';
GRANT REPLICA MONITOR ON *.* TO 'monitor'@'<Enterprise_Manager_IP>';

Add database topology in Enterprise Manager UI

Add each MariaDB Server in the Enterprise Manager UI, providing access details for each server.

Install agent on each MariaDB Server to enable metrics collection

On each MariaDB server install the mema-agent package.

• RedHat-based (RHEL, CentOS, Rocky Linux):

sudo yum install -y mema-agent

• Debian-based (Ubuntu, Debian):

sudo apt install -y mema-agent

Create monitoring user for agent access (on each MariaDB Server)

Run on each MariaDB server:

CREATE USER 'monitor'@'localhost' IDENTIFIED BY '<password>';
GRANT PROCESS, BINLOG MONITOR, REPLICA MONITOR, REPLICATION MASTER ADMIN ON *.* TO 'monitor'@'localhost';

Setup agent using the command generated in Enterprise Manager UI

1. In the UI, click the three dots beside the server you want to install the Agent on.

   
2. The UI will generate a unique setup command for that specific server with the username and password you provide.

3. Copy and run the command on that specific server.

4. Repeat for all servers in the database fleet.

   

Wait for metrics to appear

Wait 1–2 minutes for metrics to start populating in Enterprise Manager from the agents (default collection interval is 1 minute).

Add MaxScale instances to Enterprise Manager

Add each MaxScale instance in the Enterprise Manager UI, providing access details.

Install agent on each MaxScale and MariaDB Server

On each MaxScale and each MariaDB server install the mema-agent package.

• RedHat-based (RHEL, CentOS, Rocky Linux):

• Debian-based (Ubuntu, Debian):

Create monitoring user for agent access (on each MariaDB Server)

Run on each MariaDB server:

Setup agent using the command generated in Enterprise Manager UI

1. Click the three dots beside the server or MaxScale instance you want to install the Agent on and click Metrics configuration.

2. The UI will generate a unique setup command for that specific server/MaxScale instance with the username and password you provide. Copy the command.

3. On that specific server/MaxScale instance, paste and run the command in your terminal.

4. Repeat for all MaxScale and MariaDB servers.

Wait for metrics to appear

Wait 1–2 minutes for metrics to start populating in Enterprise Manager from the agents (default collection interval is 1 minute).