Skip to content

For help, click the link below to get free database assistance or contact our experts for personalized support.

Configure remote backup storage

The easiest way to provide remote backup storage configuration is to specify it in a YAML config file and upload this file to Percona Backup for MongoDB using pbm CLI.

The storage configuration itself is out of scope of the present document. We assume that you have configured one of the supported remote backup storages and provisioned access keys with the proper permissions for PBM. See Remote Backup Storage for more details.

Considerations

Percona Backup for MongoDB needs its own dedicated S3 bucket exclusively for backup-related files. Ensure that this bucket is created and managed solely by PBM.

Procedure

  1. Create a config file (e.g. pbm_config.yaml).

    storage:
      type: s3
      s3:
        region: us-west-2
        bucket: pbm-test-bucket
        prefix: data/pbm/backup
        credentials:
          access-key-id: <your-access-key-id-here>
          secret-access-key: <your-secret-key-here>
    
    storage:
     type: s3
         s3:
         region: northamerica-northeast1
         bucket: pbm-testing
         prefix: pbm/test
         endpointUrl: https://storage.googleapis.com
         credentials:
           access-key-id: <your-access-key-id-here>
           secret-access-key: <your-secret-key-here>
    
    storage:
      type: azure
      azure:
        account: <your-account>
        container: <your-container>
        prefix: pbm
        credentials:
          key: <your-access-key>
    
    storage:
      type: filesystem
      filesystem:
        path: /data/local_backups
    

Navigate to every storage page for a detailed example configuration file.

  1. Apply the config file to PBM

    $ pbm config --file pbm_config.yaml
    

To learn more about Percona Backup for MongoDB configuration, see Percona Backup for MongoDB configuration in a cluster (or non-sharded replica set).

Next steps

Start pbm-agent


Last update: May 23, 2025
Created: May 23, 2025