Configuring PubSub+ Cache Instances

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

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

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

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

Where:

<name> is the PubSub+ Cache Instance name.

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

  • By default, a PubSub+ Cache Instance is not enabled after it is created. To enable a PubSub+ Cache Instance, refer to Enabling/Disabling PubSub+ Cache Instances.
  • For maximum fault tolerance, it is recommended that the individual PubSub+ 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 (refer to Scheduling Message Deletes).

Enabling/Disabling Auto Start Mode

The Auto Start mode enables an installed PubSub+ Cache Instance to automatically come online whenever it restarts or reconnects to the event broker. By default, Auto Start Mode is disabled.

To enable the Auto Start mode for the given PubSub+ Cache Instance, enter the following CONFIG commands:

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

The no version of this command, no auto-start, disables Auto Start mode. When disabled, an administrator must later run the start Distributed Cache Admin EXEC command to put the PubSub+ Cache Instance into service. (Refer to Performing PubSub+ Cache Administrative Tasks).

Configuring Stop On Lost Message Behavior

The stop-on-lost-message property determines how PubSub+ Cache Instances should behave when they lose a message and enter a Lost Message state (refer to Lost Message State).

If stop-on-lost-message is enabled (the default), when the PubSub+ 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 the PubSub+ 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 (refer to Performing PubSub+ Cache Administrative Tasks) is issued.

To enable “stop-on-lost-message” behavior for the given PubSub+ Cache Instance, enter the following CONFIG commands:

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

To disable “stop-on-lost-message” behavior for the given PubSub+ Cache Instance, enter the following CONFIG commands:

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

Enabling/Disabling PubSub+ Cache Instances

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

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

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

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

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

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

If the Auto Start Mode is not enabled for a PubSub+ Cache Instance (refer to Enabling/Disabling Auto Start Mode), an enabled PubSub+ Cache Instance will remain in a stopped state instead of automatically restarting and resynchronizing with the Cache Manager, and it must be administratively started (refer to Performing PubSub+ Cache Administrative Tasks).