Percona Backup for MongoDB Documentation

Percona Backup for MongoDB is a distributed, low-impact solution for achieving consistent backups of MongoDB sharded clusters and replica sets.

As of version 1.7.0, Percona Backup for MongoDB supports both physical and logical backups and restores. Point-in-Time Recovery is currently supported only for logical backups.

Supported MongoDB versions

Percona Backup for MongoDB is compatible with the following MongoDB versions:

• For logical backups - Percona Server for MongoDB and MongoDB Community v4.0 and higher with MongoDB Replication enabled.

• For physical backups - Percona Server for MongoDB starting from versions 4.2.15-16, 4.4.6-8, 5.0 and higher with MongoDB Replication enabled and WiredTiger configured as the storage engine.

Important

Percona Backup for MongoDB doesn’t work on standalone MongoDB instances. This is because Percona Backup for MongoDB requires an oplog to guarantee backup consistency. Oplog is available on nodes with replication enabled.

For testing purposes, you can deploy Percona Backup for MongoDB on a single-node replica set. ( Specify the replication.replSetName option in the configuration file of the standalone server.)

See also

MongoDB Documentation: Convert a Standalone to a Replica Set

https://docs.mongodb.com/manual/tutorial/convert-standalone-to-replica-set/

The Percona Backup for MongoDB project is inherited from and replaces mongodb_consistent_backup, which is no longer actively developed or supported.

Features

Logical backup and restore Physical (a.k.a. ‘hot’) backup and restore (with Percona Server for MongoDB 4.2.15-16, 4.4.6-8, 5.0.2-1 and higher) Works for both for sharded clusters and classic, non-sharded replica sets. Point-in-time recovery (for logical backups only) Simple command-line management utility

Simple, integrated-with-MongoDB authentication Distributed transaction consistency with MongoDB 4.2+ Use with any S3-compatible storage Users with classic, locally-mounted remote filesystem backup servers can use ‘filesystem’ instead of ‘s3’ storage type.

Introduction

Introduction

• How Percona Backup for MongoDB works
• Percona Backup for MongoDB components

Getting started

Getting started

• Installing Percona Backup for MongoDB
  • Installing from Percona repositories
  • Building from source code
  • Download packages from Percona website
• Initial setup
  • Configure authentication in MongoDB
  • Configure remote backup storage
  • Start the pbm-agent process

Usage

Usage

• Running Percona Backup for MongoDB
  • Listing backups
  • Starting a backup
  • Checking an in-progress backup
  • Restoring a backup
  • Canceling a backup
  • Deleting backups
  • Viewing backup logs
• Point-in-Time Recovery
  • Incremental backups
  • Restore to the point in time
  • Delete backups
• Point-in-Time Recovery oplog replay
  • Oplog replay for physical backups
  • Oplog replay for storage level snapshots

Details

Details

• Architecture
• Authentication
• Backup and restore types
• Percona Backup for MongoDB configuration in a cluster (or non-sharded replica set)
• Remote backup storage

How to

How to

• Schedule backups
  • Schedule backups with Point-in-Time Recovery running
• Upgrade PBM
  • Enable Percona repository
  • Upgrade Percona Backup for MongoDB using apt
  • Upgrade Percona Backup for MongoDB using yum
• Troubleshoot PBM
  • pbm-speed-test
  • Backup progress tracking
  • Percona Backup for MongoDB status
  • pbm-agent logs
• Automate access to S3 buckets for Percona Backup for MongoDB
• Remove PBM

FAQ

FAQ

• FAQ

Reference

Reference

• pbm commands
• Configuration file options
• Submitting Bug Reports or Feature Requests
• Glossary
• Copyright and Licensing Information
• Trademark Policy

Release notes

Release notes

• Release notes