Hear how our largest telecom customer tackled open-source challenges with Portworx. Register Now

To jump directly to MongoDB specific backup information. Jump to the below section.

Kubernetes runs mission critical applications in production; that is a fact. Running applications—especially stateful applications in production—requires care and planning. We have covered how to run a highly-available MongoDB service on Kubernetes in production already, and now we are going to focus on the best way to protect your data services in production with backup and restore.

Here are some of the things you need to ask yourself when protecting MongoDB with backup and restore on Kubernetes in production:

  • What Kubernetes objects do I need to backup?
  • How can I backup my PersistentVolumes (PVs)?
  • Where do my backup files live?
  • How long do my backups remain available?
  • Can I restore to another Kubernetes cluster?
  • Who has access to my backups?
  • Who can take a backup?
  • Can I take backups on a set schedule?
  • How long will my backups take?
  • Are my backups secure?

This blog post will aim to answer most of the questions you may be asking and provide a clear guide on how to backup MongoDB on Kubernetes in production.

The essential steps to backup MongoDB on Kubernetes

When you are creating a backup and restore strategy, it is important to remember that not every data service needs the same level of protection. In production, we typically need the best level of protection that fits our business needs as well as those of our customers. Given this, it’s best to understand the essential steps for creating a backup and restore plan in production.

  1. Understand WHO will be responsible for creating backups.
  2. Know what level of RPO (recovery point objective) you require.
  3. Make sure you know where your backup targets will be located.
  4. Plan out what type of schedule and retention plan your backups need.
  5. Make sure any application-aware hooks are in place so your backups are app-consistent.

We’ll walk through and explain these critical steps for backing up MongoDB in production in more detail as well as provide examples and screenshots below.

Performing backup and restore for MongoDB

Before we can backup MongoDB, we must first configure PX-Backup with the access to the cluster which it is running in.

Note, this blog does not go into installing PX-Backup; for this, please reference our documentation.

Within the PX-Backup interface, select Add Cluster from the navigation.


Then you will need to provide a cluster name and a Kubeconfig for the Kubernetes cluster you are using as well as the Portworx details if you have access to them. Keep in mind that the Kubeconfig is what controls the type of access you have to the cluster, and the same is true within PX-Backup. If you only have access to one namespace, you will only be able to set up backup and restore for that namespace. Also, if you do not have access to the Portworx cluster details or are not using Portworx for volumes, you can leave that section blank.


Once you have done this, you should see your cluster added to the main screen. There should be a green backup icon in the cluster tile that will bring you to the backup view for the cluster.


If your backup icon is not green, double check that you are running Stork 2.4+ in the cluster you added.

Refer to the Add Cluster screen within the backup UI. You can easily copy the command to add stork to your cluster.

(Running Portworx)

KBVER=$(kubectl version --short | awk -Fv '/Server Version: /{print $3}')

curl -fsL -o stork-spec.yaml "https://install.portworx.com/2.5?kbver=${KBVER}&comp=stork"

kubectl apply -f stork-spec.yaml

(Not running Portworx)

curl -fsL -o stork-spec.yaml "https://install.portworx.com/2.5?comp=stork&storkNonPx=true"

kubectl apply -f stork-spec.yaml

Configure your backup targets

Before we can backup MongoDB from our cluster, we must create a backup target location. Click on Cloud Settings to be taken to the location where you can input your target credentials and bucket information.


You can follow our documentation on how to set up various backup targets. At a minimum, you will need to create both a single Cloud Account (e.g., AWS, Azure, Google) and a Backup Location (e.g., bucket in cloud object store).


When you create a backup location, you will select the previously created Cloud Account and then fill in the bucket information accordingly for your backup target provider.

Consider characteristics of the backup location. Retention of data within the backup location as well as the geographic location of the location are not configured by PX-Backup and thus should be carefully configured prior to using the location.

To make sure backups are encrypted within the backup location, enter an encryption key of your choice.


Create a backup schedule

