Docker for Windows

In this section we'll walk you through the steps to get a single Solace PubSub+ software event broker Docker container up-and-running in Windows using Docker Compose. If you're interested in setting up event brokers in an HA redundancy group on a Windows platform, take a look at HA Group Configuration for Windows.

Before you begin

The example shown, which makes use of Solace PubSub+ Standard, is suitable for use with up to 100 client connections and is appropriately configured for testing and PoC activities.

It's assumed you have:

  • Docker for Windows installed, with at least 2 GiB of memory dedicated to Docker for Windows. For more information about allocating memory and swap space, refer to the Docker Settings page.
  • Git installed. The Docker Compose template used in this example, that you can clone or download, is hosted in GitHub at https://github.com/SolaceLabs/solace-single-docker-compose.

Step 1: Download the Docker Compose Template

Clone the GitHub repository containing the Docker Compose template.

git clone https://github.com/SolaceLabs/solace-single-docker-compose.git
cd solace-single-docker-compose/template

Step 2: Create a PubSub+ Software Event Broker

Run the following command to create a PubSub+ software event broker using the Compose template:

docker-compose -f PubSubStandard_singleNode.yml up -d

The Compose template runs an event broker container named pubSubStandardSingleNode, using the latest PubSub+ Standard image pulled from Docker Hub, creates an admin user with global access permissions, and publishes the following event broker container ports to the same ports on the Windows host:

  • port 8080—enables SEMP management traffic to the container. Use this port when connecting to the container using the PubSub+ Manager (refer to Solace PubSub+ Manager for more information).
  • port 55555—enables SMF data to pass through the container.

To use additional services, you can edit the compose template to publish each corresponding port. For example, to enable AMQP over TLS, uncomment the appropriate line in the compose template (- '5671:5671'). For more information about the default ports used for each service, refer to Default Configuration for Software Event Brokers.

Once the container is created, it will take about 60 seconds for the event broker to finish activating.

Step 3: Manage the PubSub+ Software Event Broker

You can access the Solace management tool, PubSub+ Manager, or the Solace CLI to start issuing configuration or monitoring commands on the event broker.

Solace PubSub+ Manager management access:

  1. Open a browser and enter this url: http://localhost:8080.
  2. Log in as user admin with default password admin.

Solace CLI management access:

  1. Enter the following docker exec command:

    docker exec -it pubSubStandardSingleNode /usr/sw/loads/currentload/bin/cli -A

  2. Enter the following commands to enter configuration mode:

    solace> enable
    solace# config
    solace(configure)#

  3. Issue configuration or monitoring commands. For a list of commands currently supported on the event broker, refer to Software Event Broker CLI Commands.

Next Steps

You now have an event broker Docker container with a basic configuration that is ready for messaging tasks.

There are additional configuration tasks you can make use of in the following topics:

Also, in order to fully utilize the event broker's 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.

When you are feeling comfortable with your event broker, you can test messaging using the Solace SDKPerf application. You can download SDKPerf from the Other Software section in the Downloads page.

Frequently Used Next Steps