This is documentation for a previous version of ClustrixDB. Documentation for the latest version can be found here

Skip to end of metadata
Go to start of metadata

This is a guide for installing and running ClustrixDB on any system running CentOS 6.X.

To obtain the link to the current version of the ClustrixDB installer along with a license key, please contact Clustrix Sales. If you encounter any problems or issues while using these instructions, please contact Clustrix Support.

Before beginning, please verify that your hardware meets the minimum Recommended Hardware Configurations.

Step 1: Install ClustrixDB on First Node

Copy the installer to a node, extract, and run as shown below.

shell> tar xvjf current_version.tar.bz2
shell> cd current_version
shell> sudo ./clxnode_install.py

The installation process can take several minutes. Please be patient.

Step 2: Confirm/Adjust Configuration Options for ClustrixDB Install Wizard

Enter Yes to accept the installation parameters recommended and install ClustrixDB on the first node. Refer to the ClustrixDB Installation Options for guidance in modifying these parameter values. 

Step 3: Setup Network Security for Each Node

ClustrixDB requires a number of ports for access by external applications and for internode communication.

Option A: Allow All Communication Between Nodes 

The recommended method for allowing communication between nodes is to allow access between all nodes on all ports within a secure environment.  

Option B: Open Specific Ports

You can also open the specific ports required by ClustrixDB as shown below.

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

Internal Access Between Clustrix Nodes

These network ports are required for communication between ClustrixDB nodes. They must each be accessible by other nodes within the cluster.

ProtocolPortUseReason
TCP22SSHAdministration and upgrade
TCP, UDP2048Control PortClustrixDB specialized administrative tool
TCP, UDP2424 Nanny Portnanny - Clustrix process manager
TCP3306SQL

Database communication

TCP7888clxdbiDatabase interface for ClustrixGUI
TCP, UDP24378 - 24410MultiportClustrixDB internode communication

External Access

These network ports are used to access ClustrixDB externally from your applications and for cluster administration.

ProtocolPort                UseReason
TCP22SSHRemote management and cluster access   
TCP80HTTPClustrixGUI
TCP3306SQLDatabase access
TCP3581Health CheckHeartbeat monitor for cluster

For instructions for specific cloud environments, please see Installing ClustrixDB at a cloud provider.

Step 4: Install Software on Additional Nodes

Run flex_clone from a command prompt of the first configured node to install identical versions of ClustrixDB on additional nodes. You will need to run this once for each node of your cluster. 

Run flex_clone from a node with ClustrixDB already installed
shell>  /opt/clustrix/bin/flex_clone.sh 'new node IP'

Step 5: Configure Your Cluster

You can now connect to your new database to configure your cluster. ClustrixDB uses your existing mysql client to access the ClustrixDB database. First, execute the following from a command line prompt.

shell> mysql

Follow this syntax from the resulting mysql prompt to provide the license number and configure your cluster. Be sure to include the curly brackets that surround your license key. (If you do not already have a license key, please contact Clustrix Sales.) 

SET GLOBAL license = '{license key including curly brackets}'
ALTER CLUSTER ADD 'ip' [, 'ip'] ... 

For example, this adds three nodes to the cluster.

sql> ALTER CLUSTER ADD '10.2.13.58', '10.2.13.55', '10.2.13.59';

Step 6: Verify that NTP is Synchronized Throughout the Cluster

This test will only succeed once all nodes have been successfully added to your cluster using the previous step.

To verify that the clocks are synchronized between all nodes of the cluster, run the following from a command line prompt:

shell> /opt/clustrix/bin/clx cmd 'ntpstat'

See Setting Up NTP for ClustrixDB on CentOS if this step identifies issues.

Step 7: Verify ClustrixDB Configuration

Execute the following from a command line prompt to access the “test” database created during installation:

shell> mysql -u root test

Step 8: Access ClustrixGUI

You should now be able to access the ClustrixGUI Administration UI to monitor and manage your cluster. Provide the IP or hostname of one of the nodes of your cluster in the address bar of a browser and press Enter. (Clustrix recommends Chrome.)

Please contact Clustrix Support if you experience any problems during installation.