Skip to main content
Version: 2.10

Configure px-backup-config ConfigMap parameters

The px-backup-config ConfigMap is a configuration component used by Portworx Backup to manage backup sync operations, NFS backup location validation, and delete job behavior. This ConfigMap resides in the namespace where Portworx Backup is deployed (often referred to as <pxb-namespace>) on the Portworx Backup cluster.

You might need to update the px-backup-config ConfigMap in scenarios similar to the following:

  • When backup sync operations require additional CPU or memory resources
  • To configure NFS backup location validation resource limits
  • To control the number of NFS delete jobs to avoid cluster overload
  • To tune performance for large-scale backup and restore environments

For a full list of all available parameters, see the px-backup-config parameters reference.

How to update the px-backup-config ConfigMap​

Prerequisites​

Before configuring the px-backup-config ConfigMap, ensure the following:

  • Your kubeconfig is connected to the Portworx Backup cluster (where Portworx Backup is deployed)
  • You have access to the namespace where Portworx Backup is installed (typically referred to as <pxb-namespace>)
  • You have sufficient permissions to edit ConfigMaps in the Portworx Backup namespace

All kubectl commands in this document must be executed against the Portworx Backup cluster, unless otherwise specified.

To modify the ConfigMap:

  1. Edit the ConfigMap using kubectl:

    kubectl edit cm px-backup-config -n <pxb-namespace>

  2. Add or modify settings as needed. For example, to update backup sync and NFS delete job limits. Below is an example px-backup-config before you append parameters:

    apiVersion: v1
    data: 
      BACKUP_SYNC_REQUEST_CPU: "0.2"
    kind: ConfigMap
    metadata:
      name: px-backup-config
      namespace: <pxb-namespace>

  3. Add the following parameters under the data section in the key-value pair in the below format:

    BACKUP_SYNC_REQUEST_MEMORY: "1Gi"
    BACKUP_SYNC_LIMIT_CPU: "0.4"
    BACKUP_SYNC_LIMIT_MEMORY: "2Gi"
    NFS_DELETE_JOB_LIMIT: "50"
    NFS_CSI_DELETE_JOB_LIMIT: "50"

    These values are examples, replace them with your cluster requirements.

  4. Save the changes. The new settings will apply to subsequent operations.

note

The px-backup-config parameters are hidden by default and do not appear in the ConfigMap. If you don't manually add these parameters with your own values, Portworx Backup uses the default values in the background.

Common Configurations Use Cases​

Backup sync for NFS backup locations​

Backup sync pods are responsible for synchronizing backup metadata from NFS backup locations. If you have a large number of backups or large backup objects, you may need to increase the CPU and memory resources for these pods.

Update the following parameters to resolve resource issues during backup sync:

BACKUP_SYNC_REQUEST_CPU: "0.2"
BACKUP_SYNC_REQUEST_MEMORY: "1Gi"
BACKUP_SYNC_LIMIT_CPU: "0.4"
BACKUP_SYNC_LIMIT_MEMORY: "2Gi"

NFS backup location validation​

When adding or validating an NFS backup location, Portworx Backup spawns validation pods. If validation is slow or fails due to resource constraints, increase the NFS validate resource limits. For more information, see NFS Validate Resource Limits parameters.

Delete NFS Backups with Job Limit​

When deleting backups that reside on an NFS backup location, Portworx Backup spawns delete job pods for each PVC. In clusters with strict job quotas, you can limit the number of concurrent delete jobs to prevent cluster overload.

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