TCP Ports for MariaDB Xpand

Overview

MariaDB Xpand requires a number of ports to allow inter-instance communication. Depending on your specific cluster platform, you can:

  • Open your security to allow all communication between Xpand nodes (recommended)

  • Open the specific ports required for your cluster.

Ports required by MariaDB Xpand

If using network security such as firewalls or security groups, the following network traffic must be allowed.

Internal Access Between Xpand Nodes

The following network ports are required for communication between Xpand nodes. They must each be accessible by other Xpand nodes within the cluster.

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

Internal Access Between Xpand and MaxScale Nodes

The following network ports are required for internal communication 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

External Access Between MaxScale Nodes and Application

The following network ports are required for external communication 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

Xpand Administration

The following network ports are required for communication 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

Heartbeat monitor for cluster

TCP

80

XpandGUI HTTP Listener Port (root installations)

Web browsers communicating with XpandGUI

TCP

8080

XpandGUI HTTP Listener Port (non-root installations)

Web browsers communicating with XpandGUI

MaxScale Administration

The following network ports are required for communication 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

Multi-port

The multi-port feature allows inter-instance communication to and from any core of a cluster. It can improve performance under heavy load.

Starting at port 24379 (for both TCP and UDP), open the same number of ports as there are cores or hyper-threads licensed for a node. The maximum number of licensed cores per node is 32, hence the suggested maximum range of 24379 - 24410.

Note

Xpand does not support mixed-mode usage of multiport. That is, all nodes must uniformly have multiport enabled (default) or disabled, or the nodes will be unable to form a cluster.