This step is optional. However, using a schedule enables point in time recovery (PITR) of applications. Using a schedule will provide the PITR points that can be used.

You may want to create a schedule specifying how often your backup takes place (that allows you to meet your RPO objectives) and how many copies of the backup are to be kept (if you need RPO zero, check out kubernetes disaster recovery). Click Schedule Policies from the settings navigation, and this will bring you to a view where you can configure your schedules.


Click the Add button in the navigation bar.


From here, create your desired schedule. When you choose Periodic, Daily, Weekly, or Monthly, you will then be able to select the number of retained copies. Later, you will be able to select this schedule when we create our backup for MongoDB.


Pre- and post- rules for creating application-consistent MongoDB backups

Backups should be taken when the system can verify that the data service is ready for a backup. This is called application awareness. For this reason, we may want to control logic that happens before and after a backup is triggered to help control consistency based on the above information. With PX-Backup, we configure pre- and post- rules that can run arbitrary commands inside one or more pods of the data service to achieve these goals.

First, we need to understand how MongoDB stores states. This will ultimately help provide a blueprint for our backup policies and rules in production.

Backups should be taken when the system can verify that the data service is ready for a backup. This is called application awareness. For this reason, we may want to control logic that happens before and after a backup is triggered to help control consistency based on the above information. With PX-Backup, we configure pre- and post- rules that can run arbitrary commands inside one or more pods of the data service to achieve these goals.

First, we need to understand how MongoDB stores states. This will ultimately help provide a blueprint for our backup policies and rules in production.

MongoDB stores data files in a location called dbPath. This location can vary slightly depending on what operating system you are using; however, it is most often located at /var/lib/mongo. Some container images may also configure this path differently, so it is important to pay attention where the dbPath is set up so you can mount the persistent volume to within the Kubernetes spec file. For instance, the Mongo image in DockerHub uses /data/db, and below is an example of such a configuration.

        - name: mongo-persistent-storage
          mountPath: /data/db
 - metadata:
     name: mongo-persistent-storage
     storageClassName: mongo-pwx-storage-class
       - ReadWriteOnce
         storage: 30G

MongoDB has tools that can be used for backup and restore, including the command line tools mongodump and mongorestore. However, while these tools work well for taking backups specific to MongoDB, they may also have negative impacts on performance. Since PX-Backup can provide abstracted backup and restore for numerous data services, we can replicate the best practices of using cloud provider snapshots or filesystem snapshots for MongoDB backup and restore with PX-Backup

When deployed with more than a single node, MongoDB has an additional component called Oplog that should be considered during backup. The MongoDB Oplog is a special capped collection that keeps a rolling record of all operations that modify the data stored in your databases. MongoDB applies database operations on the primary and then records the operations on the primary’s Oplog. The secondary members then copy and apply these operations in an asynchronous process. All replica set members contain a copy of the Oplog in the local.oplog.rs collection, which allows them to maintain the current state of the database.

The Oplog can also be used for database recovery, and this is exactly what the MongoDB backup recovery functionality does. Because the Oplog recovery can take a very long time, MongoDB usually is combined with regular database snapshots.

Some users may want the best of both worlds as an option to recover a subset of data because the replay of the Oplog is not going to “undo” operations after the recovery-time but only redo operations before it. For example, if a document/collection was deleted after the recovery-time, the document can be restored in this manner. If this is the case, you may want to add a volume mount to Mongo to a location where Oplog dumps can be stored

        - name: mongo-persistent-storage
          mountPath: /data/db
  - name: mongo-oplog-dumps
          mountPath: /data/oplog

Next, we can add a PX-Backup rule with actions to flush MongoDB and dump the Oplog so we can have the option to mount this Oplog to any previous backup. See the rules below.

Pre- rule for MongoDB

For these best practices, external snapshots or backup systems like PX-Backup should “flush writes to disk and lock the database” to ensure a consistent backup. This is done using the db.fsyncLock() method, which does the following:

Forces the mongod to flush all pending write operations to disk and locks the entire mongod instance to prevent additional writes until the user releases the lock with a corresponding db.fsyncUnlock() command.

