Managing SolCache

This section describes how to configure and manage SolCache on a Solace router that is acting as the Designated Router for the SolCache facility.

Operating Limits

The global operating limits for SolCache are listed in the table below.

Note:  Performance limits such as maximum cache request rates and maximum message rates depend on the messaging patterns and sizes being used, the number of SolCache Instances being used for load balancing, and the server hardware on which SolCache Instances have been deployed. For further guidance on the expected performance of SolCache in your application environment, contact Solace support.

Global Operating Limits for SolCache



Maximum number of cached messages per cached topic 100,000,000
Maximum number of SolCache Instances per Cache Cluster 16
Maximum number of Cache Clusters per Distributed Cache 64
Maximum number of SolCache Instances supported by the Designated Router across all Message VPNs 1024
Maximum number of Cache Clusters per Designated Router 256
Maximum number of configured topics per Cache Cluster 1000
Maximum number of cached topics per SolCache Instance 4,000,000
Maximum number of Distributed Caches per Designated Router 256

Steps to Configure SolCache

The following steps show how to configure the main SolCache components on the SolCache Designated Router through the Solace CLI. The exact steps required will vary depending on your network conditions and preferred configuration.

Note:  If you want to use the Global Caching feature, so that client applications can request messages that are cached on remote Distributed Caches, additional configuration information must be provided when configuring Cache Clusters and when modifying SolCache Instance configuration files. For more information on the Global Caching feature, see Using Global Caching.

  1. Unlock the SolCache feature on the Designated Router.

    See Product Key Feature Locking.

  2. Configure a new or an existing Message VPN.

    See Configuring Message VPNs for Caching.

  3. Configure a Distributed Cache in the Message VPN.

    See Configuring Distributed Caches.

  4. Configure one or more Cache Clusters within the Distributed Cache.

    See Configuring Cache Clusters.

  5. Add subscriptions for the topics that the Cache Clusters will be responsible for listening for.

    See Assigning Topics to Cache Clusters.

  6. Configure one or more SolCache Instances within the Cache Clusters.

    See Configuring SolCache Instances.

  7. Modify a copy of the provided configuration file (included with the SolCache Instance installation package) for each SolCache Instance so that it has the appropriate configuration parameters for communicating with a Solace router host. Each modified configuration file must be saved to the Linux system or Solace router that the SolCache Instance will run on.

    This file provides a SolCache Instance with configuration information when SolCache service is invoked in the following step. For additional information, see Customizing SolCache Instance Configuration Files.

    Note:  If you are going to use the Global Caching feature be sure to review, and modify, as necessary, the Global cache request delay and Global cache request time-out parameters. For more information on Global Caching, see Using Global Caching.

  8. Following the steps described within the README file (included with the SolCache Instance installation package), to install and run the SolCache service script on Linux system or Solace router with the modified configuration file.
  9. Enable the created SolCache Instances.

    See Configuring SolCache Instances.

  10. Enable the created Cache Clusters.

    See Enabling Cache Clusters.

  11. Enable the created Distributed Cache.

    See Enabling Distributed Caches.

  12. If the Auto Start Mode was not enabled for the SolCache Instances that were created, run the start Admin EXEC command at the Distributed Cache level to put all the SolCache Instances under the Designated Cache into service. See Starting SolCache Instances.