Updating MongoDB cluster settings

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 change the host class for the cluster:

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

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

To change the host class, use the update REST API method for the Cluster resource or the ClusterService/Update gRPC API call and provide the following in the request:

• Cluster ID in the clusterId parameter. To find out the cluster ID, get a list of clusters in the folder.

• Host class in the configSpec.mongodbSpec_<MongoDB_version>.mongod.resources.resourcePresetId parameter.

  To retrieve a list of supported values, use the list method for the ResourcePreset resources.

• List of settings to update in the updateMask parameter.

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 increase the cluster storage size:

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

   yc managed-mongodb cluster update --help
   

2. Specify the required storage size in the update cluster command. It must be at least as large as the current disk_size value 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-size <storage_size_in_GB>
     

   • For MONGOINFRA hosts:

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

   • For MONGOS hosts:

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

   • For MONGOCFG hosts:

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

   If all these conditions are met, Managed Service for MongoDB will launch the operation to increase the storage size.

To increase the cluster storage size:

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 disk_size 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 {
       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
  }
}

To increase the cluster storage size, use the update REST API method for the Cluster resource or the ClusterService/Update gRPC API call and provide the following in the request:

• Cluster ID in the clusterId parameter. To find out the cluster ID, get a list of clusters in the folder.
• New storage size in the configSpec.mongodbSpec_<MongoDB_version>.mongod.resources.diskSize parameter.
• List of settings to update in the updateMask parameter.

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

To change MongoDB settings, use the update REST API method for the Cluster resource or the ClusterService/Update gRPC API call and provide the following in the request:

• Cluster ID in the clusterId parameter. To find out the cluster ID, get a list of clusters in the folder.

• Target MongoDB setting values in the configSpec.mongodbSpec_<MongoDB_version>.mongod.config parameter.

  All supported settings are described in the API reference and in MongoDB settings.

• List of cluster settings to update in the updateMask parameter.

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 change additional cluster settings:

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

   yc managed-mongodb cluster update --help
   

2. Run the following command with a 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 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.

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 enable access from Yandex DataLens, add the access section to the Managed Service for MongoDB cluster description under cluster_config:

   resource "yandex_mdb_mongodb_cluster" "<cluster_name>" {
     ...
     cluster_config {
       ...
       access {
         data_lens = <access_from_DataLens>
       }
     ...
   }
   

   Where data_lens enables access from DataLens, true or false.

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

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

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

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

To change additional cluster settings, use the update REST API method for the Cluster resource or the ClusterService/Update gRPC API call and provide the following in the request:

• Cluster ID in the clusterId parameter. To find out the cluster ID, get a list of clusters in the folder.

• New backup start time in the configSpec.backupWindowStart parameter.

• Settings for access from other services in the configSpec.access parameter.

• Maintenance window settings (including for disabled clusters) in the maintenanceWindow parameter.

• Permission to collect statistics for cluster performance diagnostics in the performanceDiagnostics.profilingEnabled parameter.

• Cluster deletion protection settings in the deletionProtection parameter.

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

• List of cluster configuration fields to update in the updateMask parameter.

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 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 a list of clusters in the folder.

To move a cluster, use the move REST API method for the Cluster resource or the ClusterService/Move gRPC API call and provide the following in the request:

• Cluster ID in the clusterId parameter. To find out the cluster ID, get a list of clusters in the folder.
• ID of the destination folder in the destinationFolderId parameter.

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 edit the list of security groups for your cluster:

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

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

To update security groups, use the update REST API method for the Cluster resource or the ClusterService/Update gRPC API call and provide the following in the request:

• Cluster ID in the clusterId parameter. To find out the cluster ID, get a list of clusters in the folder.
• List of security group IDs in the securityGroupIds parameter.
• List of cluster configuration fields to update in the updateMask parameter.