Notice we leave “background” and “run in a single pod” unchecked, as we want this to run on every mongodb pod in the foreground.

The first action will be to lock and sync the database.

mongo --eval "printjson(db.fsyncLock())"

The second option (if using Oplog) will be dump Oplog.

Note: If you are not using replicas or Oplog, you can skip this action.

mongodump -d local -c oplog.rs -o /data/oplog

This is what the actions will look like in the PX-Backup interface.


Post- rule for MongoDB

We need to follow up the pre- backup rule above with a post- backup rule that will administratively reduce the lock on the database following our backup operation.

The action will be to unlock the database so I/O can continue

mongo --eval "printjson(db.fsyncUnlock())"

This is what the actions will look like in the PX-Backup interface.


Create the backup for MongoDB

Now that configuration is done and we have created rules for our application, we are ready to start backing up MongoDB. What we need to do is enter the backup view of the cluster our service is running in and select the namespace that our application is running in.


Once you are in the namespace, you can select the labels associated with MongoDB to only backup certain objects with the label or backup the entire namespace by selecting the Backup button in the top right corner of the namespace backup view.


Once you are into the backup-specific input, give the backup the following information in the pop out menu:

  • Name
  • Backup Target
  • Backup Now or On a schedule
  • Provide Pre- and Post- rules
  • Optional backup labels for accounting


Once you complete this information, click Create.


Once created, the backup will enter a Pending and then an In Progress state. The backup icon will look like the below example.


To view the progress of what is happening in the backup, you can select the navigation to the right side of the backup and select the Show Details button. This will allow you to view the current status and metadata of the associated backup. Any progress or errors will be reported within this screen.


Part of this information will be the status of the pre- and post- rules we created earlier. When they are being executed, it will be reported as in progress, and any output or errors will be present within this screen if there is an issue.


Once the rule is executed, it will continue and start to back up the volumes, and the details will change. An example of these details can be seen below.


Upon successful completion of the backup, the icon will look like the below example.


If something goes wrong, you will notice the icon turn red, and details of the failure will be available in the Show Details section of the backup.


Restoring MongoDB from backup

To start a restore, select Backups from the top navigation bar.


Then find the backup you wish to restore and select the Restore selection from the right navigation.


From here you can provide a name for your restore and a destination cluster as well as the following options.


  • Default restore
    • This will restore the backup to the namespace which it came from. Take note of the “replace existing resources” option when using this method.
  • Custom restore
    • This will allow you to provide a new namespace name to restore your backup to. Note that this namespace does not need to pre-exist.


  • Replace existing resources
    • This will make sure the restore operation overwrites the objects that may already exist. Note that objects will be deleted then re-created.
  • Restore Jobs
    • Jobs often run once and complete. It is not always necessary to run these jobs again—especially when restoring to the same cluster where the backup was taken. However, it may be necessary when restoring to a new cluster or new namespace.

You should see a similar transition in the UI from Pending to Success, and you can select Show Details from the menu—just like with the backup—to get the active information about the backup.




As we’ve just seen, backup and restore is a critical piece of the data protection plan for any application in Kubernetes today. PX-Backup makes it simple to understand who, when, where, and how the backup takes place—all while making it hyper configurable to specific data services for extra consistency and application awareness. Remember to check out the documentation on backup—as well as take advantage of a free trial.

Subscribe for Updates

About Us
Portworx is the leader in cloud native storage for containers.


Ryan Wallner

Portworx | Technical Marketing Manager
Explore Related Content:
  • backup
  • kubernetes
  • mongodb
  • restore
May 4, 2020 Featured
PX-Backup: The easiest way to backup and restore all your Kubernetes applications
Prashant Rathi
Prashant Rathi
June 23, 2020 How To
Backup and Restore for Applications on OpenShift
Ryan Wallner
Ryan Wallner
May 20, 2020 How To
How to backup a Kubernetes application
Ryan Wallner
Ryan Wallner