Linux Installation

This topic describes the installation process for the ScaleOut Active Caching software on RedHat Enterprise Linux and Debian 11 systems.

Prerequisites

Before installing the software, ensure that your system meets the following requirements:

RHEL8 or Debian 11 based operating system
sudo privileges
A ScaleOut cluster somewhere on your local network…

Required Packages:

# Enable the RHEL8 appstream rpms
sudo subscription-manager repos --enable rhel-8-for-x86_64-appstream-rpms

# Install the Linux trace toolkit
sudo yum install -y lttng-ust

# Install the Linux trace toolkit
sudo apt-get -y install liblttng-ust0

Local or Remote

The ScaleOut Active Caching service is a web-based UI that is hosted by a Linux daemon. You have two options for running the ScaleOut Active Caching Management UI service:

Run it locally on an existing ScaleOut StateServer host machine
Run it on a separate machine as a remote client

Note

The ScaleOut Active Caching Management UI should only be configured to run on one machine, as the internal SQLite database that it uses is not distributed. Running the UI service on multiple machines may lead to conflicts and loss of data.

Running locally

The easier configuration is to enable the service on one of your existing ScaleOut StateServer host machines. The ScaleOut Active Caching Management UI service is installed by default alongside the ScaleOut StateServer. You can skip to the Start the ScaleOut Active Caching Web Service section.

Running as a remote client

To run the ScaleOut Active Caching Management UI from a machine that is not one of the ScaleOut StateServer hosts, you will need to do two things:

Install the ScaleOut StateServer remote client and ScaleOut Active Caching Services.
Configure the remote client to communicate with the ScaleOut StateServer cluster.

1. Install the ScaleOut StateServer remote client

Installing the ScaleOut StateServer remote client will also install the ScaleOut Active Caching Services.

Download the appropriate ScaleOut StateServer Remote Client installer from ScaleOut Support Downloads page.
Run the installation command:

rpm -i  soss-remcli-6.1.1-400.el9.x86_64.rpm

dpkg -i soss-remcli_6.1.1.400_amd64.deb

2. Configure the remote client to communicate with the ScaleOut StateServer cluster

On Linux, configuring the remote client is done through the command line.

First, add a gateway to one of the hosts in your ScaleOut StateServer cluster:

soss add <mgt_port>,<gateway_IP>,<gateway_port>

Where

mgt_port: remote store’s management port
gateway_IP: gateway IP address for a host in the remote cluster
gateway_port: the server port for the remote host specified by gateway_IP

For example, if you are trying to connect to a host 10.10.0.1, which is configured with the server port 721 and management port 720, the command will look like:

soss add 720,10.10.0.1,721

If you have multiple hosts in your cluster, you can repeat the operation with each host’s IP address, or you can use the following command to populate other gateways to the other hosts in the remote cluster:

soss populate

Once this is all completed, you can validate that your remote client is configured properly by running the following command:

soss test

Start the ScaleOut Active Caching Web Service

Once installed, start the ScaleOut Active Caching service:

sudo systemctl start soss-ac-web

To configure the service to start automatically on system boot, run the following command:

sudo systemctl enable soss-ac-web

Install Self-Signed Certificate

Note

Before using the UI, install the provided self-signed certificate. For production usage, replace the self-signed certificate with a trusted certificate. Follow our step-by-step guide to use a trusted certificate within your domain.

Service	Browser Certificate Exception
`soss-ac-web`	https://localhost:7701
`soss-ac-msg`	https://localhost:8801

In Mozilla Firefox, you can add a certificate exception by:

Navigate to Settings (alternatively, type about:preferences into the search bar).
Click Privacy and Security.
Scroll down to the Certificates section and select View Certificates.
Click Servers
Click Add Exception
For location, enter one of the service URLs – i.e. https://localhost:7701.
Click Get Certificate.
Click Confirm Security Exception.
Repeat for all service URLs.

Caution

Generate and install a certificate following our step-by-step guide. The provided self-signed certificate is not intended for production usage.

First Time Log in

Open the ScaleOut Active Caching Management UI (https://localhost:7701). Press Login and use the built-in admin user:

Email: admin@localhost.net
Password: Sc@le0ut

To register new users or manage passwords and membership roles, please refer to the Manage Users page.

Installed Services and Components

The Linux installers install three systemd services on the machine:

Service	Port	Summary
`soss-ac-web`	7701	Used to access the ScaleOut Active Caching UI.
`soss-ac-msg`	8801	Used for sending messages to msg modules.

The working directory, binaries, configuration, and log file locations of these services are:

Service	File Location	Log File Location
`soss-ac-web`	/usr/lib/soss-ac/soss-ac-web	/var/log/soss/ac_web_log…
`soss-ac-msg`	/usr/lib/soss-ac/soss-ac-msg	/var/log/soss/ac_msg_rest…