Upgrading with Helm

Upgrade an existing IBM DataPower Operator deployment that was installed using helm.

Prerequisites

Platform

Review the release notes for the version you wish to upgrade to, especially noting any platform support changes (e.g., minimum Kubernetes version). Prior to attempting any Operator upgrade, ensure that the cluster meets the prerequisites for the target version you are upgrading to.

Coexistence

Review the coexistence prerequisites from the Install documentation for reference. Note that if multiple instances of DataPower Operator are installed on the same cluster, they must all be upgraded at the same time to adhere to the rule that all instances must be the same version.

Upgrade

This process assumes an upgrade is being performed on an existing Helm installation of DataPower Operator. If you do not already have DataPower Operator installed, head to the Helm install guide.

  1. Download the desired release source code ZIP or tarball. The file will be named similar to one of the following, where X.Y.Z corresponds to the version you chose:

    • datapower-operator-chart-X.Y.Z.zip
    • datapower-operator-chart-X.Y.Z.tar.gz

  2. Unpack the chart archive using your preferred tooling (e.g., unzip, tar, or some alternative). This should yield a directory named datapower-operator-chart-X.Y.Z (where X.Y.Z correspond to the version you chose in step 1).

  3. In the terminal of your choice, cd into the chart directory (example shown below). This directory should contain the Chart.yaml and values.yaml files, as well as other files and directories.

    cd datapower-operator-chart-X.Y.Z/charts/stable/datapower-operator

  4. Customize the values.yaml as desired. Review the README.md in this directory for available configuration options.

  5. Manually apply the CRDs from the Helm chart to update them in the cluster.

    for crd in crds/*; do kubectl apply -f $crd; done

  6. Upgrade the DataPower Operator using helm upgrade.

    helm upgrade datapower-operator .

    datapower-operator here is the Helm release name. This must match the name used when the helm install was done; if you do not remember the name, you can retrieve it from helm list.

  7. Validate the upgrade via helm list.

Reference