Installing SolCache

This section describes how to access the SolCache functionality on a Solace router and how to install the SolCache Instances that will cache messages on standalone Linux systems.

Product Key Feature Locking

By default, the SolCache functionality is not locked on a Solace VMR. However, SolCache functionality is locked on a Solace appliance and no aspect of it is configurable or able to be displayed. When logged in to a Solace appliance, the Solace router CLI commands relating to the feature are still visible in the CLI, but when run, they fail and return an applicable error message indicating the feature is locked.

To unlock SolCache functionality on a Solace appliance, a product key provided by Solace must be entered through the Solace router CLI.

To unlock the SolCache feature on the Designated Router, enter the following CLI commands:

solace> enable

solace# admin

solace(admin)# product-key <key-value>

Where:

<key-value> is the product key provided by Solace in the form LLLLLLLLLLL-LLLLLLLLLLL-LLLLLLLLLLL-HHHH

Note:  If a product key is removed, then a system restart is triggered and all configuration related to the features unlocked by that key is lost.

Installing SolCache Instances

A SolCache Instance consists of a single SolCache process that must be installed on a standalone Linux system or a Solace router (for development purposes only) and a corresponding SolCache Instance object on a Solace router that is created through the Solace router CLI.

To install a SolCache Instance on standalone Linux systems, follow the steps in the README file included with the SolCache installation package.

The SolCache installation package is available for download. Contact Solace Support at support@solace.com if you do not have access to the Solace download site.

To configure the corresponding SolCache Instance on the Solace router, refer to Configuring SolCache Instances.

System Requirements

The SolCache application is provided for Linux systems as a 64-bit executable. The 64-bit SolCache executable requires use of the 64-bit version of the Solace Messaging Application Programming Interface (API) for C, which is distributed and installed separately.

Note:   

  • For lab and development purposes, you may install the SolCache application on a Solace 3260 appliance, and then SolCache Instances can be run on the appliance’s control plane. However, this practice is not recommended for production deployments.
  • Running SolCache Instances from the control plane is not supported on Solace 3230 appliances or Solace 3560 appliances.

Uninstalling SolCache

NOTICE: Before removing a SolCache Instance application, ensure that no running programs have their current directory set inside the SolCache installation directories while uninstalling. Any files in the installation directories that were not part of the original install process are not removed. You must remove them manually before running the uninstall process.

To uninstall a SolCache Instance from a standalone Linux system or a Solace router, follow the steps described in the README file included with the SolCache installation package.

To uninstall the corresponding SolCache Instance on the Solace router, refer to Configuring SolCache Instances.

Note:  A SolCache Instance (that is, the SolCache process) can uninstalled from the standalone Linux system or Solace router without uninstalling the corresponding SolCache Instance object. In this case, the SolCache Instance will have a Down administrative state.