Health check matrix
The health check process is designed to run on your backup cluster to ensure a smooth and reliable installation or upgrade of Portworx Backup. The checks are categorized based on the operations being performed; Install or Upgrade. The following matrix helps to know more on the checks that Portworx Backup performs before install or upgrade to ensure that the prerequisites are met:
| Check | Purpose | Pre-Install | Pre-Upgrade |
|---|---|---|---|
| Kubernetes version check | Validate Kubernetes version and log a warning if unsupported. | ✔️ | ✔️ |
| Namespace quota check for PVCs | Ensure namespace (where PXB will be deployed) resource quota meets PVC storage requirements; fail if insufficient. | ✔️ | |
| Storageclass check | Verify if the specified storage class exists and it is not empty; fail installation if not found. | ✔️ | ✔️ |
| Check for existing PVCs | Abort installation if stale PVCs exist and prompt cleanup. (It only aborts if the stale PVCs have the same name as the PXB-related PVCs. It will not abort if any other pre-existing PVCs are present in the namespace) | ✔️ | |
| Port information check in Helm notes | Checks if the required ports are open or not and points to Network prerequisites | ✔️ | ✔️ |
| Perform health check before upgrade | Block upgrades if any critical pods are unhealthy. | ✔️ | |
Delete the pxcentral-post-install-hook job before upgrade | Automatically delete the job and proceed with the installation. If the job is in error state, health check dumps the logs and proceeds further with the installation. | ✔️ | |
| Provide the list of warnings in an easy-to-access way | Store warnings in a ConfigMap report for the user to view them later. | ✔️ | ✔️ |
| Generate a pre-install/pre-upgrade report to show warnings and validations | Summarize validation results and warnings in a user-accessible report. | ✔️ | ✔️ |
Provide a force install/upgrade flag (skipValidations flag) | Add an override mechanism for debugging with explicit warnings. | ✔️ | ✔️ |
| Block the upgrade for unsupported paths | Restrict upgrades from versions older than n-2 to prevent failures. | ✔️ | |
| Block the install for file system-based provisioners | Validate provisioner type and fail installation for file system-based provisioners. | ✔️ | |
| Block install or upgrade if the images are incorrect | Validate image details in both internet-connected and/or air-gapped clusters; block installation or upgrade for invalid repos, registries, images or tags. | ✔️ | ✔️ |