Installation

The Active Caching Management UI allows you to deploy and manage modules. In the following section, you will learn how to install and configure it.

Prerequisites

Before you install the Active Caching Management UI, you need to install and configure a ScaleOut StateServer cluster. Refer to the StateServer quick start guide for details on how to install on Windows or Linux.

Install the Active Caching Management UI

Download the Windows installer from ScaleOut Support Downloads page.
Run the MSI and go through the steps of the installation wizard:

Install_01

Accept the terms of the license agreement: Install_02

Select an installation folder: Install_03

Complete the installation: Install_04

Prerequisites

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

RHEL8 or Debian 11 based operating system
sudo privileges

# 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 ScaleOut Active Caching services
sudo rpm -i soss-ac-web-1.0.0-1.el8.x86_64.rpm

# Install the Linux trace toolkit
sudo apt-get -y install liblttng-ust0
# Install the ScaleOut Active Caching services
sudo dpkg -i soss-ac-web_1.0.0-1_amd64.deb

Allow the provided self-signed certificate

For convenience, the ScaleOut Active Caching installation comes with a self-signed TLS certificate. This self-signed certificate is not intended for production usage and should be replaced with a trusted certificate. Follow our step-by-step guide to use your trusted certificate within your domain.

If you intend to use the self-signed certificate for testing, the following steps show how to allow it on Windows and Linux.

Export the certificate

If using Chrome:

Visit the website https://localhost:9901 and click the View Certificate button in the security warning.
Go to the Details tab and click Copy to file to launch the Certificate Export Wizard.
Follow the wizard’s steps to save the certificate, ensuring you select the Base-64 encoded X.509 (.CER) format and choose a save location.

Import the certificate into the Trusted Root Certification Authorities store

Open the Start Menu, type certmgr.msc, and press Enter to open the Certificate Manager.
Navigate to Trusted Root Certification Authorities > Certificates.
Right-click on the Certificates folder, select All Tasks > Import.
In the Certificate Import Wizard, click Next, then Browse to find and select the certificate file you exported.
Click Next through the remaining steps, accepting the security warning by clicking Yes to complete the import.

Most browsers require a certificate exception for self-signed certificates. Add a certificate exception for the following URLs.

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

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

Navigating 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.

Open the ScaleOut Active Caching Management UI

On the computer where you completed the installation, open https://localhost:7701 in a web browser to access the ScaleOut Active Caching Management UI.

UI_01

Press Login to authenticate.

On that page, you can use the built-in Administrator account:

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

You can register a new account by selecting Register as a new user.

UI_02

Once authenticated, you will land on the home page of the ScaleOut Active Caching Management UI.

UI_05

Verify that the connection to your ScaleOut StateServer cluster is correct. In the left navigation pane, select Account & Settings, then click on IP Configuration.

UI_03

If you installed the ScaleOut Active Caching Management UI on the same computer as the ScaleOut StateServer cluster, you can use the default localhost address. Otherwise, enter the IP addresses of all hosts in your StateServer cluster and click Save Changes.

UI_04

ScaleOut Active Caching Management UI allows you to add and manage modules, add connections to external messaging services such as Azure IoT Hub or Kafka, and add connections to persistence services such as Dynamo DB, SQL Server or Cosmos DB.

You will also be able to create and run queries and charts for your modules, and track usage statistics.

You are now ready to build your first module.