HiveMQ Platform Operator Upgrade Guides

The HiveMQ Platform Operator Upgrade Guides show you how to upgrade to the latest operator version. Each guide provides detailed upgrade information on upgrading your HiveMQ Platform Helm charts, HiveMQ Platform Operator, and HiveMQ Platform.

Upgrades of the HiveMQ Platform always trigger a rolling restart. Based on the HiveMQ Platform Operator version from which you upgrade, the upgrade to HiveMQ Platform Operator version 1.2.x can trigger a rolling restart. If a rolling restart is required, we recommend following the Upgrade the HiveMQ Platform Operator and HiveMQ Platform guide to ensure all changes are applied in a single rolling restart.

When you upgrade from HiveMQ Platform Operator 1.x.y to 1.2.x or above, a rolling restart is triggered. Starting with HiveMQ Platform Operator 1.2.0 an improved StatefulSet configuration avoids rolling restarts when the operator is updated.
When you migrate to the latest HiveMQ Platform Operator, the operator automatically updates the HiveMQ Platform Custom Resource Definition (CRD). The new CRD only adds new fields and is fully backward compatible.

Releases

Newer releases are drop-in replacements for previous releases. You can learn more about the new features of each HiveMQ Platform Operator version in the release blogposts. The current version is 1.3.1:

Upgrade the HiveMQ Platform Operator

To upgrade the HiveMQ Platform Operator, use the following procedure:

  1. Refresh your local Helm repositories:

    helm repo update
  2. Make sure that your-operator-values.yml file does not configure the operator version.
    If the operator version is configured in the .yml file, update the your-operator-values.yml file to the appropriate new version as follows:

    # Container image configuration
    image:
      name: hivemq-platform-operator
      initImageName: hivemq-platform-operator-init
      tag: 1.3.1
  3. Upgrade your HiveMQ Platform Operator:

    helm upgrade --install your-hivemq-operator hivemq/hivemq-platform-operator -f your-operator-values.yml -n <namespace>
  4. Verify that the operator is running with the new version.

    The command helm list returns the APP VERSION of the HiveMQ Platform Operator.
    If the upgrade is successful, the expected new version is returned.
    For example, 1.3.1.

    helm list

Upgrade the HiveMQ Platform Operator and HiveMQ Platform

To upgrade both the HiveMQ Platform Operator and the HiveMQ Platform, use the following procedure:

  1. Refresh your local Helm repositories:

    helm repo update
  2. Uninstall the running HiveMQ Platform Operator:

    helm uninstall your-hivemq-operator -n <namespace>

    If the HiveMQ Platform Operator upgrade triggers a rolling restart, this step ensures that both upgrades are performed in a single rolling restart.

  3. Upgrade your HiveMQ Platform:

    helm upgrade --install your-hivemq-platform hivemq/hivemq-platform -f your-platform-values.yml -n <namespace>
  4. Make sure that your-operator-values.yml file does not configure the operator version.
    If the operator version is configured in the .yml file, update the your-operator-values.yml file to the appropriate new version as follows:

    # Container image configuration
    image:
      name: hivemq-platform-operator
      initImageName: hivemq-platform-operator-init
      tag: 1.3.1
  5. Upgrade your HiveMQ Platform Operator.

    helm upgrade --install your-hivemq-operator hivemq/hivemq-platform-operator -f your-operator-values.yml -n <namespace>
  6. Verify that the operator is running with the new version.

    The command helm list returns the APP VERSION of the HiveMQ Platform Operator.
    If the upgrade is successful, the expected new version is returned.
    For example, 1.3.1.

    helm list