px-backup-config ConfigMap parameters

Applicable to both Classic and Federated modes

This reference guide provides a list of all parameters available in the px-backup-config ConfigMap. The px-backup-config ConfigMap is used to manage backup sync operations, NFS backup location validation, delete job behavior, and Portworx Backup cluster configuration.

The px-backup-config ConfigMap resides in the namespace where Portworx Backup is deployed (often referred to as <pxb-namespace>) on the Portworx Backup cluster.

For instructions on how to update the px-backup-config ConfigMap and common configuration use cases, see Configure px-backup-config ConfigMap.

Backup sync

These parameters control the CPU and memory resources for backup sync pods that synchronize backup metadata from NFS backup locations.

Key/Parameter	Default Value	Description
BACKUP_SYNC_REQUEST_CPU	0.1	Sets the minimum CPU resources requested by each backup sync pod for NFS backup locations. Increase this value if you have a large number of backups or large backup objects to sync. Usage: BACKUP_SYNC_REQUEST_CPU: "0.2" sets the minimum CPU to 0.2 cores. Configmap: px-backup-config Cluster: Backup cluster
BACKUP_SYNC_REQUEST_MEMORY	700Mi	Sets the minimum memory requested by each backup sync pod for NFS backup locations. Increase this value if backup sync operations fail due to insufficient memory. Usage: BACKUP_SYNC_REQUEST_MEMORY: "1Gi" sets the minimum memory to 1 GiB. Configmap: px-backup-config Cluster: Backup cluster
BACKUP_SYNC_LIMIT_CPU	0.2	Sets the maximum CPU resources allowed for each backup sync pod for NFS backup locations. Increase this value if you observe CPU throttling during sync operations. Usage: BACKUP_SYNC_LIMIT_CPU: "0.5" sets the maximum CPU to 0.5 cores. Configmap: px-backup-config Cluster: Backup cluster
BACKUP_SYNC_LIMIT_MEMORY	1Gi	Sets the maximum memory allowed for each backup sync pod for NFS backup locations. Increase this value if you see OOM (Out Of Memory) errors during sync operations. Usage: BACKUP_SYNC_LIMIT_MEMORY: "2Gi" sets the maximum memory to 2 GiB. Configmap: px-backup-config Cluster: Backup cluster

Node affinity label

These parameters configure the Kubernetes node affinity for cross-cloud backup and restore job pods, allowing you to control the specific nodes where these jobs are scheduled.

Key/Parameter

Description

pxb_job_node_affinity_label

Sets the label used to schedule KDMP backup or restore job pods on specific Kubernetes nodes. Use the format pxb_job_node_affinity_label:<value>, where <value> is any valid Kubernetes label value applied to your target nodes. For more information, see Configure Node Affinity. Usage: pxb_job_node_affinity_label: "worker" schedules KDMP jobs on nodes labeled with pxb_job_node_affinity_label=worker. Configmap: kdmp-config Cluster: App cluster

NFS validate resource limits

These parameters control the CPU and memory resources for NFS validation pods that validate NFS backup locations when adding or verifying them.

Key/Parameter	Default Value	Description
NFS_VALIDATE_REQUEST_CPU	0.1	Sets the minimum CPU resources requested for running NFS validate pods on the backup cluster. These pods validate NFS backup locations when adding new ones and for subsequent validation requests. Usage: NFS_VALIDATE_REQUEST_CPU: "0.2" sets the minimum CPU to 0.2 cores. Configmap: px-backup-config Cluster: Backup cluster
NFS_VALIDATE_REQUEST_MEMORY	700Mi	Sets the minimum memory requested for running NFS validate pods on the backup cluster. Usage: NFS_VALIDATE_REQUEST_MEMORY: "1Gi" sets the minimum memory to 1 GiB. Configmap: px-backup-config Cluster: Backup cluster
NFS_VALIDATE_LIMIT_CPU	0.2	Sets the maximum CPU resources allowed for running NFS validate pods on the backup cluster. Usage: NFS_VALIDATE_LIMIT_CPU: "0.5" sets the maximum CPU to 0.5 cores. Configmap: px-backup-config Cluster: Backup cluster
NFS_VALIDATE_LIMIT_MEMORY	1Gi	Sets the maximum memory allowed for running NFS validate pods on the backup cluster. Usage: NFS_VALIDATE_LIMIT_MEMORY: "2Gi" sets the maximum memory to 2 GiB. Configmap: px-backup-config Cluster: Backup cluster

NFS delete resource limits

These parameters control the CPU and memory resources for delete pods that clean up Portworx volume backups from NFS backup locations.

