Install MariaDB Agent Manager using a Binary Tarball

Overview

The MariaDB Agent Manager coordinates deployment of the agents needed to consolidate and push data to the Remote Observability Service.

MariaDB Agent Manager transmits monitoring metrics and topology status data to the Remote Observability Service.

MariaDB Agent Manager can be installed using a binary tarball.

Compatibility

MariaDB Products

  • MariaDB Enterprise ColumnStore 5

  • MariaDB Enterprise ColumnStore 6

  • MariaDB Enterprise Server 10.3

  • MariaDB Enterprise Server 10.4

  • MariaDB Enterprise Server 10.5

  • MariaDB Enterprise Server 10.6

  • MariaDB MaxScale 2.4

  • MariaDB MaxScale 2.5

  • MariaDB MaxScale 6

  • MariaDB Xpand 5.3

  • MariaDB Xpand 6

Operating Systems

  • CentOS 7

  • Red Hat Enterprise Linux 7

  • Red Hat Enterprise Linux 8

  • Rocky Linux 8

  • Ubuntu 18.04 LTS

  • Ubuntu 20.04 LTS

  • Ubuntu 22.04 LTS

Step 1: Switch to Dedicated OS User

For security purposes, MariaDB does not recommend running MariaDB Agent Manager as root.

On each Forwarding Host and Monitored Host, if you created a dedicated user account and group for MariaDB Agent Manager, switch to a shell using the dedicated user account:

$ su -l mariadbagent

Each of the subsequent steps in this procedure should be performed using this dedicated user account.

Step 2: Download Agent Manager

On each Forwarding Host and Monitored Host, MariaDB Agent Manager must be downloaded.

This step shows how to download MariaDB Agent Manager using your web browser. For alternative details on how to download MariaDB Agent Manager via command-line interface, see "Alternative: Download Agent Manager via CLI".

Perform the following steps:

  1. Download the MariaDB Agent Manager binary tarball.

  2. Copy the binary tarball to each host.

  3. On each host, extract the files from the binary tarball:

    $ tar -xvzf mariadb-agent-manager-for-pdc-1.2.0.linux-amd64.tar.gz
    $ cd mariadb-agent-manager-for-pdc-1.2.0.linux-amd64
    

Step 3: Install MariaDB Agent Manager

On each Forwarding Host and Monitored Host, MariaDB Agent Manager must be installed by executing the mariadb_agent_manager install sub-command:

$ ./mariadb_agent_manager install

As part of the installation process, the MariaDB Agent Manager components are copied to the installation directories.

Alternative: Download Agent Manager via CLI

For users who don't want to download MariaDB Agent Manager via their browser, MariaDB Corporation customers can download MariaDB Agent Manager via command-line interface with their Customer Download Token.

Retrieve Customer Download Token

MariaDB Corporation customers can retrieve their Customer Download Token through the MariaDB Customer Portal.

Note

MariaDB Corporation's Customer Download Tokens are customer-specific. Protect the token as you would any security credential.

To retrieve the Customer Download Token for your account:

  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.

Download Binary Tarball via CLI

MariaDB Corporation provides an interface to download binary files using command-line tools or automation.

Binary files can be downloaded using command-line tools or automation from the MariaDB Download interface with the Customer Download Token. The URL is in the following format:

https://dlm.mariadb.com/CUSTOMER_DOWNLOAD_TOKEN/FILE

Download a binary file using the following procedure:

  1. In your web browser, visit the MariaDB Download interface for the MariaDB Agent Manager binary tarball.

  2. In your web browser, navigate to the binary file that you would like to download and copy the URL.

    For example, to download a binary tarball of MariaDB Agent Manager 1.2.0, the URL is:

    https://dlm.mariadb.com/FILE_ID/monitoring/agent-manager/mariadb-agent-manager-for-pdc-1.2.0.linux-amd64.tar.gz
    

    FILE_ID is an internal identifier that is different for each file.

  3. Extract the FILE path from the copied URL.

    For example, to download the file mentioned above, the FILE path is:

    FILE_ID/monitoring/agent-manager/mariadb-agent-manager-for-pdc-1.2.0.linux-amd64.tar.gz
    
  4. Use your Customer Download Token and the FILE path to construct your customer-specific URL to download the file using command-line tools or automation.

    For example, to download the file mentioned above, the customer-specific URL is:

    https://dlm.mariadb.com/CUSTOMER_DOWNLOAD_TOKEN/FILE_ID/monitoring/agent-manager/mariadb-agent-manager-for-pdc-1.2.0.linux-amd64.tar.gz
    
  5. Use your customer-specific URL to download the file using command-line tools or automation:

    For example, to download the file mentioned above using wget:

    $ wget https://dlm.mariadb.com/CUSTOMER_DOWNLOAD_TOKEN/FILE_ID/monitoring/agent-manager/mariadb-agent-manager-for-pdc-1.2.0.linux-amd64.tar.gz
    

    Or using curl:

    $ curl -LO https://dlm.mariadb.com/CUSTOMER_DOWNLOAD_TOKEN/FILE_ID/monitoring/agent-manager/mariadb-agent-manager-for-pdc-1.2.0.linux-amd64.tar.gz