How to create a backup

This is a guide on how to create and list backups of a Charmed MongoDB replica set or sharded cluster using Amazon S3 storage.

Prerequisites

• Access to Amazon S3 storage.
• Configured settings for S3 storage
  • See How To > Configure S3
• A replica set with at least three nodes deployed OR a sharded cluster with at least one shard deployed
  • See How To > Scale replicas and shards

Summary

• Determine the application to run backup actions on
• Create a backup
• List backups

Determine the application to run backup actions on

The application to pass to juju when running backup and restore actions depends on whether your deployment is a replica set or sharded cluster:

When running Charmed MongoDB K8s as a replica-set, this will be the name of your MongoDB K8s application.

When running Charmed MongoDB K8s as a sharded cluster, this will be the name of your MongoDB K8s application running with the “config-server” role - never the shard applications.

Create a backup

Before creating a backup, check that your Charmed MongoDB K8s deployment is active and idle with juju status.

To create a backup, use the create-backup command on the leader unit:

juju run <replica-set name | config-server name>/leader create-backup

List all backups

To list all available, failed, and in-progress backups, use the list-backup command on the leader unit:

juju run <replica-set name | config-server name>/leader list-backups