Percona Backup for MongoDB configuration in a cluster (or non-sharded replica set)¶
The configuration information is stored in a single document of the admin.pbmConfig
collection. That single copy is shared by all the pbm-agent processes in a
cluster (or non-sharded replica set), and can be read or updated using the
You can see the whole config by running
db.getSiblingDB(“admin”).pbmConfig.findOne(). But you don’t have to use the
mongo shell; the
pbm CLI has a “config” subcommand to read and update it.
Percona Backup for MongoDB config contains the following settings:
Remote backup storage configuration is available as of v1.0 or v1.1
Point-in-Time Recovery configuration is available as of v1.3.0
Restore options are available as of v1.3.2
Run pbm config --list to see the whole config. (Sensitive fields such as keys will be redacted.)
Insert the whole Percona Backup for MongoDB config from a YAML file¶
If you are initializing a cluster or non-sharded replica set for the first time, it is simplest to write the whole config as YAML file and use the pbm config --file method to upload all the values in one command.
Use the following command to upload the config file (e.g.
$ pbm config --file pbm_config.yaml
Execute whilst connecting to config server replica set if it is a cluster. Otherwise just connect to the non-sharded replica set as normal. (See MongoDB connection strings - A Reminder (or Primer) if you are not familiar with MongoDB connection strings yet.)
Accessing or updating single config values¶
You can set a single value at time. For nested values use dot-concatenated key names as shown in the following example:
$ pbm config --set storage.s3.bucket="operator-testing"
To list a single value you can specify just the key name by itself and the value will be returned (if set)
$ pbm config storage.s3.bucket operator-testing $ pbm config storage.s3.INVALID-KEY Error: unable to get config key: invalid config key