The Solace PubSub+ Platform's software event broker efficiently streams event-driven information between applications, IoT devices and user interfaces running in the cloud, on-premises, and hybrid environments using open APIs and protocols like AMQP, JMS, MQTT, REST and WebSocket. It can be installed into a variety of public and private clouds, PaaS, and on-premises environments, and brokers in multiple locations can be linked together in an event mesh to dynamically share events across the distributed enterprise.

This project is a best practice template intended for development and demo purposes. The tested and recommended Solace PubSub+ Software Event Broker version is 9.10.

This document provides a quick getting started guide to install a software event broker in various configurations onto a Kubernetes cluster.

Detailed documentation is provided in the Solace PubSub+ Software Event Broker on Kubernetes Documentation. Consult the Deployment Coonsiderations section of the Documentation when planning your deployment.

This document is applicable to any platform supporting Kubernetes, with specific hints on how to set up a simple MiniKube deployment on a Linux-based machine. To view examples of other Kubernetes platforms see:

• Deploying a Solace PubSub+ Software Event Broker HA group onto a Google Kubernetes Engine
• Deploying a Solace PubSub+ Software Event Broker HA Group onto an OpenShift 3.11 platform
• Deploying a Solace PubSub+ Software Event Broker HA Group onto Amazon EKS (Amazon Elastic Container Service for Kubernetes): follow the AWS documentation to set up EKS then this guide to deploy.
• Install a Solace PubSub+ Software Event Broker onto a Pivotal Container Service (PKS) cluster
• Deploying a Solace PubSub+ Software Event Broker HA Group onto Azure Kubernetes Service (AKS): follow the Azure documentation to deploy an AKS cluster then this guide to deploy.

Solace PubSub+ Software Event Broker can be deployed in either a three-node High-Availability (HA) group or as a single-node standalone deployment. For simple test environments that need only to validate application functionality, a single instance will suffice. Note that in production, or any environment where message loss cannot be tolerated, an HA deployment is required.

We recommend using the Helm tool for convenience. An alternative method using generated templates is also provided.

In this quick start we go through the steps to set up a PubSub+ Software Event Broker using Solace PubSub+ Helm charts.

There are three Helm chart variants available with default small-size configurations:

1. pubsubplus-dev - recommended PubSub+ Software Event Broker for Developers (standalone) - no guaranteed performance
2. pubsubplus - PubSub+ Software Event Broker standalone, supporting 100 connections
3. pubsubplus-ha - PubSub+ Software Event Broker HA, supporting 100 connections

For other PubSub+ Software Event Broker configurations or sizes, refer to the PubSub+ Software Event Broker Helm Chart Reference.

Follow your Kubernetes provider's instructions (other options available here). Ensure you meet minimum CPU, Memory and Storage requirements for the targeted PubSub+ Software Event Broker configuration size. Important: the broker resource requirements refer to available resources on a Kubernetes node.

Note: If using MiniKube, use minikube start with specifying the options --memory and --cpu to assign adequate resources to the MiniKube VM. The recommended memory is 1GB plus the minimum requirements of your event broker.

Also have the kubectl tool installed locally.

Check to ensure your Kubernetes environment is ready:

# This shall return worker nodes listed and ready
kubectl get nodes

Follow the Helm Installation notes of your target release for your platform. Note that Helm is transitioning from v2 to v3. Some deployments still use v2. The event broker can be deployed using either version, however concurrent use of v2 and v3 from the same command-line environment is not supported.

On Linux a simple option to set up the latest stable release is to run:

(Click on the arrow to open instructions for Helm v2 or v3)

curl -sSL https://raw.githubusercontent.com/helm/helm/master/scripts/get | bash

# This enables getting started on most platforms by granting Tiller cluster-admin privileges
kubectl -n kube-system create serviceaccount tiller
kubectl create clusterrolebinding tiller --clusterrole cluster-admin --serviceaccount=kube-system:tiller
helm init --wait --service-account=tiller --upgrade # this may take some time

curl https://raw.githubusercontent.com/helm/helm/master/scripts/get-helm-3 | bash

Helm is configured properly if the command helm version returns no error.

• Add the Solace Helm charts to your local Helm repo:

  helm repo add solacecharts https://solaceproducts.github.io/pubsubplus-kubernetes-quickstart/helm-charts

• By default the publicly available latest Docker image of PubSub+ Software Event Broker Standard Edition will be used. Specify a different image or use a Docker image from a private registry if required. If using a non-default image, add the --set image.repository=<your-image-location>,image.tag=<your-image-tag> values to the commands below.
• Generally, for configuration options and ways to override default configuration values (using --set is one the options), consult the PubSub+ Software Event Broker Helm Chart Reference.
• Use one of the following chart variants to create a deployment:

(Click on the arrow to open instructions for Helm v2 or v3)

# Deploy PubSub+ Software Event Broker Standard edition for developers
helm install --name my-release solacecharts/pubsubplus-dev

# Deploy PubSub+ Software Event Broker Standard edition, standalone
helm install --name my-release solacecharts/pubsubplus

# Deploy PubSub+ Software Event Broker Standard edition, HA
helm install --name my-release solacecharts/pubsubplus-ha

# Deploy PubSub+ Software Event Broker Standard edition for developers
helm install my-release solacecharts/pubsubplus-dev

# Deploy PubSub+ Software Event Broker Standard edition, standalone
helm install my-release solacecharts/pubsubplus

# Deploy PubSub+ Software Event Broker Standard edition, HA
helm install my-release solacecharts/pubsubplus-ha

The above options will start the deployment and write related information and notes to the screen.

Note: When using MiniKube, there is no integrated Load Balancer, which is the default service type. For a workaround, execute minikube service my-release-pubsubplus-dev to expose the services. Services will be accessible directly using the NodePort instead of direct Port access, for which the mapping can be obtained from kubectl describe service my-release-pubsubplus-dev.

Wait for the deployment to complete following the information printed on the console.

Refer to the detailed PubSub+ Kubernetes documentation for:

• Validating the deployment; or
• Troubleshooting
• Modifying or Upgrading
• Deleting the deployment

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:

• The Solace Developer Portal website at: solace.dev
• Understanding Solace technology
• Ask the Solace community.