Step 1: Install MariaDB Xpand

Overview

This page details step 1 of the 6-step procedure "Deploy Xpand Performance Topology".

This step installs MariaDB Xpand 5.3.

MariaDB Xpand requires three or more nodes. Nodes must meet requirements.

Interactive commands are detailed. Alternatively, the described operations can be performed using automation.

Allow Interconnect

MariaDB Xpand depends on interconnect between Xpand nodes.

AWS Security Group

When deploying in Amazon AWS, the security group must be modified prior to Xpand installation.

The security group should allow the following ports to be open internally between Xpand nodes:

Protocols

Ports

Used By

Used For

TCP

22

SSH Daemon Port

SSH connections for Xpand administration and upgrades

TCP, UDP

2048

Control Port

Xpand administration

TCP, UDP

2424

Nanny Listener Port

Xpand process management

TCP

3306

Database Server Listener Port

Clients and MaxScale communicating with Xpand

TCP

7888

DBI Listener Port

XpandGUI communicating with Xpand

TCP, UDP

24378 - 24410

Internal Communication Ports

Communication between Xpand nodes

The security group should allow the following ports to be open internally between the MaxScale nodes and Xpand nodes:

Protocols

Ports

Used By

Used For

TCP

3306

Database Server Listener Port

Clients and MaxScale communicating with Xpand

The security group should allow the following ports to be open externally between the Xpand nodes and any systems that require access for administration or monitoring:

Protocols

Ports

Used By

Used For

TCP

22

SSH Daemon Port

SSH connections for Xpand administration and upgrades

TCP

3306

Database Server Listener Port

Clients and MaxScale communicating with Xpand

TCP

3581

Health Check Port

Health Monitor communicating with Xpand

TCP

8080

XpandGUI HTTP Listener Port

Web browsers communicating with XpandGUI

The security group should allow the following ports to be open externally between the MaxScale nodes and any systems that require access for administration or monitoring:

Protocols

Ports

Used By

Used For

TCP

3306

Read/Write Split Router Listener Port

Clients and applications communicating with MaxScale

TCP

8989

REST API Listener Port

MaxCtrl and REST clients communicating with MaxScale

The security group should allow the following ports to be open externally between the MaxScale nodes and the application:

Protocols

Ports

Used By

Used For

TCP

3306

Read/Write Split Router Listener Port

Clients and applications communicating with MaxScale

firewalld

To reduce the likelihood of conflicts, stop the system firewall during Xpand installation.

These instructions describe stopping and disabling firewalld. If another firewall is deployed, alternative action will be required.

This action is performed on each Xpand node.

To disable firewalld:

$ sudo systemctl stop firewalld
$ sudo systemctl disable firewalld

Download MariaDB Xpand

MariaDB Xpand is distributed as a binary tarball.

Download MariaDB Xpand from the page that matches your use case:

  • If you are participating in a 45-day Xpand trial, access the Xpand downloads link on the Xpand Trial page.

  • MariaDB Enterprise customers with an Xpand license for production use can download MariaDB Xpand from the MariaDB Downloads page. Login is required.

Place the downloaded file on each Xpand node.

Install MariaDB Xpand

This action is performed on each Xpand node.

To install Xpand:

  1. Install dependencies:

    $ sudo yum install bzip2 mdadm ntp ntpdate screen wget xz
    
  2. If using Red Hat Enterprise Linux (RHEL), edit the repository file (not required on CentOS):

    $ sudo yum-config-manager --enable rhui-REGION-rhel-server-optional
    
  3. Untar the Xpand package:

    $ tar xvf xpand-5.3.19.el7.tar.bz2
    
    $ cd xpand-5.3.19.el7
    
  4. Run the xpdnode_install.py installation wizard:

    $ sudo ./xpdnode_install.py --wizard
    

    Node checks are performed for certain Xpand requirements. If the requirements are not met, the xpdnode_install.py installation wizard exits with an error message or raises a warning.

  5. Use the wizard to perform additional configuration as needed. Accept the Terms of Use to configure and start the Xpand service:

     0 - Memory to use for MariaDB Xpand, in MiB: 9886 MiB
     1 - CPU cores to use for MariaDB Xpand: All
     2 - Database Storage Path: /data/clustrix
     3 - Storage space to pre-allocate to MariaDB Xpand: 22 GiB
     4 - Database Logs Path: /data/clustrix/log
     5 - MySQL Protocol Unix Socket: /var/lib/mysql/mysql.sock
     6 - Database Listen Address (Front-End IP): 0.0.0.0 (Listen on all available interfaces)
     7 - Database MySQL TCP Port: 3306
     8 - Private (Back-End) IP: 192.0.2.1/255.255.255.0
     9 - Back End Network TCP/UDP Port: 24378
    10 - Health Monitor Network TCP Port: 3581
    11 - OS User: xpand (user will be created)
    12 - Management User: xpandm (user will be created)
    13 - Reduce TCP retry count: Yes
    14 - ClxDBI Install Path: /opt/clustrix/clxdbi
    15 - ClxDBI Listen Address: 0.0.0.0 (Listen on all available interfaces)
    16 - ClxDBI Listen TCP Port: 7888
    17 - ClxDBI Log Path: /data/clustrix/log/clxdbi
    18 - ClxDBI PID File Path: /opt/clustrix/var/run
    19 - ClxGUI Install Path: /opt/clustrix/clxgui
    20 - ClxGUI Data Cache Path: /opt/clustrix/var/cache
    21 - ClxGUI Listen Address: 0.0.0.0 (Listen on all available interfaces)
    22 - ClxGUI Listen TCP Port: 8080
    23 - ClxGUI Log Path: /data/clustrix/log/clxgui
    24 - ClxGUI PID File Path: /opt/clustrix/var/run
    25 - Display MariaDB Xpand Terms of Use
     Q - Quit
     H - Help
    
    Select item to change or enter 'Yes' to accept Terms of Use and continue: Yes
    

    Default memory and storage settings are based on auto-detection of available resources.

Set Xpand Binary Path

MariaDB Xpand installs Xpand-related commands to a custom binary path. To enable the Xpand administrator account (xpandm) to execute commands without fully qualifying the path, add the Xpand binary path to the $PATH environment variable.

If you are using an alternative shell or alternative system user account, you will need to adjust these instructions.

This action is performed on each Xpand node.

To add the Xpand binary path:

  1. Edit the .bash_profile file:

    $ sudo vim /home/xpandm/.bash_profile
    
  2. At the very end of the file, add the Xpand binary path to the $PATH variable:

    # Append Xpand Bin to $PATH
    export PATH=$PATH:/opt/clustrix/bin
    

    After adding this text, save and close the file.

  3. Set the owner of the .bash_profile file:

    $ sudo chown xpandm:xpandm /home/xpandm/.bash_profile
    
  4. The path change will take effect upon next login as xpandm account.

  5. To add the Xpand binary path for your current session:

    $ export PATH=$PATH:/opt/clustrix/bin
    

Next Step

Navigation in the procedure "Deploy Xpand Performance Topology":

  • This page was step 1 of 6.