px-backup-config ConfigMap parameters

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

Delete Job Limits

These parameters control the maximum number of concurrent delete job pods that can run during backup deletion operations.

Key/Parameter	Default Value	Description
NFS_DELETE_JOB_LIMIT	25	Limits the number of job pods spawned to delete Portworx volume backups during backup deletion. Adjust this value based on your cluster's pod quota limit to prevent cluster overload. Usage: NFS_DELETE_JOB_LIMIT: "50" sets the limit to 50 concurrent delete jobs. Configmap: px-backup-config Cluster: Backup cluster Lower Limit: 1
NFS_CSI_DELETE_JOB_LIMIT	25	Limits the number of job pods created to delete CSI volume backups during backup deletion. Adjust this value based on your cluster's pod quota limit. Usage: NFS_CSI_DELETE_JOB_LIMIT: "50" sets the limit to 50 concurrent CSI delete jobs. Configmap: px-backup-config Cluster: Backup cluster Lower Limit: 1
KDMP_DELETE_JOB_LIMIT	5	Limits the number of job pods spawned to delete CSI + Offload volume backups during backup deletion. For new value to be used it should be set on both App cluster and Backup cluster. Usage: KDMP_DELETE_JOB_LIMIT: "10" sets the limit to 10 concurrent KDMP delete jobs. Configmap: px-backup-config Cluster: App cluster and Backup cluster Lower Limit: 1

note

For more information, see Delete NFS Backups with Job Limit.