Ubuntu on AWS
In this section we walk you through the steps to manually get a basic messaging configuration of the Solace PubSub+ software event broker Docker container up-and-running on an Ubuntu instance in Amazon Elastic Compute Cloud (EC2).
It's assumed you have:
- An Amazon EC2 account.
- A stable version of Docker Engine installed.
The number of CPUs and system memory required by your event broker depends on the number of client connections you need to support. By default, fresh installations of the event broker allow up to 100 client connections by default.
The following table lists the minimum number of CPUs, and the minimum value of the total memory that must be provisioned for each connection scaling tier.
Minimum System Resources Required and Recommended For Connection Scaling Tiers
|Client Connections||CPUs*||Required Minimum||Recommended Minimum|
|Virtual Memory (MiB)||Virtual Memory (MiB)||
Physical Memory (MiB)
|up to 100||2||1,903||1,903||930|
|up to 1,000||2||5,301||5,683||3,748|
|up to 10,000||4||12,892||13,266||11,321|
|up to 100,000||8||28,191||28,565||26,620|
|up to 200,000||12||53,816||53970||52,024|
*The monitoring node in a high-availability (HA) group needs only 1 CPU.
The example shown on this page is suitable for use for up to the 1,000 connection scaling tier, and is appropriately configured for testing and PoC activities. If you plan to use your event broker in a production environment, or scale above the 1,000 client connections tier, you should note that there are a number of adjustments that will be need to be made to the example and you should consult the following topics:
- General information applicable to Solace PubSub+ software event broker Docker container configuration can be found at Topics Unique to Docker Images.
- Information about setting the client scaling tier can be found at Scaling Tier Deployment Considerations.
- Information about configuring storage volumes can be found at Storage Configuration.
Use the EC2 Dashboard’s Launch Instance wizard to create an Amazon Machine Image that you can use to run an event broker.
- On the main page of the EC2 Dashboard, select the Launch Instance button.
Follow the setup wizard, and accept the recommended default settings except as noted in the following steps.
- In the Choose AMI step, choose an Amazon Machine Image (AMI) from the AWS Marketplace for the host:
- For an Ubuntu 18.04 host, Ubuntu 18.04 LTS (HVM) is recommended.
- For an Ubuntu 16.04 host, Ubuntu 16.04 LTS – Xenial (HVM) is recommended.
- In the Choose an Instance Type step, select an Instance Type based on the connection scaling tier information presented in the System Requirements section.
- In the Configure Instance Details step, set Subnet to your availability zone.
- In the Add Storage step, set the instance’s storage size and volume type.
The amount of storage to attach to the instance depends on your application. Both SSD volume types, General Purpose and Provisioned IOPS, are supported.
For test deployments, a minimum of 30 GB and General Purpose SSD are recommended.
- In the Tags step, assign a name to your instance.
You can add as many tags as required by your application.
- At a minimum, it is recommended that the security group include the following inbound rules.
Type Protocol Port Range Source Custom TCP Rule TCP 8080 0.0.0.0/0 Custom TCP Rule TCP 55555 0.0.0.0/0 SSH TCP 22 0.0.0.0/0
These port numbers are used for the following services: 22-Host SSH; 8080-SEMP / PubSub+ Manager / SolAdmin; 55555-SMF/non-compressed message data connections. Other ports can be opened as required. For a list of ports associated with event broker services, see Default Configuration for Software Event Brokers.
- Once you have completed the launch wizard steps, and have logged into your host, go ahead with installing and configuring Docker. Instructions can be found on the Docker Get Docker for Ubuntu Web page.
You should note that If you are using a t2.medium instance type, a swap file must be created once the host is up-and-running. Follow these instructions:
>sudo mkdir /var/lib/solace
>sudo dd if=/dev/zero of=/var/lib/solace/swap count=2048 bs=1MiB
>sudo mkswap -f /var/lib/solace/swap
>sudo chmod 0600 /var/lib/solace/swap
>sudo swapon -f /var/lib/solace/swap
>sudo grep -q 'solace\/swap' /etc/fstab || sudo sh -c 'echo "/var/lib/solace/swap none swap sw 0 0" >> /etc/fstab'
You have to set the
iptables options on the host system.
Systemd-Based Ubuntu Systems
For systemd-based systems, create a
daemon.json file to set the
devicemapper Docker daemon options. For test deployments, it is recommended to set
These options are set in the
daemon.json file located in
/etc/docker/. Follow these steps to set the options.
- If Docker is not stopped, then enter this command.
>sudo systemctl stop docker
- Create the
sudo tee /etc/docker/daemon.json <<-EOF
- Apply the settings.
>sudo systemctl daemon-reload
>sudo systemctl disable docker
>sudo systemctl enable docker
>sudo systemctl start docker
Pull the event broker image from the Docker repository using these two steps:
>sudo service docker start
You can use the
statuscommand to check the status of Docker.
>sudo service docker status
- Pull the image:
>sudo docker pull solace/solace-pubsub-standard
: When loading is finished, you can check the image with the
>sudo docker images
REPOSITORY TAG IMAGE ID CREATED SIZE
solace/solace-pubsub-standard latest b8a61124d92f 10 days ago 1.11GB
This example assumes that you are using Solace PubSub+ Standard. If you want to use another edition, you need to obtain the appropriate event broker package:
- Solace PubSub+ Enterprise Evaluation Edition: Go to the Solace Downloads page. Then select Download in the Solace PubSub+ Enterprise Evaluation Edition Docker Images section. You will be able to download a compressed archive file called
- Solace PubSub+ Enterprise: If you have purchased a Docker image of Solace PubSub+ Enterprise, Solace will give you information for how to download the compressed tar archive package from a secure Solace server. Contact Solace Support at email@example.com if you require assistance.
Once you've obtained the package, start Docker and load the image.
>sudo docker load -i /tmp/solace-pubsub-evaluation-<version>-docker.tar.gz
There are many options that you can set with the
docker create command that is used to build the event broker container. In this example we will show one that sets up a simple configuration suitable for a test deployment that can be used to help you become familiar with Solace PubSub+.
Systemd-Based Ubuntu Systems
- Create a
>sudo tee /root/docker-create <<-EOF
sudo docker create \
--ulimit core=-1 \
--ulimit memlock=-1 \
--ulimit nofile=2448:42192 \
--env 'username_admin_globalaccesslevel=admin' \
--env 'username_admin_password=admin' \
For production deployments, there are use-case dependent factors that will impact the option and configuration key settings in the
docker createcommand. For more information, see Docker Image Specific Topics and Scaling Tiers for Software Event Brokers.
In this example, the
adminSolace CLI user and an associated password are defined at container creation through the
username_admin_passwordconfiguration keys. By default, in an event broker container, no Solace CLI users are defined, so setting these configuration keys allows the container to be administered through the Solace SolAdmin management tool without first entering the Solace CLI to create an
In the above
docker createcommand, the values of
<tag>are dependent on the event broker Docker package you previously loaded. For example, if you pulled the
latestPubSub+ Standard image from Docker, the
solace/solace-pubsub-standardand the tag is
latest. If you loaded version 126.96.36.1992 of Solace PubSub+ Evaluation Edition, the value of
- Make the
>sudo chmod +x /root/docker-create
Create and run the event broker container on your host.
- Create the container:
Once it’s done running, a long identifier will be displayed that looks something like this:
This is the ID for the event broker container you have just created.
- Start the event broker:
>sudo docker start solace
You can use the
docker pscommand to check on the status of the event broker once it’s running.
>sudo docker ps
STATUScolumn associated with the event broker will display if the container is running and for how long.
You now have an event broker container with a basic configuration that is ready for messaging tasks. To get yourself going, you can access either of the Solace management tools PubSub+ Manager or Solace CLI to start issuing configuration or monitoring commands.
To access the Solace PubSub+ Manager:
- Open a browser and enter http://<your-event broker's-ip-address>:8080.
- Log in as user
To access the Solace CLI:
Enter the following
>sudo docker exec -it solace /usr/sw/loads/currentload/bin/cli -A
Type the following commands to enter configuration mode:
- For a list of Solace CLI commands currently supported on the event broker, refer to Software Event Broker CLI Commands.
Also, in order to fully utilize Solace's event broker features, you should familiarize yourself with the configuration operations common to both Solace PubSub+ software event brokers and appliances. For information, see the topics in the Configuration section.