Managing backups in Managed Service for MongoDB

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:

1. View a description of the CLI restore MongoDB cluster command:

   yc managed-mongodb cluster restore --help
   

2. 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 backup completion time is shown in the CREATED AT column of the list of available backups, in yyyy-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.

3. 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 <time_point> \
       --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_in_GB> \
       --mongod-disk-type <disk_type> \
       --performance-diagnostics=<enable_diagnostics>
   

   Where:

   • --recovery-target-timestamp: Time point to restore the MongoDB cluster to, in UNIX time format. If you omit this parameter, the cluster state will be restored to the backup completion time.

   • --environment: Environment, PRESTABLE or PRODUCTION.

   • --mongod-disk-type: Disk type, network-hdd or network-ssd.

   • --performance-diagnostics: Enables cluster performance diagnostics, true or false.

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:

• ID of the backup you need, in the backupId parameter. To find out the ID, get 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 time point to restore the MongoDB cluster to, in UNIX time format. If you omit this parameter, the cluster state will be restored to the backup completion time.

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:

1. View a description of the CLI create MongoDB backup command:

   yc managed-mongodb cluster backup --help
   

2. 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 parameter of your request.

You can get the cluster ID with a list of clusters in the folder.

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: Automatic (AUTOMATED) or manual (MANUAL).

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 parameter of your request.

You can get 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 parameter of your request.

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 parameter of your request.

To find out the ID, retrieve a list of 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 set the retention period for automatic backups, provide the required value in the --backup-retain-period-days argument of the cluster update command:

yc managed-mongodb cluster update <cluster_name_or_ID> \
   --backup-retain-period-days=<retention_period_in_days>

The possible values range from 7 to 35. The default value is 7.

You can request the cluster ID and name with a list of clusters in the folder.

1. Open the current Terraform configuration file with an infrastructure plan.

   For more information about creating this file, see Creating clusters.

   For a complete list of available MongoDB cluster configuration fields, see the Terraform provider documentation.

2. Add a backup_retain_period_days block in the cluster_config section to the MongoDB cluster description:

     resource "yandex_mdb_mongodb_cluster" "<cluster_name>" {
       ...
       cluster_config {
         ...
         backup_retain_period_days = <retention_period_in_days>
         }
         ...
       }
       ...
   

   Where backup_retain_period_days is the automatic backup retention period.

   The possible values range from 7 to 35. The default value is 7.

3. Make sure the settings are correct.

   1. Using the command line, navigate to the folder that contains the up-to-date Terraform configuration files with an infrastructure plan.

   2. Run the command:

      terraform validate
      

      If there are errors in the configuration files, Terraform will point to them.

4. Confirm updating the resources.

   1. Run the command to view planned changes:

      terraform plan
      

      If the resource configuration descriptions are correct, the terminal will display a list of the resources to modify and their parameters. This is a test step. No resources are updated.

   2. If you are happy with the planned changes, apply them:

      1. Run the command:

         terraform apply
         

      2. Confirm the update of resources.

      3. Wait for the operation to complete.

   Timeouts

   The Terraform provider sets the following timeouts for Managed Service for MongoDB cluster operations:

   • Creating a cluster, including by restoring one from a backup: 30 minutes.
   • Editing a cluster: 60 minutes.

   Operations exceeding the set timeout are interrupted.

   How do I change these limits?

   Add the timeouts block to the cluster description, for example:

   resource "yandex_mdb_mongodb_cluster" "<cluster_name>" {
     ...
     timeouts {
       create = "1h30m" # An hour and a half
       update = "2h"    # Two hours
     }
   }
   

1. Get an IAM token for API authentication and put it into the environment variable:

   export IAM_TOKEN="<IAM_token>"
   

2. Use the Cluster.update method and send the following request, e.g., via cURL:

   Warning

   The API method will assign default values to all the parameters of the object you are modifying unless you explicitly provide them in your request. To avoid this, list the settings you want to change in the updateMask parameter as a single comma-separated string.

   curl \
       --request PATCH \
       --header "Authorization: Bearer $IAM_TOKEN" \
       --header "Content-Type: application/json" \
       --url 'https://mdb.api.cloud.yandex.net/managed-mongodb/v1/clusters/<cluster_ID>' \
       --data '{
                 "updateMask": "configSpec.backupRetainPeriodDays",
                 "configSpec": {
                   "backupRetainPeriodDays": <retention_period_in_days>
                 }
               }'
   

   Where:

   • updateMask: List of parameters to update as a single string, separated by commas.

     Only one parameter is provided in this case.

   • configSpec.backupRetainPeriodDays: Automatic backup retention period.

     The values range from 7 to 35. The default value is 7.

   You can get the cluster ID with a list of clusters in the folder.

3. View the server response to make sure the request was successful.

1. Get an IAM token for API authentication and put it into the environment variable:

   export IAM_TOKEN="<IAM_token>"
   

2. Clone the cloudapi repository:

   cd ~/ && git clone --depth=1 https://github.com/yandex-cloud/cloudapi
   

   Below, we assume the repository contents are stored in the ~/cloudapi/ directory.

3. Use the ClusterService/Update call and send the following request, e.g., via gRPCurl:

   Warning

   The API method will assign default values to all the parameters of the object you are modifying unless you explicitly provide them in your request. To avoid this, list the settings you want to change in the update_mask parameter as an array of paths[] strings.

   Format for listing settings

   "update_mask": {
       "paths": [
           "<setting_1>",
           "<setting_2>",
           ...
           "<setting_N>"
       ]
   }
   

   grpcurl \
       -format json \
       -import-path ~/cloudapi/ \
       -import-path ~/cloudapi/third_party/googleapis/ \
       -proto ~/cloudapi/yandex/cloud/mdb/mongodb/v1/cluster_service.proto \
       -rpc-header "Authorization: Bearer $IAM_TOKEN" \
       -d '{
             "cluster_id": "<cluster_ID>",
             "update_mask": {
               "paths": [
                 "config_spec.backup_retain_period_days"
               ]
             },
             "config_spec": {
               "backup_retain_period_days": <retention_period_in_days>
             }
           }' \
       mdb.api.cloud.yandex.net:443 \
       yandex.cloud.mdb.mongodb.v1.ClusterService.Update
   

   Where:

   • update_mask: List of parameters to update as an array of paths[] strings.

     Only one parameter is provided in this case.

   • config_spec.backup_retain_period_days: Automatic backup retention period.

     The values range from 7 to 35. The default value is 7.

   You can get the cluster ID with a list of clusters in the folder.

4. View the server response to make sure the request was successful.