Updating Yandex StoreDoc cluster settings

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

By default, the CLI uses the folder specified when creating the profile. To change the default folder, use the yc config set folder-id <folder_ID> command. You can also set a different folder for any specific command using the --folder-name or --folder-id parameter.

To change the cluster’s host class:

1. See the description of the CLI command for updating a cluster:

   yc managed-mongodb cluster update --help
   

2. Get the list of available host classes. The ZONE IDS column indicates the availability zones supporting each 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. Run the cluster update command, providing the required host class: When changing the class, consider the host’s role, which depends on the sharding type. A single command supports arguments for multiple host roles.

   • 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>
     

   Yandex StoreDoc will start the host class update operation for your cluster.

1. Open the current Terraform configuration file describing your infrastructure.

   To learn how to create this file, see Creating a cluster.

2. In the Yandex StoreDoc cluster description, update the value of the resource_preset_id argument for resources_mongod, resources_mongoinfra, resources_mongos, and resources_mongocfg resources. The resource type depends on the sharding type.

   Here is an example:

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

3. Validate your configuration.

   1. In the command line, navigate to the directory that contains the current Terraform configuration files defining the infrastructure.

   2. Run this command:

      terraform validate
      

      Terraform will show any errors found in your configuration files.

4. Confirm resource changes.

   1. Run this command to view the planned changes:

      terraform plan
      

      If you described the configuration correctly, the terminal will display a list of the resources to update and their parameters. This is a verification step that does not apply changes to your resources.

   2. If everything looks correct, apply the changes:

      1. Run this command:

         terraform apply
         

      2. Confirm updating the resources.

      3. Wait for the operation to complete.

For more information, see this Terraform provider guide.

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 place it in an environment variable:

   export IAM_TOKEN="<IAM_token>"
   

2. Call the Cluster.Update method, e.g., via the following cURL request:

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

   Where:

   • updateMask: Comma-separated list of settings you want to update.

     Here, we provide only one setting.

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

     The Yandex StoreDoc host type depends on the sharding type. The possible values are mongod, mongocfg, mongos, and mongoinfra. For a non-sharded cluster, use mongod.

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

3. Check the server response to make sure your request was successful.

1. Get an IAM token for API authentication and place it in an 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 that the repository contents reside in the ~/cloudapi/ directory.

3. Call the ClusterService.Update method, e.g., via the following gRPCurl request:

   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.<Yandex_StoreDoc_host_type>.resources.resource_preset_id"
               ]
             },
             "config_spec": {
               "mongodb": {
                 "<Yandex_StoreDoc_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 settings you want to update as an array of strings (paths[]).

     Here, we provide only one setting.

   • config_spec.mongodb.<Yandex_StoreDoc_host_type>.resources.resource_preset_id: New host class.

     The Yandex StoreDoc host type depends on the sharding type. The possible values are mongod, mongocfg, mongos, and mongoinfra. For a non-sharded cluster, use mongod.

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

4. Check the server response to make sure your request was successful.

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

By default, the CLI uses the folder specified when creating the profile. To change the default folder, use the yc config set folder-id <folder_ID> command. You can also set a different folder for any specific command using the --folder-name or --folder-id parameter.

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

1. See the description of the CLI command for updating a cluster:

   yc managed-mongodb cluster update --help
   

2. Specify the disk type and the required storage size in the cluster update command. The specified storage size must not be less than the disk_size cluster setting.

   When expanding storage, consider the host’s role, which depends on the sharding type. A single command supports arguments for multiple host roles.

   • 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, Yandex StoreDoc will start the storage reconfiguration operation.

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

1. Open the current Terraform configuration file describing your infrastructure.

   To learn how to create this file, see Creating a cluster.

2. In the Yandex StoreDoc cluster description, change the values of the disk_type_id and disk_size arguments for the resources_mongod, resources_mongoinfra, resources_mongos, and resources_mongocfg resources. The resource type depends on the sharding type.

   Here is an example:

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

3. Validate your configuration.

   1. In the command line, navigate to the directory that contains the current Terraform configuration files defining the infrastructure.

   2. Run this command:

      terraform validate
      

      Terraform will show any errors found in your configuration files.

4. Confirm resource changes.

   1. Run this command to view the planned changes:

      terraform plan
      

      If you described the configuration correctly, the terminal will display a list of the resources to update and their parameters. This is a verification step that does not apply changes to your resources.

   2. If everything looks correct, apply the changes:

      1. Run this command:

         terraform apply
         

      2. Confirm updating the resources.

      3. Wait for the operation to complete.

For more information, see this Terraform provider guide.

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 place it in an environment variable:

   export IAM_TOKEN="<IAM_token>"
   

2. Call the Cluster.Update method, e.g., via the following cURL request:

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

   Where:

   • updateMask: Comma-separated list of settings you want to update.

   • configSpec.mongodb.<Yandex_StoreDoc_host_type>.resources: Storage settings:

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

     The Yandex StoreDoc host type depends on the sharding type. The possible values are mongod, mongocfg, mongos, and mongoinfra. For a non-sharded cluster, use mongod.

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

3. Check the server response to make sure your request was successful.

1. Get an IAM token for API authentication and place it in an 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 that the repository contents reside in the ~/cloudapi/ directory.

3. Call the ClusterService.Update method, e.g., via the following gRPCurl request:

   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.<Yandex_StoreDoc_host_type>.resources.disk_type_id",
                 "config_spec.mongodb.<Yandex_StoreDoc_host_type>.resources.disk_size"
               ]
             },
             "config_spec": {
               "mongodb": {
                 "<Yandex_StoreDoc_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 settings you want to update as an array of strings (paths[]).

   • config_spec.mongodb.<Yandex_StoreDoc_host_type>.resources.disk_size: Storage settings:

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

     The Yandex StoreDoc host type depends on the sharding type. The possible values are mongod, mongocfg, mongos, and mongoinfra. For a non-sharded cluster, use mongod.

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

4. Check the server response to make sure your request was successful.

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

By default, the CLI uses the folder specified when creating the profile. To change the default folder, use the yc config set folder-id <folder_ID> command. You can also set a different folder for any specific command using the --folder-name or --folder-id parameter.

To update the Yandex StoreDoc cluster settings, use the following command:

yc managed-mongodb cluster update-config

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

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

Yandex StoreDoc will launch the reconfiguration of the cluster’s DBMS settings. If an updated setting requires a DBMS restart, Yandex StoreDoc will perform a rolling restart on all cluster hosts.

1. Get an IAM token for API authentication and place it in an environment variable:

   export IAM_TOKEN="<IAM_token>"
   

2. Call the Cluster.Update method, e.g., via the following cURL request:

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

   Where:

   • updateMask: Comma-separated list of settings you want to update.

   • configSpec.mongodb.<Yandex_StoreDoc_host_type>.config: List of Yandex StoreDoc settings. Enter each setting on a new line, separated by commas. All supported settings are described in the API reference and in Yandex StoreDoc settings.

     The Yandex StoreDoc host type depends on the sharding type. The possible values are mongod, mongocfg, mongos, and mongoinfra. For a non-sharded cluster, use mongod.

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

3. Check the server response to make sure your request was successful.

1. Get an IAM token for API authentication and place it in an 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 that the repository contents reside in the ~/cloudapi/ directory.

3. Call the ClusterService.Update method, e.g., via the following gRPCurl request:

   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.<Yandex_StoreDoc_host_type>.config.<setting_1>",
                 "config_spec.mongodb.<Yandex_StoreDoc_host_type>.config.<setting_2>",
                 ...
                 "config_spec.mongodb.<Yandex_StoreDoc_host_type>.config.<setting_N>"
               ]
             },
             "config_spec": {
               "mongodb": {    
                 "<Yandex_StoreDoc_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 settings you want to update as an array of strings (paths[]).

   • config_spec.mongodb.<Yandex_StoreDoc_host_type>.config: List of Yandex StoreDoc settings. Enter each setting on a new line, separated by commas. All supported settings are described in the API reference and in Yandex StoreDoc settings.

     The Yandex StoreDoc host type depends on the sharding type. The possible values are mongod, mongocfg, mongos, and mongoinfra. For a non-sharded cluster, use mongod.

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

4. Check the server response to make sure your request was successful.

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

By default, the CLI uses the folder specified when creating the profile. To change the default folder, use the yc config set folder-id <folder_ID> command. You can also set a different folder for any specific command using the --folder-name or --folder-id parameter.

To change advanced cluster settings:

1. See the description of the CLI command for updating a cluster:

   yc managed-mongodb cluster update --help
   

2. Run the following command, providing the list of settings you want 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 update the following settings:

• --backup-retain-period: Retention period for automatic backups, in days.

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

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

  For example, if the original retention period was 7 days, and the remaining lifetime of a specific automatic backup was 1 day, then increasing the retention period to 9 days would make that backup’s remaining lifetime 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 that apply to both running and stopped clusters. The type setting defines the maintenance type:

  • anytime: At any time (default).
  • weekly: On a schedule. For this value, also specify the following:
    • day: Day of week, i.e., MON, TUE, WED, THU, FRI, SAT, or SUN.
    • hour: Hour of day (UTC), from 1 to 24.

• --performance-diagnostics: Specify this setting to use the Performance diagnostics tool in your cluster. This feature is in Preview.

• --deletion-protection: Cluster protection from accidental deletion, true or false.

  Even with cluster deletion protection enabled, one can still delete a user or database or connect manually and delete the 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 describing your infrastructure.

   To learn how to create this file, see Creating a cluster.

2. To change the backup start time, locate your Yandex StoreDoc cluster description and add the backup_window_start section under cluster_config:

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

   Where hours is the hour and minutes is the minute of the backup start time.

3. To set up the maintenance window (for disabled clusters as well), add the maintenance_window section 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: On a schedule
   • day: Day of week for the WEEKLY type, i.e., MON, TUE, WED, THU, FRI, SAT, or SUN.
   • hour: UTC hour for the WEEKLY type, from 1 to 24.

4. To protect your cluster against accidental deletion, add the deletion_protection field set to true to your cluster description:

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

   Even with cluster deletion protection enabled, one can still delete a user or database or connect manually and delete the database contents.

   To disable deletion protection, set this value to false.

5. Validate your configuration.

   1. In the command line, navigate to the directory that contains the current Terraform configuration files defining the infrastructure.

   2. Run this command:

      terraform validate
      

      Terraform will show any errors found in your configuration files.

6. Confirm resource changes.

   1. Run this command to view the planned changes:

      terraform plan
      

      If you described the configuration correctly, the terminal will display a list of the resources to update and their parameters. This is a verification step that does not apply changes to your resources.

   2. If everything looks correct, apply the changes:

      1. Run this command:

         terraform apply
         

      2. Confirm updating the resources.

      3. Wait for the operation to complete.

For more information, see this Terraform provider guide.

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 place it in an environment variable:

   export IAM_TOKEN="<IAM_token>"
   

2. Create a file named body.json and paste the following code into 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_retention_in_days>",
       "performanceDiagnostics": {
         "profilingEnabled": <enable_profiler>
       }
     }
     "maintenanceWindow": {
       "weeklyMaintenanceWindow": {
         "day": "<day_of_week>",
         "hour": "<hour>"
       }
     },    
     "deletionProtection": <protect_cluster_from_deletion>
   }
   

   Where:

   • updateMask: Comma-separated list of settings you want to update.

   • configSpec: Cluster settings:

     • backupWindowStart: Backup window settings.

       Here, 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 retention time in days.

     • performanceDiagnostics: Statistics collection settings:

       • profilingEnabled: Enable profiler, true or false.

   • maintenanceWindow: Maintenance window settings, applying to both running and stopped clusters. In maintenanceWindow, provide one of the following values:

     • anytime: Maintenance can occur at any time.

     • weeklyMaintenanceWindow: Maintenance occurs once a week at the specified time:

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

   • deletionProtection: Cluster deletion protection, true or false.

     Even with cluster deletion protection enabled, one can still delete a user or database or connect manually and delete the database contents.

3. Call the Cluster.Update method, e.g., via the following cURL request:

   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 get the cluster ID from the list of clusters in your folder.

4. Check the server response to make sure your request was successful.

1. Get an IAM token for API authentication and place it in an 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 that the repository contents reside in the ~/cloudapi/ directory.

3. Create a file named body.json and paste the following code into 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_retention_in_days>",
       "performance_diagnostics": {
         "profiling_enabled": <enable_profiler>
       }
     },
     "maintenance_window": {
       "weekly_maintenance_window": {
         "day": "<day_of_week>",
         "hour": "<hour>"
       }
     },
     "deletion_protection": <protect_cluster_from_deletion>
   }
   

   Where:

   • update_mask: List of settings you want to update as an array of strings (paths[]).

   • config_spec: Cluster settings:

     • backup_window_start: Backup window settings.

       Here, 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 time in days.

     • performance_diagnostics: Statistics collection settings:

       • profiling_enabled: Enable profiler, true or false.

   • maintenance_window: Maintenance window settings, applying to both running and stopped clusters. In maintenance_window, provide one of the following values:

     • anytime: Maintenance can occur at any time.

     • weekly_maintenance_window: Maintenance occurs once a week at the specified time:

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

   • deletion_protection: Cluster deletion protection, true or false.

     Even with cluster deletion protection enabled, one can still delete a user or database or connect manually and delete the database contents.

