Backing Up and Restoring HA Software Event Broker Configurations

This section provides instructions on how to back up and restore configuration for high-availability (HA) Solace PubSub+ software event brokers running Guaranteed Messaging.

Do not use this procedure for event broker services in PubSub+ Cloud. Using this procedure in PubSub+ Cloud may result in a degradation of service. Instead, see Backing up Event Broker Services for more information.

Some configuration information is not backed up, including:

  • product keys
  • TLS/SSL server certificate files
  • TLS/SSL server certificate configuration
  • client certificates for the following:
    • Message VPN bridges
    • replication bridges
    • rest delivery points
    • Dynamic Message Routing (DMR)
    • Multi-Node Routing (MNR)
  • Kerberos Keytabs
  • trusted-root configuration (for appliances prior to software version 8.2.0 and software event brokers prior to version 8.7.0)
  • interface configuration (IP addresses, LAGs)
  • hostname and router name
  • software broker storage group
  • software broker scaling parameters
  • monitoring agents running in the broker (Datadog, SolGeneos)

In addition, messaging data is not backed up, including:

  • the guaranteed message spool
  • queued messages
  • replay log messages

Before you begin

In the example that follows, the naming convention for the software event brokers is as follows:

  • Primary event broker: solace-primary
  • Backup event broker: solace-backup
  • Monitoring event broker: solace-monitor

Backing Up Configurations

To back up the config on each of the event brokers in an HA configuration, run the following commands.

On the primary:

solace-primary# copy current-config /configs/cfg_primary_AD_active

On the backup:

solace-backup# copy current-config /configs/cfg_backup_AD_inactive

On the monitoring node:

solace-monitor# copy current-config /configs/cfg_monitor

The above commands will save a configuration backup file to the /usr/sw/jail/configs/ directory on each of the event brokers. For example, to see the backup file that was created on the primary event broker, run the dir configs command:

solace-primary# dir configs
-rw-rw----    admin solgroup     9523 Jan 21 09:41 cfg_primary_AD_active

Rolling Back to a Previous Configurations

To rollback to a previous Guaranteed Messaging config used by HA software event brokers, use the following procedure.

This procedure results in the loss of all spooled messages on the HA software event brokers.

This is not an in-service restoration, so no messaging services are available for most of this procedure.

  1. Restore the monitoring node's configuration:

    2. solace-monitor# reload config cfg_monitor

  2. Reset and rollback the primary event broker to the previous config:

    3. solace-primary# configure
    solace-primary(configure)# redundancy
    solace-primary(configure/redundancy)# shutdown
    solace-primary(configure/redundancy)# exit
    solace-primary(configure)# hardware message-spool
    solace-primary(configure/hardware/message-spool)# shutdown
    solace-primary(configure/hardware/message-spool)# end

     

    solace-primary# admin
    solace-primary(admin)# system message-spool
    solace-primary(admin/system/message-spool)# reset
    solace-primary(admin/system/message-spool)# end
    solace-primary# reload config cfg_primary_AD_active

     

    solace-primary# configure
    solace-primary(configure)# hardware message-spool
    solace-primary(configure/hardware/message-spool)# shutdown
    solace-primary(configure/hardware/message-spool)# end

  3. Shutdown redundancy and the message-spool on the backup event broker:

    4. solace-backup# configure
    solace-backup(configure)# redundancy
    solace-backup(configure/redundancy)# shutdown
    solace-backup(configure/redundancy)# exit
    solace-backup(configure)# hardware message-spool
    solace-backup(configure/hardware/message-spool)# shutdown
    solace-backup(configure/hardware/message-spool)# end

     

    solace-backup# admin
    solace-backup(admin)# system message-spool
    solace-backup(admin/system/message-spool)# reset
    solace-backup(admin/system/message-spool)# end

  4. Re-enable the message-spool and redundancy on the primary event broker:

    5. solace-primary# configure
    solace-primary(configure)# hardware message-spool
    solace-primary(configure/hardware/message-spool)# no shutdown
    solace-primary(configure/hardware/message-spool)# exit
    solace-primary(configure/hardware)# exit

     

    solace-primary(configure)# redundancy
    solace-primary(configure/redundancy)# no shutdown

  5. Restore the backup event broker's configuration:

    6. solace-backup# reload config cfg_backup_AD_inactive

  6. Optional: If the backup event broker comes up active, you may wish to revert activity back to the primary by doing a revert-activity on the backup event broker:

    solace-backup# admin
    solace-backup(admin)# redundancy revert-activity
    solace-backup(admin)# end

  7. If config-sync is out of sync, perform an assert-leader router command as described in Asserting Event Broker System Configurations, and an assert-leader message-vpn command as described in Asserting Event Brokers VPN Configurations.