Configuring Solace Cache Instances

To create a Solace Cache Instance object in the given Cache Cluster, enter the following Distributed Cache CONFIG command:

solace(configure/distributed-cache/cache-cluster)# create cache-instance <name>

To edit properties for the given Solace Cache Instance object, enter the following Distributed Cache CONFIG command:

solace(configure/distributed-cache/cache-cluster)# cache-instance <name>

Where:

<name> is the Solace Cache Instance name.

The no version of this command, no cache-instance, deletes the given Solace Cache Instance object and any messages that it has cached.

  • By default, a Solace Cache Instance is not enabled after it is created. To enable a Solace Cache Instance, see Enabling and Disabling Solace Cache Instances.
  • For maximum fault tolerance, Solace recommends that the individual Solace Cache Instances in a Cache Cluster be deployed on separate servers that have had their clocks synchronized to each other. As messages are time-stamped and synchronized within a Cache Cluster, synchronizing the clocks between separate servers ensures the correct operation of both the message synchronization mechanism and scheduled deletions of all cached message content from the Distributed Cache (see Scheduling Message Deletion).

You can perform the following operations for a Solace Cache Instance:

Enabling Auto Start Mode

Auto Start mode enables a Solace Cache Instance to come online automatically whenever it restarts or reconnects to the event broker. By default, Auto Start Mode is disabled.

To enable Auto Start mode for a Solace Cache Instance, enter the following CONFIG commands: 

solace(configure/distributed-cache/cache-cluster)# cache-instance <name>
solace(configure/distributed-cache/cache-cluster/cache-instance)# auto-start

The no version of this command, no auto-start, disables Auto Start mode. When disabled, an administrator must run the start Distributed Cache Admin EXEC command to put the Solace Cache Instance into service. (See Starting Solace Cache Instances).

Configuring Stop On Lost Message Behavior

The stop-on-lost-message property determines how Solace Cache Instances behave when they lose a message and enter a Lost Message State.

If stop-on-lost-message is enabled (the default), when a Solace Cache Instance loses a message, it generates a message lost event, and enters a stopped state (that is, it continues to cache messages, but it cannot accept or respond to cache requests).

If stop-on-lost-message is disabled, when a Solace Cache Instance loses a message, it generates a message lost event but continues operating. Note that further message lost events are not generated until a clear-event command is issued. For more information, see Performing Solace Cache Administrative Tasks.

To enable stop-on-lost-message behavior for a Solace Cache Instance, enter the following CONFIG commands: 

solace(configure/distributed-cache/cache-cluster)# cache-instance <name>
solace(configure/distributed-cache/cache-cluster/cache-instance)# stop-on-lost-message

To disable stop-on-lost-message behavior for a Solace Cache Instance, enter the following CONFIG commands: 

solace(configure/distributed-cache/cache-cluster)# cache-instance <name>
solace(configure/distributed-cache/cache-cluster/cache-instance)# no stop-on-lost-message

Enabling and Disabling Solace Cache Instances

When a Solace Cache Instance is enabled, its associated Solace Cache Instance process can cache new data and handle cache requests for its assigned topic subscriptions.

When a Solace Cache Instance is shut down, its topic subscriptions are withdrawn, and its associated Solace Cache Instance process ceases to cache new data and handle cache requests. However, that Solace Cache Instance maintains its content during this time (subject to normal message lifetime aging).

To enable a Solace Cache Instance, enter the following CONFIG commands:

solace(configure/distributed-cache/cache-cluster)# cache-instance <name>
solace(configure/distributed-cache/cache-cluster/cache-instance)# no shutdown

To disable a Solace Cache Instance, enter the following CONFIG commands:

solace(configure/distributed-cache/cache-cluster)# cache-instance <name>
solace(configure/distributed-cache/cache-cluster/cache-instance)# shutdown

If Auto Start mode is not enabled for a Solace Cache Instance (see Enabling Auto Start Mode), an enabled Solace Cache Instance remains in a stopped state instead of automatically restarting and resynchronizing with the Cache Manager, and it must be administratively started (see Performing Solace Cache Administrative Tasks).