Quick Start Guide

This Quick Start Guide gives you step-by-step instructions for launching the ScaleOut Product Suite and connecting your ScaleOut or Redis client application. It should take just a few minutes to get everything up and going.

Note

Both ScaleOut In-Memory Database and ScaleOut StateServer use the same cluster architecture, which comprises a single service process (aka, daemon), called the “StateServer service,” running on each server or VM in the cluster.

  1. Download the Windows or Linux installer from ScaleOut Software’s website and run the installer.

    Note

    Note the location of the the server’s parameters file, called soss_params.txt. By default, it is located in /usr/local/soss on Linux and in the installation folder on Windows. For now, you can directly edit this file to set the parameters described below. However, it’s better to use the management tools when changing cluster-wide parameter values; see the section Management for details.

  2. Connect the StateServer service to your network:

    • If you have a single network interface card (NIC), this occurs automatically.

    • If you have multiple NICs, you can select a specific IP address by adjusting the net_interface and subnet_mask parameters in soss_params.txt. For example, you can set net_interface to 10.0.1.47 with subnet_mask 255.255.255.255.

    Note

    You can let DHCP specify the IP address by setting net_interface and subnet_mask to describe a subnet (for example, 10.0.1.0 with subnet_mask 255.255.255.0 for the 10.0.1 class C subnet).

  3. Make sure the StateServer service is running using the ScaleOut utility command soss query. It should report that the server is inactive.

  4. Activate the server by running the ScaleOut utility command soss join. (This is called joining the server because the server joins the cluster or creates a new one.)

    Note

    You can also set the server to join automatically at startup by setting the parameter auto_join to 1.

  5. Verify that the server is active with soss query. You should see that it is in the active state. You can also run soss test to verify that it is working correctly.

  6. Connect your client to the server:

    • For ScaleOut client libraries, just start running your client application. It will automatically find the ScaleOut StateServer service if it is running on the same system.

    • For a Redis client, configure it to point to the service’s server port, which is 721 by default and can be changed in the soss_params.txt file using the svr_port parameter.

  7. Configure and join additional servers as desired. If multicast is allowed on your network, they will find each other. (Otherwise, you can configure a cluster with the group_host parameter.) The servers will form a cluster, automatically share the workload, and create replicas for high availability. You will need a license key to run more than two servers in a cluster.

For detailed installation and configuration instructions, please see the section Installation. Let us know if you have questions, issues, or comments using our support forum: https://community.scaleoutsoftware.com/.