

                            ScaleOut Product Suite
                            Version 6.0 for Linux

                           Post-Installation Notes

Thank you for installing the ScaleOut Product Suite. Please be sure to 
regularly check our website at 
http://www.scaleoutsoftware.com/support/stateServer/downloads.html for the 
latest release of the software.

The ScaleOut Product Suite includes ScaleOut In-Memory Database(tm), ScaleOut
StateServer(r), ScaleOut StateServer(r) Pro, ScaleOut StreamServer(r), and 
ScaleOut GeoServer(r). These features are enabled using your license key.

You can find the User Guide with full details on installation, configuration,
usage, and concepts at:
https://static.scaleoutsoftware.com/docs/user_guide/index.html.

Here are some useful tips that can help you to quickly configure the ScaleOut
Product Suite.


License Keys

For a single server environment, no license key is required. The software is 
fully functional without a license key but is restricted to operation on a 
single server. This will allow you to test basic functionality with your 
application. To run ScaleOut In-Memory Database for Redis clients, use other
advanced features, or to 
create a multi-server cluster, please contact ScaleOut Software for a license 
key.


Installation Directories

By default, the ScaleOut Product Suite installs into /usr/local/soss, a symbolic 
link to /usr/local/soss7. The other installation directories are as follows:

* The two parameter files accessible in /usr/local/etc as symbolic links.
* The log files are in /var/log/soss.
* C libraries are accessible in /usr/lib as symbolic links. 
* Java jar files are in /usr/local/soss/java_api, and third party helper 
jars are in the sub-directory third_party_lib. 
* The command line tools (soss and geos) are in /usr/local/bin.


Optional ScaleOut In-Memory Database

ScaleOut In-Memory Database incorporates open-source Redis(r)* code (version 
6.2.5) to run Redis commands on ScaleOut's cluster. It automates cluster 
management and recovery, implements fully consistent updates to replicas, and 
runs Rediscommands on all processing cores using muli-threadeded execution. 
Redis clients can connect to a ScaleOut cluster using the standard RESP protocol. 
Be sure to configure your clients to connect to the IP address and server port 
for any ScaleOut server in a cluster.


Optional Remote Client Support for ScaleOut StateServer

A separate installation package lets you optionally install just the Remote 
Client Support component of ScaleOut StateServer. The Remote Client Support 
component installs only the libraries required for applications to remotely 
access ScaleOut StateServer running on a networked computer. Both components 
include all management tools. 


Configuration Steps

Please follow these steps after installing the ScaleOut Preduct Suite. (Please
refer to the User Guide for more information.)

Step 1: Ensure that the sossd service has been started. On Red Hat Linux 7 and 
8 systems, you can do this using the Red Hat Services Configuration Tool or by 
running, "/usr/bin/systemctl status sossd" from a terminal.

On RedHat 6, you can use the Red Hat Services Configuration Tool or by running
"/etc/init.d/sossd status" from a terminal.

On Debian (Ubuntu) systems, you can do this by running 
"/usr/sbin/service sossd status". 

Step 2: Configure which network to use if multiple network interface cards 
(NICs) are present on your computer. (Note that no other changes to the 
default parameters are usually necessary to get started.) ScaleOut Software 
strongly recommends that you run your ScaleOut cluster on a secure, back-end 
network.

You can configure the network subnet by running the soss utility. For example, 
the comand "soss set net_interface=10.0.3.0" will instruct the sossd service 
to use the 10.0.3 Class C subnet. You also can directly edit 
/usr/local/etc/soss_params.txt and then manually restart the sossd service.

Make sure that all three SOSS ports (by default, 720, 721, and 722) are not
used by other services and are not firewalled. Note that the server port for
client is 721 by default.

Step 3: Be sure to activate the ScaleOut service process (daemon) (i.e., create
or join a cluster) after installation. You can activate the service using the 
"soss join" command. You also can configure the service to automatically join the 
cluster every time it starts. Please consult the online User's Guide for more details.

Step 4: Optionally use the Web Management Console by following the configuration 
steps in the User Guide. By default, the Web Management Console serves requests 
for the local host; it can be configured to run remotely.

Note: You also can download the Windows version of the ScaleOut Product Suite 
from https://www.scaleoutsoftware.com/scaleout-support/support-downloads/ 
to a Windows computer, which you can use to remotely manage a Linux cluster. 
Just install the Remote Client component of the installation package.

Step 5: For ScaleOut StateServer, compile and run the sample Java program under
/usr/local/soss/samples/Java_samples/NamedCacheAPI. You also can cache from C programs; 
see the soss_svccli.h include file and /usr/local/soss/samples/soss_sample.c.

Note for Java programs: Ensure that your application objects to be stored in 
ScaleOut StateServer are defined as serializable.


For More Information

For additional information, please refer to the User Guide on ScaleOut
Software's web site (URL above). If you have any questions or comments, 
please contact us as follows:

* by email at support@scaleoutsoftware.com,
* by phone at (503) 643-3422,
* on the Web at www.scaleoutsoftware.com/support/contact.html.

Thank you again for using the ScaleOut Product Suite.


*Redis is a registered trademark of Redis Ltd. and the Redis box logo is a 
mark of Redis Ltd. Any rights therein are reserved to Redis Ltd. Any use 
by ScaleOut Software is for referential purposes only and does not indicate 
any sponsorship, endorsement or affiliation between Redis and ScaleOut 
Software.

