Child pages
  • Installing ClustrixDB on a CentOS-based System

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 quickly getting up and running with ClustrixDB, which can be installed on any system running CentOS 6.X.

Step 1: Get the Installer

On the host where you will be installing ClustrixDB and from a directory which has enough space to store the download the ClustrixDB Installer, which can be requested by visiting the ClustrixDB downloads page.

Step 2: Unpack and Run the Installer

Unpack the tar file (if required), change to the directory that was created, then run the installer as root

$ tar xvjf <current_version>.tar.bz2
$ cd <current_version>
$ sudo ./

Step 3: Confirm Configuration Options

The installer will examine the host and present a recommended configuration for running ClustrixDB. The exact values here will vary based on what is on the local host and may not be appropriate for your installation.  To edit any of these values, type in the number on the line you wish to change and edit it to a new value. Pressing return at the prompt will use the default value which will appear in brackets next to the question. For 'Yes/No' questions, '[Y/n]' means 'yes' is default while '[y/N]' means 'no' is the default.

Adjust the configuration to be appropriate for your environment. 

The  Private IP is an internally addressable IP address for the host the nodes will use to communicate with each other and should not be accessible outside of your network. For multihomed hosts with one network meant for client connections, and the other as a "back end" network, the private IP should be on the latter; this is particularly important in cloud environments where a front-end IP may have special routing or filtering rules, or be metered.  If your hosts have only one interface/IP, enter that IP here.


Step 4: Complete the Installation

Once you are done with customization and configuration, enter " Yes " to accept the license agreement and install ClustrixDB. Once the installation is successful, the installer will output a command line message confirming that the Clustrix Database is now ready for use.

Open in a web browser if this is the first or only host in your cluster.
Add to the list of IP addresses in the 'Nodes to Add' dialog if you are adding this node to a cluster

This message will be followed by a command that you can use to install ClustrixDB on other nodes, and the IP address of your current node (which is required to form a cluster with other nodes). If you are building a cluster, be sure to record this information and proceed to install on the other nodes.


You have successfully installed ClustrixDB. Please continue by installing Clustrix on other nodes, or skip this step and proceed with configuring ClustrixDB with the UI Installation Wizard.

Step 5: Install on Other Nodes

If you would like to build a cluster, you will need to install the the same version of ClustrixDB on every host which will be a node in the cluster. There are 3 options for installing ClustrixDB on additional servers:

  1. Run the flex_clone script from a node with ClustrixDB already installed

    Run the Flex Clone script from a node with ClustrixDB already installed
    $ /opt/clustrix/bin/ '<new node IP>'

    This copies ClustrixDB installation files and configuration used to install Clustrix to the target node and runs the installer.

  2. Use the command output at the end of the installation process to install ClustrixDB on other nodes.
  3. Simply follow the same installation instructions that you just used to install Clustrix on the first node to each additional node. 

Be sure to record the private IP addresses of all of the hosts you will be adding to your cluster and open your web browser to the first web address given on the first host where you installed the ClustrixDB.

Step 6: Complete ClustrixDB Configuration using the Installation Wizard

Use a web browser to visit the url provided by the installer for one of the nodes, which will take you to the the ClustrixDB Installation Wizard, which will guide you through the rest of the configuration.

The Installation Wizard in the WebUI will prompt you to:

  • Read the terms of service and click on the check-box to accept the terms. 
  • Select the type of ClustrixDB deployment you plan to proceed with
    • If you have several nodes with ClustrixDB installed, you can click "Build a cluster" and otherwise you can start with "Use a single node".
  • Enter a License Key
    • Building a cluster requires a license key, which can be requested here. When entering the license key, be sure to include the curly braces specified as part of the license key. 
    • If you require an enterprise license, you must provide the cluster_id as part of the license key request
      • This can be obtained by issuing the following query on the node being used to configure the cluster:

        select @@cluster_id
  • Name Your Cluster
    • The cluster name is important even if you only have one node. This name appears in the title bar and tabs of your browser window and in the alerts you might receive via email. It also appears in certain Clustrix Insight screens.
  • Set a root password for the database
    • The password you specify here is used only for the database and not for the Clustrix Insight WebUI
  • Create a Clustrix Insight administrator account
    • Clustrix Insight is the web interface for monitoring and administration of your database. This step sets up the administrator account. You can use this account to set up additional Insight users.

If you chose to configure a single node instance of Clustrix, you are now done and can click through to Start using Clustrix.

Step 7: Create your cluster

To create your cluster, copy the back end address from each host with ClustrixDB installed into the dialog. Each of these hosts should already have ClustrixDB installed and the back end address recorded as part of the installation process.

Once you have added the hosts to add to the cluster, click on Check nodes to check the status of each host for cluster formation. Once the check is complete click on Start using Clustrix and you will be taken to the Clustrix Insight dashboard. 

Step 8: Verify that NTP is running correctly

The last step in setting up ClustrixDB is to verify that NTP is running correctly. NTP is required for for clustered installations.

Step 9: Connect to Clustrix 

If you have a mysql client installed on the host you can test the installation after the "Clustrix Database now ready for use" message by connecting with:

Enter into a terminal
mysql -u root test 


Security Considerations

When building a cluster, you may need to configure your firewall and routing rules appropriately for your network. For more information on this, please see Network Security with ClustrixDB.

Additional Resources

The System Administrator's Guide contains information on how to set up, manage, and tune your Cluster. If you cannot an answer to a question, feel free to ask it on the Clustrix Community Support forums .