Installation Options for MariaDB Xpand

Overview

This page shows options that can be set during installation.

For additional information about how to configure options after installation, see "Configuration Options for MariaDB Xpand".

Options for non-root (recommended)

Option

Prompt

Description

Default Value

0

Memory to use for Xpand, in MiB

The default value is auto-detected based on the amount of memory available.

auto-detected

1

CPU cores to use for Xpand

All is suggested and advised, however, this can be any number that is less than or equal to the number of cpu cores licensed for a node.

All

2

Database Storage Path

The path used for Xpand data.

/data/clustrix

3

Storage space to pre-allocate to Xpand

This is the amount of space that will initially be allocated for device1 storage.

auto-detected

4

Database Logs Path

This directory contains the Xpand logs ( query.log , clustrix.log , debug.log , etc.).

/data/clustrix/log

5

MySQL Protocol Unix Socket

The location of the socket file that is necessary for communication to the database.

/var/lib/mysql/mysql.sock

6

Database Listen Address

The IP address on which Xpand will accept client connections. This may be a specific IP or 0.0.0.0 to denote that any connection is allowable.

0.0.0.0

7

Database MySQL TCP Port

The default TCP port used for accessing Xpand.

3306

8

Private (Back-End) IP

The Private (Back-End) IP is the IP that will be used for internode communication.

  • If your host has only one interface/IP, use that IP.

  • For multihomed hosts in which one or more networks are meant for client connections while another is designated for an internal "back-end" network, the IP provided should be the latter. This is particularly important in cloud environments for which a front-end IP may have special routing, filtering, or metering rules associated.

IP of current node

9

Back End Network TCP/UDP Port

24378 is the port that Xpand uses for back-end network communication using both TCP and UDP.

24378

10

Health Monitor TCP/UDP Port

Port used by the Xpand Health Monitor

3581

11

OS User

The OS user used to run Xpand. Xpand recommends specifying a user other than root. For additional information, see "Operating System User Accounts for MariaDB Xpand".

xpand†

12

Management User

The OS user used to manage Xpand. Xpand recommends specifying a user other than root. For additional information, see "Operating System User Accounts for MariaDB Xpand".

xpandm

13

Reduce TCP retry count

Default to reducing the retry count from 15 to 6

Yes

14

ClxDBI Install Path

The path where the ClxDBI will be installed.

/opt/clustrix/dbi

15

ClxDBI Listen Address

The address at which ClxDBI listens.

0.0.0.0

16

ClxDBI Listen TCP Port

The port at which which ClxDBI listens.

7888

17

ClxDBI Log Path

The path for logs generated by ClxDBI.

/data/clustrix/log/clxdbi

18

ClxDBI PID File Path

The location of the process identification number file for ClxDBI.

/var/run/clustrix

19

ClxGUI Install Path

The path where the ClxGUI will be installed.

/opt/clustrix/clxgui

20

ClxGUI Data Cache Path

The path for data cached by ClxGUI.

/var/cache/clustrix

21

ClxGUI Listen Address

The address at which ClxGUI listens.

0.0.0.0

22

ClxGUI Listen TCP Port

The TCP port used for HTTP communication by ClxGUI. If a user other than root is specified for the OS User, the default will be 8080.

8080

23

ClxGUI Log Path

The path for logs generated by ClxGUI.

/data/clustrix/log/clxgui

24

ClxGUI PID File Path

The location of the process identification number file for the ClxGUI.

/var/run/clustrix
†:

Specifying root as the database OS user changes the list of installation options

Options for Root installation

Option

Prompt

Description

Default Value

0

Memory to use for Xpand, in MiB

The default value is auto-detected based on the amount of memory available.

auto-detected

1

CPU cores to use for Xpand

All is suggested and advised, however, this can be any number that is less than or equal to the number of cpu cores licensed for a node.

All

2

Database Storage Path

The path used for Xpand data.

/data/clustrix

3

Storage space to pre-allocate to Xpand

This is the amount of space that will initially be allocated for device1 storage.

auto-detected

4

Database Logs Path

This directory contains the Xpand logs ( query.log , clustrix.log , debug.log , etc.).

/data/clustrix/log

5

MySQL Protocol Unix Socket

The location of the socket file that is necessary for communication to the database.

/var/lib/mysql/mysql.sock

6

Database Listen Address

The IP address on which Xpand will accept client connections. This may be a specific IP or 0.0.0.0 to denote that any connection is allowable.

0.0.0.0

7

Database MySQL TCP Port

The default TCP port used for accessing Xpand.

3306

8

Private (Back-End) IP

The Private (Back-End) IP is the IP that will be used for internode communication.

  • If your host has only one interface/IP, use that IP.

  • For multihomed hosts in which one or more networks are meant for client connections while another is designated for an internal "back-end" network, the IP provided should be the latter. This is particularly important in cloud environments for which a front-end IP may have special routing, filtering, or metering rules associated.

IP of current node

9

Back End Network TCP/UDP Port

24378 is the port that Xpand uses for back-end network communication using both TCP and UDP.

24378

10

Health Monitor TCP/UDP Port

Port used by the Xpand Health Monitor

3581

11

OS User

The OS user used to run Xpand. Xpand recommends specifying a user other than root. For additional information, see "Operating System User Accounts for MariaDB Xpand".

root†

12

Management User

The OS user used to manage Xpand. Xpand recommends specifying a user other than root. For additional information, see "Operating System User Accounts for MariaDB Xpand".

root

13

Allow Xpand to modify sshd_config and /etc/hosts

This option enables Host Based Authentication between the nodes and allows them to communicate with each other via ssh.

If a user other than root is specified as the OS User, this option will be set to No and hidden.

No†

14

Enable HugeTLB memory allocation

Leave this parameter as Yes to enable additional (temporary) memory usage to facilitate faster system startup. If a user other than root is specified as the OS User, this option will be set to Yes and hidden.

Yes

15

Reduce TCP retry count

Default to reducing the retry count from 15 to 6

Yes

16

ClxDBI Install Path

The path where the ClxDBI will be installed.

/opt/clustrix/dbi

17

ClxDBI Listen Address

The address at which ClxDBI listens.

0.0.0.0

18

ClxDBI Listen TCP Port

The port at which which ClxDBI listens.

7888

19

ClxDBI Log Path

The path for logs generated by ClxDBI.

/data/clustrix/log/clxdbi

20

ClxDBI PID File Path

The location of the process identification number file for ClxDBI.

/var/run/clustrix

21

ClxGUI Install Path

The path where the ClxGUI will be installed.

/opt/clustrix/clxgui

22

ClxGUI Data Cache Path

The path for data cached by ClxGUI.

/var/cache/clustrix

23

ClxGUI Listen Address

The address at which ClxGUI listens.

0.0.0.0

24

ClxGUI Listen TCP Port

The TCP port used for HTTP communication by ClxGUI. If a user other than root is specified for the OS User, the default will be 8080.

80

25

ClxGUI Log Path

The path for logs generated by ClxGUI.

/data/clustrix/log/clxgui

26

ClxGUI PID File Path

The location of the process identification number file for the ClxGUI.

/var/run/clustrix
† (references: 1, 2):

Specifying root as the database OS user changes the list of installation options