Configuring the Remote Client Option

The Remote Client option lets client applications running on a networked Web or application server connect to a remote ScaleOut StateServer store. In this configuration, the StateServer service does not run on the Web or application server.

To configure the Remote Client option for access from a local server to a remote SOSS store, please follow these steps:

Ensure that a secure, reliable, and fast network exists to the remote store. The network must be fast enough to handle the expected access bandwidth.
On the remote SOSS store, configure a unique gateway IP address and gateway server port on all SOSS hosts. The IP address/port pair on each SOSS host must be reachable from the remote client system using a TCP connection. This pair needs to connect the remote client to the SOSS server port on each SOSS host.

Note

The gateway IP address may be on a different subnet from that used for the SOSS store’s network interface. Also, if a router is used at the remote store and port mapping is employed, the gateway port may not match the SOSS server port’s value.
On the remote client system, add a gateway to the Remote Client configuration using either the Management Console or the soss Command command-line program. To add a gateway using the Management Console, click on the Client Configuration node and enter one of the remote store’s gateway addresses in the Add New Gateway section. This will establish communication with the SOSS store.

If using the soss Command from a command-line prompt, enter the same information using the add command:
```
soss add <mgt_port>,<gateway_IP>,<gateway_port>
```
Where
- mgt_port: the SOSS store’s management port
- gateway_IP: gateway IP address configured for a host in the SOSS store
- gateway_port: the server port for the SOSS host specified by gateway_IP
You can also optionally add additional gateway addresses for other SOSS hosts in the SOSS store in case one or more hosts are offline. Other gateway addresses also can be automatically populated as described below.

Note

The Remote Client configuration information is recorded in the client parameters file, soss_client_params.txt (see Configuration Parameters), which is stored in ScaleOut StateServer’s installation directory on the local server (/usr/local/etc on Linux). This file separately may be used by the GeoServer option for configuring remote stores. It is never used by both components at the same time.
If communication with the remote store is successful, you should be able to connect to the SOSS store with the management tools. If using the Management Console, right-click on the Client Configuration node and select Populate.

This will download the gateway addresses from all hosts on the remote store and save them in the local store’s client parameters file. This ensures that you can establish communications with the SOSS store if any of these gateway addresses respond. (Gateway addresses for offline hosts are ignored during remote access.)

If not using the Management Console, the equivalent command if using soss Command will be:
```
soss populate
```
Once this is all completed, you can validate that your remote client is configured properly by running the following command:
```
soss test
```
Note

You should periodically re-run the Populate command if new hosts are added to the SOSS store.

Note

Gateway addresses are permanently stored in the client parameters file. If you know that a gateway address is no longer used at the remote store, you should remove it from the remote client’s client parameters file using the management tools.