Managing backups in Managed Service for MongoDB
You can create backups and restore clusters from existing backups.
Managed Service for MongoDB also creates automatic daily backups. You can set the backup start time and retention period.
Restoring clusters from backups
Point-in-Time Recovery (PITR) technology lets you restore the cluster state to any point in time between when the oldest backup was created and when the most recent oplog was archived. For more information, see Backups in Managed Service for MongoDB.
For example, if the backup operation ended on August 10, 2020, 12:00 p.m. UTC, the current date is August 15, 2020, 7:00 p.m. UTC, and the latest oplog
was saved on August 15, 2020, 6:50 p.m. UTC, the cluster can be restored to any state between August 10, 2020, 12:00:01 p.m. UTC and August 15, 2020, 6:50:00 p.m. UTC, inclusive.
Warning
- PITR only works for clusters with MongoDB version 4.2 and higher.
- PITR is not supported for clusters with sharding enabled. Such clusters can be restored only to the point in time when the selected backup was created.
When you restore a cluster from a backup, you create a new cluster with the backup data. If the folder has insufficient resources to create such a cluster, you will not be able to restore from the backup. The average backup recovery speed is 10 MBps.
For a new cluster, you should set all the parameters that are required at creation, except for the cluster type (a MongoDB backup cannot be restored as a PostgreSQL cluster).
When restored to the current state, the new cluster will match the state of:
- Existing cluster at the time of recovery.
- Deleted cluster at the time of archiving the last oplog.
Note
Point-in-Time-Recovery technology for Managed Service for MongoDB is at the Preview stage: you can only use it when restoring from a backup via the CLI. This restriction is removed at the General Availability stage. The technology is enabled on request.
To restore an existing cluster from a backup:
-
Go to the folder page
and select Managed Service for MongoDB. -
Click the cluster name and select the
Backups tab. -
Click
for the backup you need and then click Restore cluster. -
Set up the new cluster. You can select a folder for the new cluster from the Folder list.
-
Click Restore cluster.
To restore a previously deleted cluster from a backup:
-
Go to the folder page
and select Managed Service for MongoDB. -
In the left-hand panel, select
Backups. -
Find the backup you need using the backup creation time and cluster ID. The Name column contains IDs in
<cluster_ID>:<backup_ID>
format. -
Click
for the backup you need and then click Restore cluster. -
Set up the new cluster. You can select a folder for the new cluster from the Folder list.
-
Click Restore cluster.
Managed Service for MongoDB will launch the operation to create a cluster from the backup.
If you do not have the Yandex Cloud command line interface yet, install and initialize it.
The folder specified in the CLI profile is used by default. You can specify a different folder using the --folder-name
or --folder-id
parameter.
To restore a cluster from a backup:
-
View a description of the CLI restore MongoDB cluster command:
yc managed-mongodb cluster restore --help
-
Getting a list of available MongoDB cluster backups:
yc managed-mongodb backup list
Result:
+--------------------------+---------------------+----------------------+---------------------+--------+-----------+ | ID | CREATED AT | SOURCE CLUSTER ID | STARTED AT | SIZE | TYPE | +--------------------------+---------------------+----------------------+---------------------+--------+-----------+ | c9qlk4v13uq7********:... | 2020-08-10 12:00:00 | c9qlk4v13uq7******** | 2020-08-10 11:55:17 | 3.3 KB | AUTOMATED | | ... | | +--------------------------+---------------------+----------------------+---------------------+--------+-----------+
The time when the backup was completed is shown in the
CREATED AT
column with a list of available backups, inyyyy-mm-dd hh:mm:ss
format (2020-08-10 12:00:00
in the example above). You can restore a cluster to any point in time starting with the point when the backup is created. -
Run the command to create a new cluster from a backup (the example shows only some parameters):
yc managed-mongodb cluster restore \ --backup-id <backup_ID> \ --recovery-target-timestamp <timestamp> \ --mongodb-version <MongoDB_version> \ --name <new_cluster_name> \ --environment <environment> \ --network-name <network_name> \ --host zone-id=<availability_zone>,` `subnet-id=<subnet_ID> \ --mongod-resource-preset <host_class> \ --mongod-disk-size <storage_size_GB> \ --mongod-disk-type <disk_type> \ --performance-diagnostics=<enable_diagnostics>
Where:
-
--recovery-target-timestamp
: Time point to which you want to restore the MongoDB cluster, in the UNIX time format. If you do not specify the parameter, the cluster will be restored to when the backup was completed. -
--environment
: Environment,PRESTABLE
orPRODUCTION
. -
--mongod-disk-type
: Disk type,network-hdd
ornetwork-ssd
. -
--performance-diagnostics
: Enable performance diagnostics for the cluster,true
orfalse
.
-
To restore an existing cluster from a backup, use the restore REST API method for the Cluster resource or the ClusterService/Restore gRPC API call and provide the following in the request:
- Backup ID in the
backupId
parameter. To find out the ID, retrieve a list of cluster backups. - Name of the new cluster that will contain the data recovered from the backup, in the
name
parameter. It must be unique within the folder.
In the recoveryTargetSpec.timestamp
parameter, specify the point in time to which you want to restore the MongoDB cluster in the UNIX time
Creating a backup
- Go to the folder page
and select Managed Service for MongoDB. - Click the cluster name and select the
Backups tab. - Click Create backup.
The service will start creating a backup without an additional confirmation.
If you do not have the Yandex Cloud command line interface yet, install and initialize it.
The folder specified in the CLI profile is used by default. You can specify a different folder using the --folder-name
or --folder-id
parameter.
To create a cluster backup:
-
View a description of the CLI create MongoDB backup command:
yc managed-mongodb cluster backup --help
-
Request a backup to be created by specifying the cluster name or ID:
yc managed-mongodb cluster backup <cluster_name_or_ID>
You can get the cluster ID and name with a list of clusters.
To create a backup, use the backup REST API method for the Cluster resource or the ClusterService/Backup gRPC API call and provide the cluster ID in the clusterId
request parameter.
You can request the cluster ID with a list of clusters in the folder.
Warning
While you are creating your backup, the cluster performance might degrade.
Getting a list of backups
To get a list of cluster backups:
- Go to the folder page
and select Managed Service for MongoDB. - Click the cluster name and select the
Backups tab.
To get a list of all backups in a folder:
- Go to the folder page
and select Managed Service for MongoDB. - In the left-hand panel, select
Backups.
These lists contain the following information:
- Backup name.
- Source shard.
- Backup size.
- Backup type:
Automated
orManual
. - Start time of backup creation in UTC (Coordinated Universal Time).
- End time of backup creation in UTC.
If you do not have the Yandex Cloud command line interface yet, install and initialize it.
The folder specified in the CLI profile is used by default. You can specify a different folder using the --folder-name
or --folder-id
parameter.
To get a list of MongoDB cluster backups available in the default folder, run the command:
yc managed-mongodb backup list
Result:
+--------------------------+---------------------+----------------------+---------------------+--------+-----------+
| ID | CREATED AT | SOURCE CLUSTER ID | STARTED AT | SIZE | TYPE |
+--------------------------+---------------------+----------------------+---------------------+--------+-----------+
| c9qlk4v13uq7********:... | 2020-08-10 12:00:00 | c9qlk4v13uq7******** | 2020-08-10 11:55:17 | 3.3 KB | AUTOMATED |
| c9qpm90p3pcg********:... | 2020-08-09 22:01:04 | c9qpm90p3pcg******** | 2020-08-09 21:30:00 | 30 KB | MANUAL |
+--------------------------+---------------------+----------------------+---------------------+--------+-----------+
The resulting table contains the following information:
- ID of the backup.
- End time of backup creation in UTC (Coordinated Universal Time).
- ID of the cluster that the backup was created for.
- Start time of backup creation in UTC.
- Backup size.
- Backup type:
Automated
orManual
.
To get a list of cluster backups, use the listBackups REST API method for the Cluster resource or the ClusterService/ListBackups gRPC API call and provide the cluster ID in the clusterId
request parameter.
You can request the cluster ID with a list of clusters in the folder.
To get a list of backups for all the Managed Service for MongoDB clusters in the folder, use the list REST API method for the Backup resource or the BackupService/List gRPC API call and provide the folder ID in the folderId
request parameter.
Getting information about backups
To get information about the backup of an existing cluster:
- Go to the folder page
and select Managed Service for MongoDB. - Click the cluster name and select the
Backups tab.
To get information about the backup of a previously deleted cluster:
- Go to the folder page
and select Managed Service for MongoDB. - In the left-hand panel, select
Backups.
If you do not have the Yandex Cloud command line interface yet, install and initialize it.
The folder specified in the CLI profile is used by default. You can specify a different folder using the --folder-name
or --folder-id
parameter.
To get information about a MongoDB cluster backup, run the command:
yc managed-mongodb backup get <backup_ID>
You can retrieve the backup ID with a list of backups.
To get information about a backup, use the get REST API method for the Backup resource or the BackupService/Get gRPC API call and provide the backup ID in the backupId
request parameter.
To find out the ID, retrieve a list of backups.
Examples
Create a new Managed Service for MongoDB cluster from a backup with the following test characteristics:
- Backup for recovery:
c9qlk4v13uq7********:...
. - Point in time to restore to:
1597060810
(2020-08-10 12:00:10
). - Version:
4.2
. - Name of the new cluster:
mynewmg
. - Environment:
PRODUCTION
. - Network:
default
. - One
s2.micro
host in theru-central1-a
availability zone andb0rcctk2rvtr********
subnet. - With 20 GB of SSD network storage (
network-ssd
). - With databases and users that existed in the cluster at the time of recovery.
Run the following command:
yc managed-mongodb cluster restore \
--backup-id c9qlk4v13uq7********:... \
--recovery-target-timestamp 1597060810 \
--mongodb-version 4.2 \
--name mynewmg \
--environment PRODUCTION \
--network-name default \
--host zone-id=ru-central1-a,subnet-id=b0rcctk2rvtr8efcch64 \
--mongod-resource-preset s2.micro \
--mongod-disk-size 20 \
--mongod-disk-type network-ssd