Key/Parameter	Default Value	Description
NFS_DELETE_PX_REQUEST_CPU	0.1	Sets the minimum CPU resources requested for delete pods deployed to delete Portworx volume NFS backups. This can be impacted based on the number of PVCs and data size on each PVC. Usage: NFS_DELETE_PX_REQUEST_CPU: "0.2" sets the minimum CPU to 0.2 cores. Configmap: px-backup-config Cluster: Backup cluster
NFS_DELETE_PX_REQUEST_MEMORY	700Mi	Sets the minimum memory requested for delete pods deployed to delete Portworx volume NFS backups. Usage: NFS_DELETE_PX_REQUEST_MEMORY: "1Gi" sets the minimum memory to 1 GiB. Configmap: px-backup-config Cluster: Backup cluster
NFS_DELETE_PX_LIMIT_CPU	0.2	Sets the maximum CPU resources allowed for delete pods deployed to delete Portworx volume NFS backups. Usage: NFS_DELETE_PX_LIMIT_CPU: "0.5" sets the maximum CPU to 0.5 cores. Configmap: px-backup-config Cluster: Backup cluster
NFS_DELETE_PX_LIMIT_MEMORY	1Gi	Sets the maximum memory allowed for delete pods deployed to delete Portworx volume NFS backups. Usage: NFS_DELETE_PX_LIMIT_MEMORY: "2Gi" sets the maximum memory to 2 GiB. Configmap: px-backup-config Cluster: Backup cluster

NFS delete CSI resource limits

These parameters control the CPU and memory resources for delete pods that clean up CSI volume backups from NFS backup locations.

Key/Parameter	Default Value	Description
NFS_DELETE_CSI_REQUEST_CPU	0.1	Sets the minimum CPU resources requested for delete pods deployed to delete CSI volume NFS backups. Usage: NFS_DELETE_CSI_REQUEST_CPU: "0.2" sets the minimum CPU to 0.2 cores. Configmap: px-backup-config Cluster: Backup cluster
NFS_DELETE_CSI_REQUEST_MEMORY	700Mi	Sets the minimum memory requested for delete pods deployed to delete CSI volume NFS backups. Usage: NFS_DELETE_CSI_REQUEST_MEMORY: "1Gi" sets the minimum memory to 1 GiB. Configmap: px-backup-config Cluster: Backup cluster
NFS_DELETE_CSI_LIMIT_CPU	0.2	Sets the maximum CPU resources allowed for delete pods deployed to delete CSI volume NFS backups. Usage: NFS_DELETE_CSI_LIMIT_CPU: "0.5" sets the maximum CPU to 0.5 cores. Configmap: px-backup-config Cluster: Backup cluster
NFS_DELETE_CSI_LIMIT_MEMORY	1Gi	Sets the maximum memory allowed for delete pods deployed to delete CSI volume NFS backups. Usage: NFS_DELETE_CSI_LIMIT_MEMORY: "2Gi" sets the maximum memory to 2 GiB. Configmap: px-backup-config Cluster: Backup cluster

Cluster Registration Limit

This parameter controls the maximum number of clusters that can be registered with a Portworx Backup instance.

Key/Parameter	Default Value	Description
MAX_CLUSTER_COUNT	0 (no limit)	Sets the maximum number of clusters that can be registered with Portworx Backup. When the limit is reached, any further cluster registration request is rejected with a ResourceExhausted error: cluster count limit reached: maximum allowed <N>. The existing clusters are unaffected. To add a new cluster beyond the limit, you must first delete a registered cluster. Set to 0 (default) to enforce no limit. Usage: MAX_CLUSTER_COUNT: "50" limits cluster registrations to 50. Configmap: px-backup-config Cluster: Backup cluster

Telemetry

These parameters control telemetry data collection in Portworx Backup. Telemetry must first be enabled via Helm during installation or upgrade. Once enabled, these parameters allow you to toggle data collection without a Helm upgrade or pod restart.

Key/Parameter	Default Value	Description
TELEMETRY_COLLECTION_ENABLED	true	Controls whether Portworx Backup collects and uploads telemetry data (metrics and logs) to Pure1. Set to false to pause data collection without removing telemetry pods. Portworx Backup picks up ConfigMap changes at the next scheduled interval without requiring a pod restart. Usage: TELEMETRY_COLLECTION_ENABLED: "false" disables telemetry data collection. Configmap: px-backup-config Cluster: Backup cluster

Federated mode — cluster discovery

Applicable to Federated mode only

These parameters control the behavior of Gardener cluster discovery in Federated mode, including kubeconfig expiration, token TTLs, refresh intervals, and worker concurrency.

