Skip to main content
Version: 3.2

Upgrade Portworx Backup

Portworx Backup supports upgrades to version n from versions n-1 or n-2. For example, if you are on Portworx Backup version 3.1.x or 3.0.x, you can directly upgrade to 3.2.0. If you are on 2.11.x or earlier and want to upgrade to 3.2.0, you need to upgrade in a phased manner. First upgrade to an intermediate version (3.0.x or 3.1.x), and then upgrade to 3.2.0.

note

The same steps in Generate Portworx Backup Spec and Upgrade Portworx Backup Using Helm apply to both internet-connected and air-gapped environments — there isn't a separate guide per environment. Air-gapped-specific instructions (for example, using a custom registry and downloading the Helm chart package locally) are called out inline within those pages wherever the steps diverge.

Upgrade workflow​

To upgrade Portworx Backup:

  1. Check the Requirements for Upgrading Portworx Backup.
  2. On the Portworx Backup cluster, set up the upgrade environment.
  3. Generate Portworx Backup Spec for the target version. Use the same Namespace, StorageClass, and installation customizations as your existing deployment. The generated spec serves as input to the Helm upgrade and should preserve your current configuration.
    To avoid disabling previously enabled components, perform the upgrade using your existing Helm values, either through a values file or with --reuse-values, instead of relying only on the newly generated spec. For more information, see Upgrade Portworx Backup Using Helm.
  4. Upgrade Portworx Backup using Helm or Argo CD.
  5. On the application cluster, upgrade Stork.

After upgrading, see the Configure and Working with Portworx Backup modules for next steps.

Prerequisites​

Before starting an upgrade, ensure the following conditions are met:

  • Check component compatibility: Verify your Stork and Portworx Enterprise versions are compatible with the target Portworx Backup version. See the Compatibility Matrix.
  • kubectl access: Your kubectl context is set to the Portworx Backup cluster with admin privileges.
  • Helm version: Helm is installed on the machine running the upgrade command. Use Helm 4.x only when you upgrade to Portworx Backup 3.2.0 or later; to upgrade to an earlier version, use Helm 3.x. A deployment that was installed or last upgraded with Helm 3.x can be upgraded to 3.2.0 or later using Helm 4.x. Helm 4.x is not supported for Portworx Backup deployments on IBM Cloud clusters; on these clusters, use Helm 3.x. For more information, see Supported Helm versions.
  • MongoDB pod health: All three MongoDB pods (pxc-backup-mongodb-0, pxc-backup-mongodb-1, pxc-backup-mongodb-2) are in Ready state. The upgrade will fail if any MongoDB pod is not ready. See Pre-upgrade job for recovery steps.
  • PVC storage: The PVCs used by Portworx Backup components have free space available. Check current usage with kubectl get pvc -n <pxb-namespace>, and confirm that the PVCs are sized for your backup count as listed in Hardware requirements (506 GB in total). See Storage.
  • pxc-credentials secret: The pxc-credentials secret is present in the Portworx Backup namespace with valid database passwords. See Password Policy.
  • Back up your data: Before you upgrade, back up or snapshot the PVCs used by the MongoDB, MySQL, and PostgreSQL StatefulSets (these hold your backup metadata and configuration), save your current Helm release values, and record the pxc-credentials secret. For the full list and the commands, see Data backup.
  • Version compatibility: Verify the target version is compatible with your current Stork and Portworx Enterprise versions. See the Compatibility Matrix.

Portworx Backup supports upgrades to version n from versions n-1 or n-2. For example, if you are on Portworx Backup version 3.1.x or 3.0.x, you can directly upgrade to 3.2.0. If you are on 2.11.x or earlier and want to upgrade to 3.2.0, you need to upgrade in a phased manner. First upgrade to an intermediate version (3.0.x or 3.1.x), and then upgrade to 3.2.0.

Upgrading to Portworx Backup 2.10.0 or above now requires the pxc-credentials secret for password management. For more information, see the Password Policy guide.

Upgrade matrix​

Portworx Backup VersionIntermediate Upgrade
Required?
Upgrade Path
3.1.xNo3.1.x → 3.2.x
3.0.xNo3.0.x → 3.2.x
2.11.xYes2.11.x → 3.0.x → 3.2.x
2.10.xYes2.10.x → 3.0.x → 3.2.x
2.9.xYes2.9.x → 2.11.x → 3.0.x → 3.2.x
2.8.xYes2.8.x → 2.10.x → 3.0.x → 3.2.x
2.7.xYes2.7.x → 2.9.x → 2.11.x → 3.0.x → 3.2.x
2.6.xYes2.6.x → 2.8.x → 2.10.x → 3.0.x → 3.2.x
2.5.xYes2.5.x → 2.7.x → 2.9.x → 2.11.x → 3.0.x → 3.2.x
2.4.xYes2.4.x → 2.6.x → 2.8.x → 2.10.x → 3.0.x → 3.2.x
2.3.xYes2.3.x → 2.5.x → 2.7.x → 2.9.x → 2.11.x → 3.0.x → 3.2.x
2.2.xYes2.2.x → 2.4.x → 2.6.x → 2.8.x → 2.10.x → 3.0.x → 3.2.x
2.1.xYes2.1.x → 2.3.x → 2.5.x → 2.7.x → 2.9.x → 2.11.x → 3.0.x → 3.2.x
caution

If you encounter an upgrade failure while upgrading to the latest version of Portworx Backup, avoid rolling back to your previous version using Helm rollback or any other methods. In such situations, do not revert to the previously installed version. Instead, reach out to the Portworx Backup Support team for assistance.

KDMP backup behavior for upgrades​

Assume that you are on Portworx Backup version 2.6.0 or below, with cloud native driver installed on your application clusters. When you upgrade to Portworx Backup version 2.7.0 and above from previous versions, the existing manual backups will not be affected:

The backups that are scheduled (to be created in the future) with the cloud native driver:

  • Get migrated to CSI snapshots along with the offload-to-backup-location option if a volume snapshot class is available

  • Use the KDMP driver to create a direct KDMP backup if a volume snapshot class is not available

    note

    Only scheduled backups created using the cloud native driver before the upgrade are migrated; backups created after the upgrade are not. Scheduled backups created with other drivers remain unchanged. One of the backups might fail after migrating from the native driver to CSI + Offload if the reconciler has not yet updated the schedule CR.

License server behavior for upgrades​

Portworx Backup 3.2.0 removes the license server from the px-central Helm chart and discontinues License Server UI support for Portworx Enterprise licenses. If you installed the license server with Portworx Backup 3.1.2 or earlier, the following applies when you upgrade to Portworx Backup 3.2.0:

  • License server: A Helm upgrade doesn't remove the license server. The license server keeps running in the Portworx Backup namespace.
  • External license server: The upgrade doesn't modify a license server that runs outside the Portworx Backup cluster.
  • Licenses: The licenses on the license server stay unchanged, including the licenses that your Portworx Enterprise clusters use.
  • License management: You can't manage Portworx Enterprise licenses from the Portworx Backup web console. Use the lsctl command-line utility to manage Portworx Enterprise licenses.
  • Portworx Backup licenses: The upgrade doesn't affect Portworx Backup licenses. You continue to manage Portworx Backup licenses from the License page in the Portworx Backup web console. For more information, see Configure licensing.
  • Argo CD: If you upgrade with Argo CD, Argo CD deletes the license server resources when you sync with the Prune option selected. To keep the license server, see the prerequisites in Upgrade Portworx Backup using Argo CD.
In this topic: