Updating MongoDB cluster settings

If you do not have the Yandex Cloud CLI yet, install and initialize it.

The folder specified in the CLI profile is used by default. You can specify a different folder through the --folder-name or --folder-id parameter.

To change the host class for the cluster:

1. View the description of the CLI command to update the cluster:

   yc managed-mongodb cluster update --help
   

2. Request a list of available host classes (the ZONE IDS column specifies the availability zones where you can select the appropriate class):

   yc managed-mongodb resource-preset list
   
   +-----------+--------------------------------+-------+----------+
   |    ID     |            ZONE IDS            | CORES |  MEMORY  |
   +-----------+--------------------------------+-------+----------+
   | s1.micro  | ru-central1-a, ru-central1-b,  |     2 | 8.0 GB   |
   |           | ru-central1-d                  |       |          |
   | ...                                                           |
   +-----------+--------------------------------+-------+----------+
   

3. Specify the class in the update cluster command. When changing the class, keep in mind the host role: it depends on the sharding type. You can use parameters for hosts with different roles in a single command.

   • For MONGOD hosts:

     yc managed-mongodb cluster update <cluster_name_or_ID> \
        --mongod-resource-preset <class_ID>
     

   • For MONGOINFRA hosts:

     yc managed-mongodb cluster update <cluster_name_or_ID> \
        --mongoinfra-resource-preset <class_ID>
     

   • For MONGOS hosts:

     yc managed-mongodb cluster update <cluster_name_or_ID> \
        --mongos-resource-preset <class_ID>
     

   • For MONGOCFG hosts:

     yc managed-mongodb cluster update <cluster_name_or_ID> \
        --mongocfg-resource-preset <class_ID>
     

   Managed Service for MongoDB will run the update host class command for the cluster.

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

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

2. In the Managed Service for MongoDB cluster description, change the resource_preset_id parameter value for resources_mongod, resources_mongoinfra, resources_mongos, or resources_mongocfg. The resource type depends on the sharding type.

   Example:

   resource "yandex_mdb_mongodb_cluster" "<cluster_name>" {
     ...
     resources_mongod {
         resource_preset_id = "<host_class>"
         ...
     }
   }
   

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.

For more information, see the Terraform provider documentation.

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.mongodb.<MongoDB_host_type>.resources.resourcePresetId",
                 "configSpec": {
                   "mongodb": {
                     "<MongoDB_host_type>": {
                       "resources": {
                         "resourcePresetId": "<host_class>"
                       }    
                     }
                   }
                 }
               }'
   

   Where:

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

     Only one parameter is provided in this case.

   • configSpec.mongodb.<MongoDB_host_type>.resources.resourcePresetId: New host class.

     MongoDB host type depends on the sharding type. Possible values: mongod, mongocfg, mongos, and mongoinfra. For a non-sharded cluster, use mongod.

   You can request the cluster ID with the 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.mongodb.<MongoDB_host_type>.resources.resource_preset_id"
               ]
             },
             "config_spec": {
               "mongodb": {
                 "<MongoDB_host_type>": {
                   "resources": {
                     "resource_preset_id": "<host_class>"
                   }    
                 }
               }
             }
           }' \
       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.mongodb.<MongoDB_host_type>.resources.resourcepresetid: New host class.

     MongoDB host type depends on the sharding type. Possible values: mongod, mongocfg, mongos, and mongoinfra. For a non-sharded cluster, use mongod.

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

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

If you do not have the Yandex Cloud CLI yet, install and initialize it.

The folder specified in the CLI profile is used by default. You can specify a different folder through the --folder-name or --folder-id parameter.

To change the disk type and increase the storage size for a cluster:

1. View the description of the CLI command to update the cluster:

   yc managed-mongodb cluster update --help
   

2. Specify the disk type and required storage size in the cluster update command (at least as large as disk_size in the cluster properties).

   When increasing the storage size, keep in mind the host role: it depends on the sharding type. You can use parameters for hosts with different roles in a single command.

   • For MONGOD hosts:

     yc managed-mongodb cluster update <cluster_name_or_ID> \
        --mongod-disk-type <disk_type> \
        --mongod-disk-size <storage_size_in_GB>
     

   • For MONGOINFRA hosts:

     yc managed-mongodb cluster update <cluster_name_or_ID> \
        --mongoinfra-disk-type <disk_type> \
        --mongoinfra-disk-size <storage_size_in_GB>
     

   • For MONGOS hosts:

     yc managed-mongodb cluster update <cluster_name_or_ID> \
        --mongos-disk-type <disk_type> \
        --mongos-disk-size <storage_size_in_GB>
     

   • For MONGOCFG hosts:

     yc managed-mongodb cluster update <cluster_name_or_ID> \
        --mongocfg-disk-type <disk_type> \
        --mongocfg-disk-size <storage_size_in_GB>
     

   If all the conditions are met, Managed Service for MongoDB will start the storage reconfiguration operation.

To change the disk type and increase the storage size for a cluster:

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

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

2. In the Managed Service for MongoDB cluster description, change the values of the disk_type_id and disk_size parameters for the following resources: resources_mongod, resources_mongoinfra, resources_mongos, and resources_mongocfg. The resource type depends on the sharding type.

   Example:

   resource "yandex_mdb_mongodb_cluster" "<cluster_name>" {
     ...
     resources_mongod {
       disk_type_id = "<disk_type>"
       disk_size    = <storage_size_in_GB>
       ...
     }
   }
   

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.

For more information, see the Terraform provider documentation.

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.mongodb.<MongoDB_host_type>.resources.diskTypeId,configSpec.mongodb.<MongoDB_host_type>.resources.diskSize",
                 "configSpec": {
                   "mongodb": { 
                     "<MongoDB_host_type>": {
                       "resources": {
                         "diskTypeId": "<disk_type>",
                         "diskSize": "<storage_size_in_bytes>"
                       }  
                     }
                   }
                 }
               }'
   

   Where:

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

   • configSpec.mongodb.<MongoDB_host_type>.resources: Storage parameters:

     • diskTypeId: Disk type.
     • diskSize: New storage size in bytes.

     MongoDB host type depends on the sharding type. Possible values: mongod, mongocfg, mongos, and mongoinfra. For a non-sharded cluster, use mongod.

   You can request the cluster ID with the 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.mongodb.<MongoDB_host_type>.resources.disk_type_id",
                 "config_spec.mongodb.<MongoDB_host_type>.resources.disk_size"
               ]
             },
             "config_spec": {
               "mongodb": {
                 "<MongoDB_host_type>": {
                   "resources": {
                     "disk_type_id": "<disk_type>",
                     "disk_size": "<storage_size_in_bytes>"
                   }    
                 }
               }
             }
           }' \
       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.

   • config_spec.mongodb.<MongoDB_host_type>.resources.disk_size: Storage parameters:

     • disk_type_id: Disk type.
     • disk_size: New storage size in bytes.

     The MongoDB host type depends on the sharding type. Possible values: mongod, mongocfg, mongos, and mongoinfra. For a non-sharded cluster, use mongod.

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

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

If you do not have the Yandex Cloud CLI yet, install and initialize it.

The folder specified in the CLI profile is used by default. You can specify a different folder through the --folder-name or --folder-id parameter.

To update the MongoDB settings for a cluster, run the command:

yc managed-mongodb cluster update-config

For example, to set net.maxIncomingConnections to 4096, run the following command:

yc managed-mongodb cluster update-config <cluster_name> \
   --set net.max_incoming_connections=4096

Managed Service for MongoDB will run the update DBMS settings command for the cluster. If the setting being changed is only applied when the database is restarted, Managed Service for MongoDB will restart the database instances on all cluster hosts, one by one.

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.mongodb.<MongoDB_host_type>.config.<setting_1>,configSpec.mongodb.<MongoDB_host_type>.config.<setting_2>,...,configSpec.mongodb.<MongoDB_host_type>.config.<setting_N>",
                 "configSpec": {
                   "mongodb": {    
                     "<MongoDB_host_type>": {
                       "config": {
                         "<setting_1>": "<value_1>",
                         "<setting_2>": "<value_2>",
                         ...
                         "<setting_N>": "<value_N>"
                       }
                     }
                   }    
                 }
               }'
   

   Where:

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

   • configSpec.mongodb.<MongoDB_host_type>.config: Set of MongoDB settings. Use a separate line for each setting; separate them by commas. All supported settings are described in the API reference and in MongoDB settings.

     MongoDB host type depends on the sharding type. Possible values: mongod, mongocfg, mongos, and mongoinfra. For a non-sharded cluster, use mongod.

   You can request the cluster ID with the 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.mongodb.<MongoDB_host_type>.config.<setting_1>",
                 "config_spec.mongodb.<MongoDB_host_type>.config.<setting_2>",
                 ...
                 "config_spec.mongodb.<MongoDB_host_type>.config.<setting_N>"
               ]
             },
             "config_spec": {
               "mongodb": {    
                 "<MongoDB_host_type>": {
                   "config": {
                     "<setting_1>": "<value_1>",
                     "<setting_2>": "<value_2>",
                     ...
                     "<setting_N>": "<value_N>"
                   }
                 }
               }
             }
           }' \
       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.

   • config_spec.mongodb.<MongoDB_host_type>.config: Set of MongoDB settings. Use a separate line for each setting; separate them by commas. All supported settings are described in the API reference and in MongoDB settings.

     MongoDB host type depends on the sharding type. Possible values: mongod, mongocfg, mongos, and mongoinfra. For a non-sharded cluster, use mongod.

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

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

If you do not have the Yandex Cloud CLI yet, install and initialize it.

The folder specified in the CLI profile is used by default. You can specify a different folder through the --folder-name or --folder-id parameter.

To change additional cluster settings:

1. View the description of the CLI command to update the cluster:

   yc managed-mongodb cluster update --help
   

2. Run the following command with the list of settings to update:

   yc managed-mongodb cluster update <cluster_ID_or_name> \
     --backup-retain-period-days=<retention_period> \
     --backup-window-start <backup_start_time> \
     --maintenance-window type=<maintenance_type>,`
                          `day=<day_of_week>,`
                          `hour=<hour> \
     --performance-diagnostics=<enable_diagnostics> \
     --deletion-protection
   

You can change the following settings:

• --backup-retain-period: Automatic backup retention period, in days.

  The <retention_period> parameter value must be in the range from 7 to 35 (the default value is 7). This feature is at the Preview stage. For more information, see Backups.

  Changing the retention period affects both new automatic backups and existing backups.

  For example, if the original retention period was 7 days, and the remaining lifetime of a separate automatic backup is 1 day, then increasing the retention period to 9 days will change the remaining lifetime of this backup to 3 days.

• --backup-window-start: The cluster backup start time, set in UTC format HH:MM:SS. If the time is not set, the backup will start at 22:00 UTC.

• --maintenance-window: Maintenance window settings (including for disabled clusters), where type is the maintenance type:

  • anytime (default): Any time.
  • weekly: On a schedule. If setting this value, specify the day of week and the hour:
    • day: Day of week in DDD format: MON, TUE, WED, THU, FRI, SAT, or SUN.
    • hour: Hour (UTC) in HH format: 1 to 24.

• --performance-diagnostics: Specify this parameter to use the Performance diagnostics tool in the cluster. This feature is at the Preview stage.

• --deletion-protection: Protection of the cluster, its databases, and users against accidental deletion.

  Enabled deletion protection will not prevent a manual connection with the purpose to delete database contents.

You can get the cluster ID and name with the 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.

2. To change the backup start time, add a backup_window_start section to the Managed Service for MongoDB cluster description under cluster_config:

   resource "yandex_mdb_mongodb_cluster" "<cluster_name>" {
     ...
     cluster_config {
       backup_window_start {
         hours   = <hour>
         minutes = <minute>
       }
       ...
     }
     ...
   }
   

   Where hours and minutes are the backup start hour and minute.

3. To set up the maintenance window (for disabled clusters as well), add the maintenance_window block to the cluster description:

   resource "yandex_mdb_mongodb_cluster" "<cluster_name>" {
     ...
     maintenance_window {
       type = <maintenance_type>
       day  = <day_of_week>
       hour = <hour>
     }
     ...
   }
   

   Where:

   • type: Maintenance type. The possible values include:
     • anytime: Anytime.
     • weekly: By schedule.
   • day: Day of the week for the weekly type in DDD format, e.g., MON.
   • hour: Hour of the day for the weekly type in the HH format, e.g., 21.

4. To enable cluster protection against accidental deletion by a user of your cloud, add the deletion_protection field set to true to your cluster description:

   resource "yandex_mdb_mongodb_cluster" "<cluster_name>" {
     ...
     deletion_protection = <deletion_protection>
   }
   

   Where deletion_protection is the cluster deletion protection,true or false.

   Enabled deletion protection will not prevent a manual connection with the purpose to delete database contents.

5. 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.

6. 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.

For more information, see the Terraform provider documentation.

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. Create a file named body.json and add the following contents to it:

   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.

   {
     "updateMask": "configSpec.backupWindowStart,configSpec.backupRetainPeriodDays,configSpec.performanceDiagnostics,maintenanceWindow,deletionProtection",
     "configSpec": {
       "backupWindowStart":  {
         "hours": "<hours>",
         "minutes": "<minutes>",
         "seconds": "<seconds>",
         "nanos": "<nanoseconds>"
       },
       "backupRetainPeriodDays": "<backup_storage_time_in_days>",
       "performanceDiagnostics": {
         "profilingEnabled": <enable_profiler:_true_or_false>
       }
     }
     "maintenanceWindow": {
       "weeklyMaintenanceWindow": {
         "day": "<day_of_week>",
         "hour": "<hour>"
       }
     },    
     "deletionProtection": <deletion_protection:_true_or_false>
   }
   

   Where:

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

   • configSpec: Cluster settings:

     • backupWindowStart: Backup window settings.

       In this parameter, specify the backup start time:

       • hours: Between 0 and 23 hours.
       • minutes: Between 0 and 59 minutes.
       • seconds: Between 0 and 59 seconds.
       • nanos: Between 0 and 999999999 nanoseconds.

     • backupRetainPeriodDays: Backup storage time in days.

     • performanceDiagnostics: Statistics collection settings:

       • profilingEnabled: Enable profiler.

   • maintenanceWindow: Maintenance window settings (including for disabled clusters). In maintenanceWindow, provide one of the two parameters:

     • anytime: Maintenance can take place at any time.

     • weeklyMaintenanceWindow: Maintenance takes place once a week at the specified time:

       • day: Day of week, in DDD format.
       • hour: Hour, in HH format. The values range from 1 to 24 hours.

   • deletionProtection: Protection of the cluster, its databases, and users against accidental deletion. Even if enabled, one can still connect manually and delete the database content.

3. Use the Cluster.Update method and send the following request, e.g., via cURL:

   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 "@body.json"
   

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

4. 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. Create a file named body.json and add the following contents to it:

   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>"
       ]
   }
   

   {
     "cluster_id": "<cluster_ID>",
     "update_mask": {
       "paths": [
         "config_spec.backup_window_start",
         "config_spec.backup_retain_period_days",
         "config_spec.performance_diagnostics",
         "maintenance_window",
         "deletion_protection"
       ]
     },
     "config_spec": {
       "backup_window_start": {
         "hours": "<hours>",
         "minutes": "<minutes>",
         "seconds": "<seconds>",
         "nanos": "<nanoseconds>"
       },
       "backup_retain_period_days": "<backup_storage_time_in_days>",
       "performance_diagnostics": {
         "profiling_enabled": <enable_profiler:_true_or_false>
       }
     },
     "maintenance_window": {
       "weekly_maintenance_window": {
         "day": "<day_of_week>",
         "hour": "<hour>"
       }
     },
     "deletion_protection": <deletion_protection:_true_or_false>
   }
   

   Where:

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

   • config_spec: Cluster settings:

     • backup_window_start: Backup window settings.

       In this parameter, specify the backup start time:

       • hours: Between 0 and 23 hours.
       • minutes: Between 0 and 59 minutes.
       • seconds: Between 0 and 59 seconds.
       • nanos: Between 0 and 999999999 nanoseconds.

     • backup_retain_period_days: Backup retention in days.

     • performance_diagnostics: Statistics collection settings:

       • profiling_enabled: Enable profiler.

   • maintenance_window: Maintenance window settings (including for disabled clusters). In maintenance_window, provide one of the two parameters:

     • anytime: Maintenance can take place at any time.

     • weekly_maintenance_window: Maintenance takes place once a week at the specified time:

       • day: Day of week, in DDD format.
       • hour: Hour, in HH format. The values range from 1 to 24 hours.

   • deletion_protection: Protection of the cluster, its databases, and users against accidental deletion. Even if enabled, one can still connect manually and delete the database content.

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

   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 @ \
       mdb.api.cloud.yandex.net:443 \
       yandex.cloud.mdb.mongodb.v1.ClusterService.Update \
       < body.json
   

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

If you do not have the Yandex Cloud CLI yet, install and initialize it.

The folder specified in the CLI profile is used by default. You can specify a different folder through the --folder-name or --folder-id parameter.

To move a cluster:

1. View the description of the CLI move cluster command:

   yc managed-mongodb cluster move --help
   

2. Specify the destination folder in the move cluster command:

   yc managed-mongodb cluster move <cluster_name_or_ID> \
      --destination-folder-name=<destination_folder_name>
   

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

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

   export IAM_TOKEN="<IAM_token>"
   

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

   curl \
       --request POST \
       --header "Authorization: Bearer $IAM_TOKEN" \
       --header "Content-Type: application/json" \
       --url 'https://mdb.api.cloud.yandex.net/managed-mongodb/v1/clusters/<cluster_ID>:move' \
       --data '{
                 "destinationFolderId": "<folder_ID>"
               }'
   

   Where destinationFolderId is the ID of the folder you want to move your cluster to. You can fetch this ID together with the list of folders in the cloud.

   You can request the cluster ID with the 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.Move call and send the following request, e.g., via gRPCurl:

   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>",
             "destination_folder_id": "<folder_ID>"
           }' \
       mdb.api.cloud.yandex.net:443 \
       yandex.cloud.mdb.mongodb.v1.ClusterService.Move
   

   Where destination_folder_id is the ID of the folder you want to move your cluster to. You can fetch this ID together with the list of folders in the cloud.

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

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

If you do not have the Yandex Cloud CLI yet, install and initialize it.

The folder specified in the CLI profile is used by default. You can specify a different folder through the --folder-name or --folder-id parameter.

To edit the list of security groups for your cluster:

1. View the description of the CLI command to update the cluster:

   yc managed-mongodb cluster update --help
   

2. Specify the security groups in the update cluster command:

   yc managed-mongodb cluster update <cluster_name_or_ID> \
     --security-group-ids <list_of_security_group_IDs>
   

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

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

2. In the Managed Service for MongoDB cluster description, change the security_group_ids parameter value:

   resource "yandex_mdb_mongodb_cluster" "<cluster_name>" {
     ...
     security_group_ids = [ <list_of_security_group_IDs> ]
     ...
   }
   

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.

For more information, see the Terraform provider documentation.

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": "securityGroupIds",
                 "securityGroupIds": [
                   "<security_group_1_ID>",
                   "<security_group_2_ID>",
                   ...
                   "<security_group_N_ID>"
                 ]
               }'
   

   Where:

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

     Only one parameter is provided in this case.

   • securityGroupIds: List of security group IDs.

   You can request the cluster ID with the 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": [
                 "security_group_ids"
               ]
             },
             "security_group_ids": [
               "<security_group_1_ID>",
               "<security_group_2_ID>",
               ...
               "<security_group_N_ID>"
             ]
           }' \
       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.

   • security_group_ids: List of security group IDs.

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

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