Once you have completed file system and OS configuration, you are now ready to install ClustrixDB.
Log into each ClustrixDB node as either the root Linux user, or a non-root Linux user that has sudo privileges.
Download the ClustrixDB installation, then untar and run the installer script using the non-root option.
|shell> tar xvfj current_version.el7.tar.bz2|
shell> cd current_version
shell> sudo ./clxnode_install.py --non-root
The installer will present you with a list of options based on your server specifications. You may use the default values for most.
Memory to use for ClustrixDB, in MiB
|The default value is auto-detected based on the amount of memory available.|
CPU cores to use for ClustrixDB
|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.|
Database Storage Path
|The path used for ClustrixDB data.|
Storage space to pre-allocate to ClustrixDB
|This is the amount of space that will initially be allocated for device-1 , permanent storage.|
Database Logs Path
|This directory contains the ClustrixDB logs ( query.log , clustrix.log , debug.log , etc.).|
MySQL Protocol Unix Socket
|The location of the socket file that is necessary for communication to the database.|
Database Listen Address
|The IP address on which ClustrixDB will accept client connections. This may be a specific IP or 0.0.0.0 to denote that any connection is allowable.|
Database MySQL TCP Port
|Clustrix recommends specifying a user other than root. 3306 is the default TCP port used for accessing ClustrixDB.|
Private (Back-End) IP
The Private (Back-End) IP is the IP that will be used for internode communication.
IP of current node
Back End Network TCP/UDP Port
|24378 is the port that ClustrixDB uses for back-end network communication using both TCP and UDP.|
|10||OS User||The OS user used to run ClustrixDB. Clustrix recommends specifying a user other than root. See ClustrixDB Operating System Users for more information.|
|11||Management User||The OS user used to manage ClustrixDB. Clustrix recommends specifying a user other than root. See ClustrixDB Operating System Users for more information.|
|12||Allow ClustrixDB 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 (Option 10), this will default to No.
Enable HugeTLB memory allocation
|Leave this parameter as Yes to enable additional (temporary) memory usage to facilitate faster system startup. Required for non-root.|
|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 (Option 10), the default will be 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|
If you have already installed ClustrixDB, see Modifying Startup Configuration Options.
* Denotes default options when running as non-root. If running as root, the installer will set option 12 to Yes and Option 22 to 80.
Repeat these steps on each node using the same configuration options.
ClustrixDB requires a number of ports to be accessible by external applications and for internode communication. This step should be performed for all nodes.
Clustrix recommends placing nodes within a secure environment and allowing access between all nodes on all ports.
These network ports are required for communication between ClustrixDB nodes. They must each be accessible by other nodes within the cluster.
|TCP||22||SSH||Administration and upgrade|
|TCP, UDP||2048||Control Port||ClustrixDB specialized administrative tool|
|TCP, UDP||2424||Nanny Port||nanny - ClustrixDB process manager|
|TCP||7888||clxdbi||Database interface for ClustrixGUI|
|TCP, UDP||24378 - 24410||Multiport||ClustrixDB internode communication|
These network ports are used to access ClustrixDB externally from your applications and for cluster administration.
|TCP||22||SSH||Remote management and cluster access|
|TCP||3581||Health Check||Heartbeat monitor for cluster|
*for root installs. Non-root installations will use port 80.
From a single node only, connect to ClustrixDB using the default mysql (MariaDB) client.
shell> sudo mysql
You can confirm you are running ClustrixDB by examining the clustrix_version variable:
sql> SELECT @@clustrix_version;
Next, set a password for the root user, set the license and form a cluster:
Then run the following SQL commands to set the cluster's license:
sql> SET GLOBAL license = 'license key';
You are now ready to cluster your nodes.
shell> ALTER CLUSTER ADD ' node2_ip_address', 'node3_ip_address';
After the ALTER CLUSTER command, there will be a brief period of unavailability while the cluster forms.
To verify that all nodes are in the cluster, run the following query:
|select * from system.nodeinfo;|
All the nodes you added to the cluster should appear in this list.
Now that you have completed installation, proceed to Configure SSH Authentication.