Skip to end of metadata
Go to start of metadata

This free Developer Edition AMI available from the AWS Marketplace supports a single-node version of ClustrixDB. While not clusterable, it is suitable for compatibility testing or development, but not to assess performance or serve production workloads. It otherwise contains all the features and functionality of the clusterable version of ClustrixDB.

To obtain ClustrixDB for a multi-node environment on AWS or elsewhere, please contact Clustrix Sales.

Create a Security Group

Go to the AWS EC2 Dashboard and select the “Security Groups” link under Network & Security on the left-side menu.

Then click the “Create Security Group” button.

Enter a Group Name and Description for the Security Group, and select the VPC in which the ClustrixDB instances will run. Select the "Add Rule" button 3 times to add the following rules:

  • Type: SSH (this will be used to install/configure/administer the instances) 
  • Type: HTTP (this will be used to access the ClustrixDB UI) 
  • Type: MYSQL/Aurora (this is the port on which ClustrixDB listens for DB connections) 

You may customize the Source of each rule. Just be sure that the rule allows proper access from SSH, HTTP, and MySQL clients. We recommend starting with the Source set to “Anywhere” as the rules can be configured to be more restrictive after the installation is complete.

Click the “Create” button, a list of Security Groups will appear.

Now we must add two more rules that were not easy to add in the previous screen. Select the Security Group you just created from this list of groups, and choose Actions → Edit inbound rules.

Add an “All TCP” and an “All UDP” rule. For each of these rules the Source should be “Custom” and the Group Name of this Security Group. These rules will allow all TCP and UDP traffic ONLY within this Security Group.

After selecting “Custom IP” for the Source, in the field to the right start typing this Security Group’s name (e.g. in our example: “clustrixdb-sg”). As you type, a selection menu will appear and you can click the Security Group’s name to cause the ID to be populated.


Please double-check your Security Group settings. Errors in the Security Group are the most common misconfiguration we see with ClustrixDB in AWS.

Click the “Save” button.

Launching the EC2 instances

Still within the AWS Console, select the EC2 service and then select AMIs from the left-hand menu under the IMAGES category.

Step 1: Launch AMI

The AMI for ClustrixDB Developer Edition can be found at: Clustrix Scale-Out SQL Database: Developer Edition. Click Continue to proceed.

The ClustrixDB Marketplace AMI can also be launched from the EC2 console > AMI section, as well as from the AWS  CLI  or API.

Step 2: Choose your EC2 Configuration Options

The next steps will guide you through choosing configuration options for your EC2 instance: 

  1. The Version shows the latest version of ClustrixDB available for this AMI and is included for informational purposes only. 
  2. Choose the Region most appropriate for your expected usage. 
  3. The default EC2 Instance Type is "c3.xlarge", which meets the minimum requirements to run ClustrixDB. 
  4. For VPC Settings (network), use EC2 classic (defaulted) or use an existing Virtual Private Cloud (VPC). 
    1. Clustrix recommends that production ClustrixDB instances be launched in a VPC. To learn more about VPC, click here
  5. The ClustrixDB Developer Edition includes a suggested Security Group
  6. Choose or create a Key Pair. A Key Pair is required to access ClustrixDB using ssh. To learn more about Amazon EC2 Key Pairs, click here.

Step 3: Launch the instance

Once you have supplied the desired configuration options, launch your ClustrixDB instance. Once the launch has been initiated, identify the Instance Id and Public IP assigned to your new instance.

Step 4: Connect to ClustrixDB

Your Developer Edition of ClustrixDB is now set up and ready to use. You can ssh to the server, or connect to it directly via mysql. Be sure ports 22 and 3306 are open for your IP.

  1. Sample showing ssh to the node and connect to the DB. 

    $ ssh -i <pem file> [email protected]< public DNS  for your ClustrixDB Instance>
       ____ _           _        _     
      / ___| |_   _ ___| |_ _ __(_)_  __
    | |   | | | | / __| __| '__| \ \/ /
    | |___| | |_| \__ \ |_| |  | |>  <
      \____|_|\__,_|___/\__|_|  |_/_/\_\
    Database Status: Ready
    WebUI Status: Ready
    $ sudo mysql

    When logged on to a clustrixDB server as a sudo user, you can access the DB as root without password.

2.  Sample showing connecting to the node directly with mysql

$ mysql -h <public DNS for your ClustrixDB Instance> -uroot -p<password entered in the install wizard>


Clustrix implemented its own database engine but the SQL prompt for ClustrixDB was designed to emulate MySQL.

Step 5: Next Steps with Clustrix

Here are some links that might be useful for your next steps with Clustrix:




  • No labels