As part of the ClustrixDB Installation process you made some configuration selections which are written to clxnode.conf. Post-installation, you can modify the configuration by editing the file on each node while ensuring that the options specified are the same (other than node specific items like BACKEND_ADDR).

The clxnode.conf is stored on each node in /etc/clustrix/ and options specified during installation are written to this file. The following table summarizes these options and provides information on how they can be modified post-installation.

The steps outlined in this document apply to most installations of ClustrixDB, but do not apply to deployments based on the Clustrix AWS AMI.

ClustrixDB requires that all nodes have identical configurations (other than node specific items like BACKEND_ADDR). Modifications to any of the options described below must be made on every node in the cluster. Values commented out with a # will have no effect on the database. Changes to the configuration requires a restart of ClustrixDB services (see below) to take effect.

Default Options for clxnode.conf

Use standard bash conventions for clxnode.conf. The file should contain variable definitions, comments, and blank lines only. Option and value settings should not contain any extraneous spaces. For example CPU_CORES=4

Option	Description	Default Value	To Modify
NODE_MEMORY	Memory to use for ClustrixDB, in MiB	auto detected	On every node in your cluster edit the clxnode.conf file and uncomment (if commented out) the line #NODE_MEMORY and change the value to the desired amount. Stop ClustrixDB, restart hugetlb, and then Start ClustrixDB on all nodes simultaneously by running the following command from a single node: clx -P cmd 'systemctl stop clustrix; systemctl restart hugetlb; systemctl start clustrix'
MAX_REDO	Maximum ClustrixDB Redo Space, in MiB	1024	Only modify this variable with guidance from Clustrix Support.
CPU_CORES	Number of CPU cores ClustrixDB will use	All	Edit the clxnode.conf file for every node in your cluster to the desired value. Stop/Start all ClustrixDB services. For additional info, please see section below on setting CPU_CORES.
DATA_PATH	ClustrixDB Database Storage Path	/data/clustrix	Stop all ClustrixDB services. On each node: Move the directory to the desired location. Modify the value of DATA_PATH in clxnode.conf to reflect the new location. Start all ClustrixDB services.
DATA_ALLOCATE	Storage space to pre-allocate to ClustrixDB	80% of free space on $DATA_PATH volume	This value here is used for initialization only. To allocate more space on a node that already has ClustrixDB installed, see ALTER CLUSTER RESIZE DEVICES
LOG_PATH	ClustrixDB Logs Path	/data/clustrix/log	Stop all ClustrixDB services. On each node: Move the directory to the desired location. Create a simlink in /data/clustrix/ pointing to the new log folder. Example: ln -s /log /data/clustrix/log/ Start all ClustrixDB services.
UI_LOGDIR	ClustrixDB WebUI Logs Path	/data/clustrix/log/clustrix_ui	Stop all ClustrixDB services. On each node: Move the directory to the desired location. Create a simlink in /data/clustrix/log pointing to the new log folder. Example: ln -s /log/clustrix_ui /data/clustrix/log/clustrix_ui Start all ClustrixDB services.
UI_CACHEDIR	ClustrixDB WebUI Cache Path	/var/cache/clustrix/django	Only modify this variable with guidance from Clustrix Support.
UNIX_SOCKET_PATH	ClustrixDB MySQL Protocol Unix Socket	/var/lib/mysql/mysql.sock	Only modify this variable with guidance from Clustrix Support.
LISTEN_ADDR	ClustrixDB Database Listen Address (Front-End IP) Interface	0.0.0.0
MYSQL_PORT	ClustrixDB Database MySQL Port	3306
BACKEND_ADDR	ClustrixDB Private Back-End IP Interface	auto detected	See section below on changing BACKEND_ADDR.
BACKEND_PORT	ClustrixDB Back End Network Port	24378	It is not recommended to modify the default value for the ClustrixDB Back End Network port.
HEALTHMON_PORT	The port used for the ClustrixDB health monitor.	3581	Edit value in clxnode.conf Stop/Start all ClustrixDB services.
HTTP_PORT	ClustrixDB WebUI HTTP Port	80	Edit value in clxnode.conf Stop/Start all ClustrixDB services.
NANNY_PORT	ClustrixDB Nanny Port	2424	It is not recommended to modify the default value for the ClustrixDB nanny port.
CONTROL_PORT	ClustrixDB Control Port	2048	It is not recommended to modify the default value for the ClustrixDB control port.
CLX_USER	ClustrixDB OS User	root	Do not modify this value after installation.
MANAGE_USER	ClustrixDB Manager User	root	Do not modify this value after installation.
WRITE_HOSTS	Allow ClustrixDB to modify sshd_config and /etc/hosts. This used by root installations only, for internode communication for administrative tasks, including upgrades.	#Commented out	On each node: Remove comment and set variable to any string. Stop/Start all ClustrixDB services.
HUGE_TLB_ENABLE	ClustrixDB enables HugeTLB memory allocation for faster startup. NOTE: This causes instability on some systems (particularly certain virtual machines). Required for non-root installations that have more than 20GiB of $NODE_MEMORY Contact Clustrix Support before changing from default.	True	On each node, comment out to disable this option. (i.e. #HUGE_TLB_ENABLE) Stop/Start all ClustrixDB services.

Additional options for clxnode.conf

The following options are NOT included by default in clxnode.conf, but can be added to the end of that file to modify behavior from the default. ClustrixDB must be restarted for changes to take effect.

Option

Description

Default Value

To Modify

DISABLE_MULTIPORT

When this option is present, the multiport feature is disabled.

This option is not included in clxnode.conf, resulting in multiport being enabled by default.

To disable multiport, add an entry for DISABLE_MULTIPORT = Y.

To enable multiport, remove or comment out this entry from clxnode.conf on all nodes.

MULTIPAGE_ALLOC

Bytes reserved for multi-page allocators.

The option is not included clxnode.conf, resulting in a value of 1GiB

Add this entry and define the number of bytes that Clustrix Support recommends for your workload.

Details of Modifying Startup Configuration Options

ClustrixDB requires that all nodes must have the same values in clxnode.conf

Stop/Start all ClustrixDB Services

To apply the changes that have been made to clxnode.conf, the ClustrixDB services on all the nodes will need to be restarted:

shell> /opt/clustrix/bin/clx dbrestart

CPU_CORES

The default setting of CPU_CORES=All will make use of all available cores in the system. If you would like to limit the number of cores utilized by ClustrixDB you must modify the value for CPU_CORES to specify the number of cores that should be used. ClustrixDB licensing will base its enforcement on the number of cores being utilized in the system as specified by CPU_CORES.

BACKEND_ADDR

Modify the BACKEND_ADDR entry in the /etc/clustrix/clxnode.conf file with the new IP.
Modify /data/clustrix/broadcast_nodes file with the new IP addresses on all nodes.
1. Note: Specifying port 24378 is not necessary unless you're using a non-default configuration.
Run the clx command to ensure it has cached the IP address of each node.
shell> /opt/clustrix/bin/clx cmd 'clx cache'
Stop all ClustrixDB services (per above).
Change the backend interface IP address on each node.
Modify iptables as needed.
Start all ClustrixDB services (per above).

Space shortcuts

Page tree