Requirements for Portworx Backup Upgrade

Before you upgrade Portworx Backup, ensure that your environment meets the requirements listed in this section.

Back up critical data first

Before you upgrade, back up your critical Portworx Backup data. An upgrade affects the entire backup cluster and cannot be trivially reverted. See Data backup for what to capture.

Component compatibility

Review the compatibility and interoperability matrix to identify supported versions of Portworx Backup, Stork, Portworx Enterprise, and other components. Verify that your Stork and Portworx Enterprise versions are compatible with the target Portworx Backup version.

Cluster access

• kubectl access: Your kubectl context is set to the Portworx Backup cluster with admin privileges.
• Helm version: Helm 3 is installed on the machine running the upgrade command.

MongoDB pod health

All three MongoDB pods (pxc-backup-mongodb-0, pxc-backup-mongodb-1, pxc-backup-mongodb-2) must be in Ready state. The upgrade fails if any MongoDB pod is not ready. If a pod is not ready, do not attempt manual recovery. See Pre-upgrade job.

To verify, run:

kubectl get pods -n <pxb-namespace> -l app.kubernetes.io/component=pxc-backup-mongodb

Pre-upgrade job

Starting from Portworx Backup version 2.7.3, a pre-upgrade job checks the health of the pods in the MongoDB StatefulSet to ensure that they are in the Ready state before proceeding with the upgrade. The upgrade fails if all three MongoDB pods in the StatefulSet are not in the Ready state. A pod is ready only when it shows 1/1 in the READY column; a Running phase alone is not sufficient.

caution

If any MongoDB pod is not in the Ready state, do not attempt to recover or reconfigure the MongoDB replica set yourself because performing these operations incorrectly can cause permanent data loss.

Storage

Sufficient storage is available on the PVCs used by Portworx Backup components.

Database credentials

The pxc-credentials secret is present in the Portworx Backup namespace with valid database passwords. See Password Policy.

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

Data backup

Take a backup of critical data before upgrading. At a minimum, before you start the upgrade or any recovery step on this page:

• Back up or snapshot the PVCs used by the MongoDB, MySQL, and PostgreSQL StatefulSets in the Portworx Backup namespace — these hold your backup metadata and configuration.

• Save your current Helm release values so you can restore your configuration:

  helm get values --namespace <pxb-namespace> <release-name> -o yaml > values-current.yaml

• Record the pxc-credentials secret (the database passwords and encryption key) so you can recreate it if needed. Store it securely; do not commit it to source control.

What to do next

Set up the Upgrade Environment