4. Call the ClusterService.Update method, e.g., via the following gRPCurl request:

   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. Check the server response to make sure your request was successful.

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

By default, the CLI uses the folder specified when creating the profile. To change the default folder, use the yc config set folder-id <folder_ID> command. You can also set a different folder for any specific command using the --folder-name or --folder-id parameter.

To move a cluster:

1. See the description of the CLI command for moving a cluster:

   yc managed-mongodb cluster move --help
   

2. Run the cluster move command, providing the destination folder:

   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. Open the current Terraform configuration file describing your infrastructure.

   To learn how to create this file, see Creating a cluster.

2. In the Yandex StoreDoc cluster description, add or update the folder_id argument:

   resource "yandex_mdb_mongodb_cluster" "<cluster_name>" {
     ...
     folder_id = "<destination_folder_ID>"
   }
   

3. Validate your configuration.

   1. In the command line, navigate to the directory that contains the current Terraform configuration files defining the infrastructure.

   2. Run this command:

      terraform validate
      

      Terraform will show any errors found in your configuration files.

4. Confirm resource changes.

   1. Run this command to view the planned changes:

      terraform plan
      

      If you described the configuration correctly, the terminal will display a list of the resources to update and their parameters. This is a verification step that does not apply changes to your resources.

   2. If everything looks correct, apply the changes:

      1. Run this command:

         terraform apply
         

      2. Confirm updating the resources.

      3. Wait for the operation to complete.

For more information, see this Terraform provider guide.

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 place it in an environment variable:

   export IAM_TOKEN="<IAM_token>"
   

2. Call the Cluster.Move method, e.g., via the following cURL request:

   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 target folder for your cluster. You can get it from the list of your cloud folders

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

3. Check the server response to make sure your request was successful.

1. Get an IAM token for API authentication and place it in an 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 that the repository contents reside in the ~/cloudapi/ directory.

3. Call the ClusterService.Move method, e.g., via the following gRPCurl request:

   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 target folder for your cluster. You can get it from the list of your cloud folders

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

4. Check the server response to make sure your request was successful.

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

By default, the CLI uses the folder specified when creating the profile. To change the default folder, use the yc config set folder-id <folder_ID> command. You can also set a different folder for any specific command using the --folder-name or --folder-id parameter.

To change the list of security groups for your cluster:

1. See the description of the CLI command for updating a cluster:

   yc managed-mongodb cluster update --help
   

2. Run the cluster update command, providing the required security groups:

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

1. Open the current Terraform configuration file describing your infrastructure.

   To learn how to create this file, see Creating a cluster.

2. Update the security_group_ids value in the Yandex StoreDoc cluster description:

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

3. Validate your configuration.

   1. In the command line, navigate to the directory that contains the current Terraform configuration files defining the infrastructure.

   2. Run this command:

      terraform validate
      

      Terraform will show any errors found in your configuration files.

4. Confirm resource changes.

   1. Run this command to view the planned changes:

      terraform plan
      

      If you described the configuration correctly, the terminal will display a list of the resources to update and their parameters. This is a verification step that does not apply changes to your resources.

   2. If everything looks correct, apply the changes:

      1. Run this command:

         terraform apply
         

      2. Confirm updating the resources.

      3. Wait for the operation to complete.

For more information, see this Terraform provider guide.

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 place it in an environment variable:

   export IAM_TOKEN="<IAM_token>"
   

2. Call the Cluster.Update method, e.g., via the following cURL request:

   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: Comma-separated list of settings you want to update.

     Here, we provide only one setting.

   • securityGroupIds: List of security group IDs.

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

3. Check the server response to make sure your request was successful.

1. Get an IAM token for API authentication and place it in an 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 that the repository contents reside in the ~/cloudapi/ directory.

3. Call the ClusterService.Update method, e.g., via the following gRPCurl request:

   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 settings you want to update as an array of strings (paths[]).

     Here, we provide only one setting.

   • security_group_ids: List of security group IDs.

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

4. Check the server response to make sure your request was successful.