Installing Percona Backup for MongoDB¶
Percona provides and supports installation packages for Percona Backup for MongoDB in the deb and
rpm formats that you can install by using
yum or other
interfaces to your package management system.
The Percona Software and Platform Lifecycle page lists Linux distributions for which Percona Backup for MongoDB installation packages are available.
The recommended approach is to install Percona Backup for MongoDB from Percona repositories using the
If you want a full control over the installation, you may build and install Percona Backup for MongoDB from source code.
Regardless of the installation method you choose, the following tools are at your disposal after the installation completes:
|pbm||Command-line interface for controlling the backup system|
|pbm-agent||An agent for running backup/restore actions on a database host|
Install pbm-agent on every server that has
mongod nodes in the
MongoDB cluster (or non-sharded replica set). You don’t need to install pbm-agent on arbiter nodes as they don’t have the data set.
You can install
on any or all servers or desktop computers you wish to use it from, so long as
those computers aren’t network-blocked from accessing the MongoDB cluster.
To install Percona Backup for MongoDB, first install
percona-release tool using the package manager of your operating system. This is a repository management tool that automatically configures the required repository for you.
Follow the instructions in Percona Software repositories documentation to install
Enable the repository. As of version 1.3.0, Percona Backup for MongoDB packages are stored in the pbm repository.
$ sudo percona-release enable pbm release
$ sudo apt-get update $ sudo apt-get install percona-backup-mongodb
Building the project requires:
- Go 1.11 or above
krb5-develfor Red Hat Enterprise Linux / CentOS or
libkrb5-devfor Debian / Ubuntu. This package is required for Kerberos authentication in Percona Server for MongoDB.
- Installing and setting up Go tools
To build the project (from the project dir):
$ git clone https://github.com/<your_name>/percona-backup-mongodb $ cd percona-backup-mongodb $ make build
After make completes, you can find
pbm and pbm-agent binaries
$ cd bin $ ./pbm version
By running pbm version, you can verify if Percona Backup for MongoDB has been built correctly and is ready for use.
Version: [pbm version number] Platform: linux/amd64 GitCommit: [commit hash] GitBranch: master BuildTime: [time when this version was produced in UTC format] GoVersion: [Go version number]
Instead of specifying the path to pbm binaries, you can add it to the PATH environment variable:
After Percona Backup for MongoDB is successfully installed on your system, you have
and pbm-agent programs available. See Initial setup for guidelines how to set up Percona Backup for MongoDB.