Quickstart steps to get Solace community VMR running in Google Cloud Platform
Switch branches/tags
Nothing to show
Clone or download
Latest commit c952d80 Jun 11, 2018


Install a Solace Message Router onto a Google Compute Engine Linux Virtual Machine

The Solace Virtual Message Router (VMR) provides enterprise-grade messaging capabilities deployable in any computing environment. The VMR provides the same rich feature set as Solace’s proven hardware appliances, with the same open protocol support, APIs and common management. The VMR can be deployed in the datacenter or natively within all popular private and public clouds.

How to Deploy a VMR

  • [Optional] By default this project installs the Solace PubSub+ software message router, Standard Edition. If you want to install a different version you will have to provide link to version and accompanying md5sum files with the --url and --md5sum flags for solos-install. Visit http://dev.solace.com/downloads/ to see options and read release notes to understand differences.

  • Go to your Google Cloud Platform console and create a Compute Engine instance. Select standard 2 vCPU machine type, and at least 6 GB of memory, a CentOS 7 OS, and a disk with a size of at least 30 GB depolyed on Centos7 OS:

alt text

  • Expand the the Management tab to expose the Automation Startup script panel

alt text

Cut and paste the code into the panel, replace -link to VMR Docker Image- with the URL you received in step one.

if [ ! -f /var/lib/solace ]; then
  mkdir /var/lib/solace
  cd /var/lib/solace
  yum install -y wget
  while [ $LOOP_COUNT -lt 3 ]; do
    wget https://raw.githubusercontent.com/SolaceLabs/solace-gcp-quickstart/master/solos-install.sh
    if [ 0 != `echo $?` ]; then 
  if [ ${LOOP_COUNT} == 3 ]; then
    echo "`date` ERROR: Failed to download initial install script exiting"
    exit 1
  chmod +x /var/lib/solace/solos-install.sh
  /var/lib/solace/solos-install.sh -p <SolOS/SolAdmin password>

Now hit the "Create" button on the bottom of this page. This will start the process of starting the GCE instance, installing Docker and finally download and install the VMR. It is possible to access the VM before the entire Solace solution is up. You can monitor /var/lib/solace/install.log for the following entry: "'date' INFO: Install is complete" to indicate when the install has completed.

Set up network security to allow access

Now that the VMR is instantiated, the network security firewall rule needs to be set up to allow access to both the admin application and data traffic. Under the "Networking -> VPC network -> Firewall rules" tab add a new rule to your project exposing the required ports:

alt text tcp:80;tcp:8080;tcp:1883;tcp:8000;tcp:9000;tcp:55003;tcp:55555

For more information on the ports required for the message router see the configuration defaults . For more information on Google Cloud Platform Firewall rules see Networking and Firewalls

Gaining admin access to the VMR

For persons used to working with Solace message router console access, this is still available with the google compute engine instance. Access the web ssh terminal window by clicking the [ssh] button next to your VMR instance, then launch a SolOS cli session:

alt text sudo docker exec -it solace /usr/sw/loads/currentload/bin/cli -A

For persons who are unfamiliar with the Solace mesage router or would prefer an administration application, the imbedded PubSub+ Manager is available. For more information on PubSub+ Manager see the PubSub+ Manager page. Management IP will be the Public IP associated with youe GCE instance and port will be 8080 by default.

alt text

Testing data access to the VMR

To test data traffic though the newly created VMR instance, visit the Solace developer portal and and select your preferred programming langauge to send and receive messages. Under each language there is a Publish/Subscribe tutorial that will help you get started.

alt text


Please read CONTRIBUTING.md for details on our code of conduct, and the process for submitting pull requests to us.


See the list of contributors who participated in this project.


This project is licensed under the Apache License, Version 2.0. - See the LICENSE file for details.


For more information about Solace technology in general please visit these resources: