Add a valid license to HiveMQ Cluster

Owned by Harsh Bansal
Last updated: Feb 26, 2024
2 min read

Prequisite:

Please skip this step if you are using a HiveMQ trial license. If you do not have a valid HiveMQ license, the HiveMQ cluster uses a trial licence that allows up to 25 concurrent client connections and is limited to testing and evaluation purposes only. To obtain a HiveMQ licence that is suitable for production use, or request an evaluation licence that allows more connections, contact our customer service team.

Create a License ConfigMap

If you have a valid HiveMQ license, create a hivemq-license Kubernetes ConfigMap from your licence file to make the licence information accessible for the HiveMQ deployment you execute in the next step.

  1. Download your license file. In our case the license name is hivemq-license.lic (Please replace hivemq-license.lic with your license name if it is different or rename the file)

kubectl create configmap hivemq-license --from-file=hivemq-license.lic

  1. Open your values.yaml file in a text editor

  2. Search the hivemq-license configmap

configMaps: [] # ConfigMaps to mount to the HiveMQ pods. These can be mounted to existing directories without shadowing the folder contents as well. #- name: hivemq-license # path: /opt/hivemq/license

  1. Uncomment the name and path variables, please make sure that name and path are properly aligned under configMaps

configMaps: # ConfigMaps to mount to the HiveMQ pods. These can be mounted to existing directories without shadowing the folder contents as well. - name: hivemq-license path: /opt/hivemq/license

  1. Save the file

  2. Apply the changes to the cluster

Verify License

Please make sure that pods are running successfully after the change, it may take some time for the pods to be ready

Check the Hivemq deployment log by running the following

  • If the log contains something similar to INFO - Using valid XYZ license, the license is successfully applied.

  • If the license is not correctly applied, you will see the following in logs

Next steps