AWS

On this page you'll find upgrade procedures for event broker AWS images.

Upgrade a Standalone AWS Cloud Image

The Solace PubSub+ software event broker Amazon Machine Image (AMI) uses the Amazon Linux OS. Solace recommends an instance replacement upgrade if you're using the AWS AMI, which will result in a newly created AWS instance for the upgraded event broker.

Starting Versions & Upgrade Paths

The starting version of your event broker must be release 10.0.1 or later to upgrade.

The procedure shown in this section describes an Enterprise to Enterprise upgrade.

On non-Enterprise event brokers, the following upgrades are also supported:

  • from Evaluation to Enterprise
  • from Standard to Standard
  • from Standard to Enterprise

For upgrades between other editions, launch the upgraded instance using the Solace AMI package for the corresponding event broker edition.

Prerequisites

  1. In order to preserve configuration and spooled messages, all storage-elements must be on one or more external storage volumes. Each storage-element is described in Managing Software Event Broker Storage. If any of your storage-elements aren't on an external storage volume, move them. As an example, this procedure assumes that the event broker has its storage-elements assigned to a single external storage volume.

    2. To review the list of available block devices and volumes, run the solacectl storage ls command, then check the block devices and storage volumes columns in the output.

  2. The Cloud-Init user data that was used when the software event broker was initialized in Initializing the Configuration for AWS are required for this procedure. All the Solace storage keys on external storage must be included. In the example below, the Cloud-Init user data is from Initializing the Configuration for AWS, and includes Solace storage keys on the sdf device.
    3. #cloud-config
    solace:
        configuration_keys:
            username_admin_globalaccesslevel: admin
            username_admin_password: adminpwd
            service_ssh_port: 22
            service_semp_port: 8080
        storage:
            adb:
                device: sdf
            adbBackup:
                device: sdf
            diagnostics:
                device: sdf
            internalSpool:
                device: sdf
            jail:
                device: sdf
            var:
                device: sdf

    The user data, excluding the Solace storage keys, can be retrieved from the instance by using the http://<broker-IP>/latest/user-data URI. For more information, refer to Instance Metadata and User Data.

  3. You need a static IP or DNS name associated with the instance. This procedure assumes that either the AWS instance is associated with an AWS elastic network interface, or, if you're using private addresses, Route 53 is used to assign a static DNS name to the instance. The network interface should have a name, and its termination behavior should be set to false. To associate an AWS instance with an elastic network interface that's associated with an elastic IP, refer to Elastic IP Addresses. To associate a Route 53 entry to the AWS instance IP, refer to DNS support for your VPC.

User accounts (username/passwords) for support/root container users aren't transferred during the upgrade procedure, and must be manually applied to the new event broker instance.

If applicable, SolGeneos and its dependencies must be manually re-installed on the new event broker instance.

Procedure

  1. Log into the event broker as sysadmin.
  2. Switch to root user:
    3. [sysadmin@solace ~]$ sudo su –
  3. Stop the solace service:
    4. [root@solace ~]$ solacectl service stop
  4. Stop the Instance in the AWS Management Console.
  5. Create a Snapshot of the Volume specified in the Prerequisites and give it a suitable description.

    6. Choose AMI

  6. Launch a new Instance using the new AMI named solace-pubsub-enterprise-<version>.
    1. Choose an Instance Type that is the same or larger.
    2. On the Configure Instance Details screen, set the same Network, Subnet, and IAM role as before.
    3. Under the Network interfaces section, select the elastic network interface specified in Prerequisites.

      4. Choose AMI

    4. Under the Advanced Details section, enter the user data specified in Prerequisites into the User data block.

      5. Choose AMI

      The device name for each storage-element must start with an “s”.

    5. On the Add Storage screen, add an additional Volume, and set the Device specified in the user data in step 2, the Snapshot from step 5, and the Size to the same or larger Size.

      6. Choose AMI

    6. Review and Launch the new Instance. When the event broker restarts, it will be running the configuration and message-spool from the previous version.
  7. Log into the event broker as admin and confirm that it's running the new version:
    8. solace> show version
  8. Terminate the stopped Instance from step 4 in the AWS Management Console.

You have completed this procedure.