Skip to main content
Version: 3.0

Backup Resources State Matrix

Applicable to both Classic and Federated modes

The Backup resources state matrix provides an overview of the various resources and their operational states within the Portworx Backup ecosystem. It offers insights into the functionality, status, and potential issues associated with states of each Portworx Backup resource.

This matrix serves as a comprehensive guide for understanding the current state and behavior of various resources in the Portworx Backup framework, enabling efficient troubleshooting, resource management, and operational planning:

Portworx Backup ResourceStatesApplicable operation mode
Backup location
  • Valid: suitable for creating manual or scheduled backups
  • Invalid: validation of the backup location failed, preventing Portworx Backup from accessing or restoring backups from it

In Federated mode, backup location validation is performed by Stork on each application cluster using Workload Identity. A backup location may be valid for one cluster but invalid for another.

Both
Users and user groups
  • Unknown: user is deleted from Keycloak or user data is not cached due to API way accessing Portworx Backup
Both
Clusters
  • Active: fully operational and accessible; users can perform all Portworx Backup operations such as creating backups, restores, and schedules
  • Disconnected: issues like incorrect Kubeconfig, missing Stork installation, expired Kubernetes token, or cluster inaccessibility
  • Not Available: expired Kubeconfig or inaccessible cluster (possibly down)

In Federated mode, clusters refer to Gardener shoot clusters or other application clusters managed by Stork. The Portworx Backup server sends instructions to each cluster but does not directly access backup locations.

Both
Virtual Machines
  • Paused: pre-exec and post-exec rules fail
  • Running: virtual machine is operational
  • Stopped: pre-exec and post-exec rules fail
Classic mode only. KubeVirt virtual machine backup is not supported in Federated mode.
Backup schedules
  • Active: scheduler actively creates backups at specified intervals
  • Suspended: scheduler is paused, and no backups are created
Both
Backups
  • Success: all associated resources (for example, PVs, PVCs) are successfully backed up
  • Partial Success: only some volumes are backed up
  • Failure: none of the volumes or resources are backed up successfully
  • In-Progress: backup operation is ongoing

In Federated mode, backup operations are handled by Stork on each application cluster. If no valid application cluster is available to process a backup deletion, the delete request is rejected. To remove a backup in this state, an explicit force delete must be performed. For more information, see Force Delete Backups.

Both
Restores
  • Success: restore operation completed successfully
  • Partial Success: only some resources were restored
  • Failure: restore operation failed
  • In-Progress: restore operation is ongoing
Both
Cluster Discovery Configuration
  • In Progress: discovery is currently scanning the Gardener API for shoot clusters matching the configured label selector; manual shoot discovery and editing are not available in this state
  • Success: discovery completed successfully; all matching shoot clusters are registered or updated in Portworx Backup
  • Failed: discovery encountered an error, such as a Gardener API connectivity failure or an expired token; the ClusterDiscoveryConfigFailed Prometheus alert fires in this state
  • Deleting: the cluster discovery configuration is being removed; editing and further deletion operations are not available in this state
Federated mode only
Backup location – cluster connection
  • Valid: the cluster can connect to the backup location using Workload Identity and is eligible for backup, restore, and sync operations
  • Invalid: the cluster cannot connect to the backup location; typically caused by missing or misconfigured Workload Identity permissions on the cluster

Each cluster associated with a backup location is validated independently. A backup location may be valid for one cluster and invalid for another.

Federated mode only
Backup sync
  • Pending: sync has been triggered but has not yet started
  • In Progress: sync is currently running; no additional sync operations can start for the same storage bucket until this completes

When sync completes, the All Backups page is updated to reflect the current state of the backup location. Only one sync operation can run at a time for a given storage bucket.

Federated mode only