Setting Scaling Parameters for a Single Software Event Broker

To increase the maximum number of client connections for a software event broker with Solace CLI, perform the following steps:

This procedure changes system-wide scaling parameters. Upon completion, you may need to modify other parameters for individual Message VPNs. For example, you may need to modify the maximum number of client connections permitted for a specific Message VPN (Configuring Maximum Connections) or for a specific client profile (see Configuring Max Connections Per Username). For more information, see Configuring Message VPNs.

System scaling parameters can only be increased.

This procedure is service affecting. To change system scaling parameters, you must shut down the message backbone and message spool.

Step 1: Review the System Resource Requirements

Before changing scaling parameters, review the system resources that are required and ensure that your system is adequately provisioned for the new values you plan to set. See System Resource Requirements and Modifying System Limits Using System Scaling Parameters.

When you set the maximum connections for containers, you may also need to set some docker create options in accordance with the new value. For detailed information, refer to the Docker Create Options page.

Step 2: Increase the Value of the Scaling Parameter(s)

  1. In the Solace CLI, enter the show system command to review the current scaling values:
    ip-132-42-25-151>show system
    
    System Uptime: 1d 4h 46m 13s
    Last Restart Reason: None
    
    Scaling:
       Max Connections: 100
       Max Queue Messages: 100M
    
    Topic Routing:
       Subscription Exceptions: Enabled
       Subscription Exceptions Defer: Enabled
  2. Shut down the msg-backbone service and message-spool.
    ip-132-42-25-151> enable
    ip-132-42-25-151# configure
    ip-132-42-25-151(configure)# service msg-backbone shutdown
    All clients will be disconnected.
    Do you want to continue (y/n)? y
    ip-132-42-25-151(configure)# hardware message-spool shutdown
    All message spooling will be stopped.
    Do you want to continue (y/n)? y
    
  3. Increase the required scaling parameter value.

    You can increase the values of the following system scaling parameters:

    For example, Step 1 shows that the initial value of the client connection limit is 100. To increase the connection limit to 1,000, enter the following commands:

    ip-132-42-25-151(configure)# system
    ip-132-42-25-151(configure/system)# scaling
    ip-132-42-25-151(configure/system/scaling)# max-connections 1000
    This command causes a reload of the system.
    Do you want to continue (y/n)? y
    
    Moving ADB messages to disk  : 100%
    Backing up ADB config to disk: 100%
    
    Performing database consolidation
  4. Changing the value of system scaling parameters causes the system to reload, stopping the container. In machine images, the container automatically restarts. For container images, you may need to manually restart the container, depending on the restart policy of your container runtime.

  5. Restart the container if required, then enter the CLI again and confirm the new parameter has been applied. In this example, the maximum number of client connections has been increased to 1,000.
    ip-132-42-25-151> show system
    
    System Uptime: 0d 0h 0m 11s
    Last Restart Reason: User request
    
    Scaling:
       Max Connections: 1000
       Max Queue Messages: 100M
    
    Topic Routing:
       Subscription Exceptions: Enabled
       Subscription Exceptions Defer: Enabled
  6. Optionally, repeat the preceding two steps to increase another scaling parameter.
  7. To resume messaging you must restart the msg-backbone service and message-spool.
    ip-132-42-25-151> enable
    ip-132-42-25-151# config
    ip-132-42-25-151(configure)# no hardware message-spool shutdown
    ip-132-42-25-151(configure)# no service msg-backbone shutdown