Skip to content

Latest commit

 

History

History
118 lines (92 loc) · 13.2 KB

README.md

File metadata and controls

118 lines (92 loc) · 13.2 KB
Raw

Solace PubSub+ Software Event Broker - Helm Chart

The Solace PubSub+ Platform's software event broker efficiently streams event-driven information between applications, IoT devices and user interfaces running in 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.

Overview

This chart bootstraps a single-node or HA deployment of a Solace PubSub+ Software Event Broker on a Kubernetes cluster using the Helm package manager.

Detailed documentation is provided in the Solace PubSub+ Software Event Broker on Kubernetes Documentation.

Prerequisites

  • Kubernetes 1.10 or later platform with adequate CPU and memory and storage resources for the targeted scaling tier requirements
  • Helm package manager v3 client installed
  • If using a private container image registry, load the PubSub+ Software Event Broker container image and for signed images create an image pull secret
  • With persistent storage enabled (see in Configuration):
    • Specify a storage class unless using a default storage class in your Kubernetes cluster

Also review additional deployment considerations.

Create a deployment

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

Note: the release name is not recommended to exceed 28 characters

Use a deployment

Obtain information about the deployment and services:

helm status my-release

Refer to the detailed PubSub+ Kubernetes documentation for:

Delete a deployment

helm delete my-release
kubectl get pvc | grep data-my-release
# Delete any PVCs related to my-release

Important: Ensure to delete existing PVCs if reusing the same deployment name for a clean new deployment.

Configuration

The following table lists the configurable parameters of the PubSub+ chart and their default values. For a detailed discussion refer to the Deployment Considerations in the PubSub+ Kubernetes documentation.

There are several ways to customize the deployment:

  • Override default values using the --set key=value[,key=value] argument to helm install. For example,
helm install my-release \
  --set solace.redundancy=true,solace.usernameAdminPassword=secretpassword \
  solacecharts/pubsubplus
  • Another option is to create a YAML file containing the values to override and pass that to Helm:
# Create file
echo "# Overrides:
solace:
  redundancy: true
  usernameAdminPassword: secretpassword" > my-values.yaml
# Now use the file:
helm install --name my-release -f my-values.yaml solacecharts/pubsubplus

Note: as an alternative to creating a new file you can download the values.yaml file with default values and edit that for overrides.

For more ways to override default chart values, refer to Customizing the Helm Chart Before Installing.

Parameter Description Default
nameOverride Kubernetes objects will be named as <release-name>-nameOverride Undefined, default naming is <release-name>-<chart-name>
fullnameOverride Kubernetes objects will be named as fullnameOverride Undefined, default naming is <release-name>-<chart-name>
solace.redundancy false will create a single-node non-HA deployment; true will create an HA deployment with Primary, Backup and Monitor nodes false
solace.podDisruptionBudgetForHA true will set up a Pod disruption budget for the PubSub+ broker in HA deployment, false does not set up a pod disruption budget. HA deployment with Primary, Backup and Monitor nodes requires a minimum of 2 nodes to reach a quorum, the pod disruption budget is defaulted to 2 minimum nodes when enabled. false
solace.size Event broker simple vertical scaling by number of client connections. Ignored if solace.systemScaling is set. Options: dev (requires minimum resources but no guaranteed performance), prod100, prod1k, prod10k, prod100k, prod200k. prod100
solace.systemScaling.* Event broker fine-grained vertical scaling definition. If defined, all sub-settings must be provided and these settings will override solace.size. For scaling documentation, look for "system scaling" at docs.solace.com. Use the online calculator to determine CPU, Memory and Storage requirements for "Container (messaging)" type.
maxConnections: max supported number of client connections
maxQueueMessages: max number of queue messages, in millions of messages
maxSpoolUsage: max Spool Usage, in MB. Also ensure adequate storage.size parameter, use the calculator
cpu: CPUs in cores
memory: host Virtual Memory, in MiB		 Undefined
solace.podModifierEnabled Enables modifying (reducing) CPU and memory resources for Monitoring nodes in an HA deployment. Also requires the "solace-pod-modifier" Kubernetes admission plugin deployed to work. Undefined, meaning not enabled.
solace.usernameAdminPassword The password for the "admin" management user. Will autogenerate it if not provided. Important: refer to the the information from helm status how to retrieve it and use it for helm upgrade. Undefined, meaning autogenerate
solace.timezone Timezone setting for the PubSub+ container. Valid values are tz database time zone names. Undefined, default is UTC
solace.extraEnvVars List of extra environment variables to be added to the PubSub+ container. A primary use case is to specify configuration keys. Important: env variables defined here will not override the ones defined in solaceConfigMap. Undefined
solace.extraEnvVarsCM The name of an existing ConfigMap containing extra environment variables Undefined
solace.extraEnvVarsSecret The name of an existing Secret containing extra environment variables (in case of sensitive data) Undefined
image.repository The image repo name and path to the PubSub+ container image solace/solace-pubsub-standard
image.tag The Solace container image tag. It is recommended to specify an explicit tag for production use For possible tags, refer to the Solace Docker Hub repo latest
image.pullPolicy Image pull policy IfNotPresent
image.pullSecretName Name of the ImagePullSecret to be used with the PubSub+ container image registry Undefined, meaning no ImagePullSecret used
securityContext.enabled true enables to using defined fsGroup and runAsUser. Set to false if fsGroup and runAsUser conflict with PodSecurityPolicy or Openshift SCC settings. true meaning fsGroup and runAsUser used
securityContext.fsGroup Specifies fsGroup in pod security context set to default non-zero id 1000002
securityContext.runAsUser Specifies runAsUser in pod security context set to default PubSub+ appuser id 1000001
serviceAccount.create true will create a service account dedicated to the deployment in the namespace true
serviceAccount.name Refer to https://helm.sh/docs/topics/chart_best_practices/rbac/#using-rbac-resources Undefined
tls.enabled Enable to use TLS to access exposed broker services false (not enabled)
tls.serverCertificatesSecret Name of the Kubernetes Secret that contains the certificates - required if TLS is enabled Undefined
tls.certFilename Name of the Certificate file in the serverCertificatesSecret tls.crt
tls.certKeyFilename Name of the Key file in the serverCertificatesSecret tls.key
service.type How to expose the service: options include ClusterIP, NodePort, LoadBalancer LoadBalancer
service.annotations service.annotations allows to add provider-specific service annotations Undefined
service.ports Define PubSub+ service ports exposed. servicePorts are external, mapping to cluster-local pod containerPorts initial set of frequently used ports, refer to values.yaml
storage.persistent false to use ephemeral storage at pod level; true to request persistent storage through a StorageClass true, false is not recommended for production use
storage.slow true to indicate slow storage used, e.g. for NFS. false
storage.customVolumeMount customVolumeMount can be used to specify a YAML fragment how the data volume should be mounted instead of using a storage class. Undefined
storage.useStorageClass Name of the StorageClass to be used to request persistent storage volumes Undefined, meaning to use the "default" StorageClass for the Kubernetes cluster
storage.size Size of the persistent storage to be used; Refer to the Solace documentation and online calculator for storage size requirements 30Gi
storage.monitorStorageSize If provided this will create and assign the minimum recommended storage to Monitor pods. For initial deployments only. 1500M
storage.useStorageGroup true to use a single mount point storage-group, as recommended from PubSub+ version 9.12. Undefined or false is legacy behavior. Note: legacy mount still works for newer versions but may be deprecated in the future. Undefined