Key/Parameter	Default Value	Description
FEDERATED_GARDENER_KUBECONFIG_EXPIRATION_SECONDS	7776000	Requested expiration duration (in seconds) for the kubeconfig generated via the shoot adminkubeconfig request. The actual expiration may be shorter depending on server-side limits or policies. The default value is 90 days. Configmap: px-backup-config Cluster: Backup cluster
FEDERATED_SHOOT_KUBECONFIG_REFRESH_CHECK_INTERVAL_MINUTES	30	Interval (in minutes) at which Portworx Backup checks whether any shoot cluster kubeconfig needs to be refreshed. Configmap: px-backup-config Cluster: Backup cluster
FEDERATED_SHOOT_KUBECONFIG_REFRESH_WORKER_COUNT	10	Number of parallel workers used to refresh shoot cluster kubeconfigs. Increase this value if you have a large number of shoot clusters and experience slow kubeconfig refresh cycles. Configmap: px-backup-config Cluster: Backup cluster
FEDERATED_GARDENER_TOKEN_REFRESH_CHECK_INTERVAL_MINUTES	30	Interval (in minutes) at which Portworx Backup checks whether any Gardener cluster kubeconfig token needs to be refreshed. Configmap: px-backup-config Cluster: Backup cluster
FEDERATED_GARDENER_TOKEN_REFRESH_WORKER_COUNT	5	Number of parallel workers used to refresh Gardener cluster kubeconfig tokens. Configmap: px-backup-config Cluster: Backup cluster
FEDERATED_GARDENER_TOKEN_REQUEST_TTL_SECONDS	7776000	Requested TTL (in seconds) for tokens generated via the token create request for Gardener cluster kubeconfigs. The default value is 90 days. Configmap: px-backup-config Cluster: Backup cluster

Backup and volume deletion

Key/Parameter	Default Value	Description
BACKUP_DELETE_WORKER	5	Sets the number of concurrent workers that process backup deletion requests. Increase this value to speed up bulk backup deletions; decrease it to reduce load on the Portworx Backup server. Configmap: px-backup-config Cluster: Backup cluster
VOL_DELETE_WORKER	5	Sets the number of concurrent workers that process volume deletion requests during backup deletion. Configmap: px-backup-config Cluster: Backup cluster

Federated mode deletion

Key/Parameter	Default Value	Description
FEDERATED_DELETE_MAX_CONCURRENT	30	(Federated mode) Sets the maximum number of delete operations that can run concurrently across all application clusters. Configmap: px-backup-config Cluster: Backup cluster
FEDERATED_DELETE_MAX_PER_CLUSTER	3	(Federated mode) Sets the maximum number of delete operations that can run concurrently on a single application cluster. Configmap: px-backup-config Cluster: Backup cluster
FEDERATED_DELETE_STUCK_TIMEOUT_MINUTES	90	(Federated mode) Sets the time, in minutes, after which a delete operation that has not progressed is treated as stuck. Configmap: px-backup-config Cluster: Backup cluster

Backup location sync

Key/Parameter	Default Value	Description
BACKUPLOCATION_SYNC_TIMEOUT	10m	Sets the maximum time to wait for a backup location sync operation to complete before it times out. Configmap: px-backup-config Cluster: Backup cluster
BACKUPLOCATION_SYNC_RETRY_INTERVAL	30s	Sets the interval to wait before retrying a failed backup location sync operation. Configmap: px-backup-config Cluster: Backup cluster

Namespace and resource sync limits

Key/Parameter	Default Value	Description
NAMESPACE_SYNC_MAX_LIMIT	25	Sets the maximum number of namespaces synchronized concurrently during backup sync. Configmap: px-backup-config Cluster: Backup cluster
RESOURCE_SYNC_MAX_LIMIT	5	Sets the maximum number of resources synchronized concurrently during backup sync. Configmap: px-backup-config Cluster: Backup cluster

Restore cleanup

Key/Parameter	Default Value	Description
RESTORE_CR_FILE_CLEANUP_INTERVAL	24h	Sets the interval at which temporary restore custom resource (CR) files are cleaned up. Configmap: px-backup-config Cluster: Backup cluster

Large resource metadata

Key/Parameter	Default Value	Description
LARGE_RESOURCE_METADATA_DOCUMENTS_TTL_SECONDS	300	Sets the time-to-live, in seconds, for cached large-resource metadata documents. Configmap: px-backup-config Cluster: Backup cluster
LARGE_RESOURCE_METADATA_DOCUMENTS_EVICTION_INTERVAL_SECONDS	60	Sets the interval, in seconds, at which expired large-resource metadata documents are evicted from the cache. Configmap: px-backup-config Cluster: Backup cluster

Telemetry data collection

Key/Parameter	Default Value	Description
TELEMETRY_DB_COLLECTION_INTERVAL	6h	Sets the interval at which telemetry data is collected from the database. The minimum supported value is 1h. Configmap: px-backup-config Cluster: Backup cluster

Federated mode credentials

Key/Parameter	Default Value	Description
PX_BACKUP_CREDENTIALS_ENABLED	false	(Federated mode) Controls whether centrally stored cloud credentials are enabled. In Federated mode, application clusters authenticate to the backup location using Workload Identity, so this is disabled by default. Configmap: px-backup-config Cluster: Backup cluster