HiveMQ Helm charts

This repository contains the HiveMQ Helm charts.

• The HiveMQ Platform Operator Helm chart (new)

  • This chart deploys the latest HiveMQ Platform Operator that installs and manages your HiveMQ Platform clusters in Kubernetes.

• The HiveMQ Platform Helm charts (new)

  • This chart specifies the HiveMQ Platform deployment that the HiveMQ Platform Operator then installs.

• The HiveMQ Operator Helm charts (legacy)

  • This chart deploys the legacy HiveMQ Operator and a HiveMQ cluster.

• The HiveMQ Swarm Helm charts

  • This chart deploys a HiveMQ Swarm cluster, an advanced IoT testing and simulation tool.

Documentation

See the HiveMQ Kubernetes documentation for more detailed information.

Register the HiveMQ Helm chart repository

Add the HiveMQ Helm Chart repository to your local Helm setup:

helm repo add hivemq https://hivemq.github.io/helm-charts
helm repo update

Refer to the individual Helm chart instructions for usage.

Manifests

The manifest folder contains the rendered yaml files of the Helm charts with default values. The manifests can be modified, configured, and used for manual deployment with kubectl.

Examples

The examples folder contains configuration examples for each of the Helm charts. This folder also contains yaml files that are helpful for specific environments such as Openshift.

Tests

Integration tests are split into two Gradle submodules. One submodule for the HiveMQ Platform Operator (new): tests-hivemq-platform-operator and another submodule for the HiveMQ Operator (legacy): tests-hivemq-operator.

Verifying charts

We sign the HiveMQ Helm charts with PGP keys during the packaging. These signed charts have a .prov file generated alongside the packaged chart, which includes the chart and the signature.

To verify the authenticity of the charts, download the public PGP key and import the public key into your GPG keyring. Then use helm verify or helm install --verify command to verify the chart integrity. Check our documentation for more detailed information.

NOTE Helm does not support GPG version 2 or higher so you have to convert your GPG keyring to the legacy GPG format:

gpg --export >~/.gnupg/pubring.gpg

Contributing

If you want to contribute to HiveMQ Helm Charts, see the contribution guidelines.

NOTE Every PR to master must imply an increased minor version of the chart to indicate that the templating has changed.

License

HiveMQ Helm Charts is licensed under the APACHE LICENSE, VERSION 2.0. A copy of the license can be found here.