Skip to end of metadata
Go to start of metadata

This is a guide for quickly getting up and running with the software version of ClustrixDB. If you are deploying in Rackspace, please see Deploying ClustrixDB in the Rackspace Cloud.

Prerequisites for a Production Deployment

If you plan to run ClustrixDB in production, make sure you have 3 hosts or more to build a cluster with at least:

  • 48 to 64 GiB of memory

  • Dual 4 Core Xeon CPUs

  • RHEL 6.4 or CentOS 6.4

For more details on choosing hardware for a Production environment, or for minimum requirements for a development or test cluster, please see our section on minimum hardware requirements. Since ClustrixDB is designed as a highly available fault tolerant service, you will need to calculate persistent storage requirements based on cluster size.

Step 1: Get the Installer

On the host where you will be installing the software and from a directory which has enough space to store the downloaded files (approximately 40 MiB):

Enter into a bash root terminal

Step 2: Run the Installer

At this point, 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.

Output from installer

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 3: Confirm Configuration Options

Once you are done with customization and configuration, enter "yes" to accept the license agreement and install the software. On completion, the installer will give you a command which can be used on the other nodes in your cluster as well as some other useful information. On a default installation with no customized variables you will see something similar to this message:

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.

Congratulations!  You have successfully installed ClustrixDB. Please continue by installing Clustrix on other nodes, or skip this step and proceed with configuring ClustrixDB.

When you are done with installing on all desired nodes, proceed with configuration.

Step 4: (Optional) Install on Other Nodes

If you would like to build a cluster, you will need to install the the same version of the software on every host which will be a node in the cluster. 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 5: Complete ClustrixDB Configuration using the Installation Wizard

Use your browser to visit the url provided by the installer and you should see the ClustrixDB Startup Wizard. Read the terms of service and click on the check-box to accept the terms. If you have several nodes with software installed, you can click "Build a cluster" and otherwise you can start with "Use a single node".

Step 6: Enter a License Key (optional) 

Building a cluster requires a license. Click to get a license from the license site and copy/paste that into the dialog. If you only want to run a single node, no license key is needed. 

Step 7: 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.

Icon

Short cluster names are easier to read (and find) in browser tabs.

Step 8: Set a root password

You may have seen this step in MySQL setup before. This only sets the root password for the database itself – not the admin password for the Clustrix Insight monitoring and administration tool.

Step 9: 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 later on the "Configure Insight users" screen.
 

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

Step 10: (Optional)  Add nodes to your cluster

To add nodes, copy the back end address from each host with the software installed into the dialog.

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 11: Set up NTP

The last step in setting up ClustrixDB is to set up NTP, which is required for for clustered installations. 

Appendix

Security Considerations

When building a cluster, you may need to configure your firewall and routing rules appropriately for your network. If you have a simple DMZ where your developers and applications are all open to each other and closed to the outside, you do not necessarily need to worry about this at this time.

If you need to set up network infrastructure rules, ClustrixDB requires the following ports with the default configuration.

Port and ProtocolNotes
22 TCP

Default ssh port used by the ClustrixDB command line administrative tool. This port should be open to your operations, administrators, and between all nodes in the cluster.

80 TCP

Used by Clustrix Insight to serve HTTP requests. This port should be open to your operations, administrators, and developers.

2048 TCP/UDPUsed by ClustrixDB. This port should be open between all nodes in the cluster.
2424 TCP/UDPUsed by ClustrixDB nanny. This port should be open between all nodes in the cluster.
3306 TCP

Used for MySQL protocol communication. This port should be open to administrators and your application.

24378 TCP/UDPUsed for ClustrixDB back-end communication. This port should be open between all nodes in the cluster.

Connecting 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
Additional Resources

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