Updating MySQL® 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 a description of the update cluster CLI command:

   yc managed-mysql 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-mysql resource-preset list
   

   Result:

   +-----------+--------------------------------+-------+----------+
   |    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:

   yc managed-mysql cluster update <cluster_name_or_ID>
     --resource-preset <class_ID>
   

   Managed Service for MySQL® 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 how to create this file, see Creating clusters.

2. In the Managed Service for MySQL® cluster description, change the resource_preset_id parameter value under resources:

   resource "yandex_mdb_mysql_cluster" "<cluster_name>" {
     ...
     resources {
       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_mysql_cluster" "<cluster_name>" {
  ...
  timeouts {
    create = "1h30m" # 1 hour 30 minutes
    update = "2h"    # 2 hours
    delete = "30m"   # 30 minutes
  }
}

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 you need in the configSpec.resources.resourcePresetId parameter. To request a list of supported values, use the list method for the ResourcePreset resources.
• List of settings to update (in this case, configSpec.resources.resourcePresetId) 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 a description of the update cluster CLI command:

   yc managed-mysql cluster update --help
   

2. Specify the required storage in the cluster update command (it must be at least as large as disk_size in the cluster properties):

   yc managed-mysql cluster update <cluster_name_or_ID> \
     --disk-size <storage_size_GB>
   

To increase the cluster storage size:

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

   For more information about how to create this file, see Creating clusters.

2. Change the disk_size parameter value under resources:

   resource "yandex_mdb_mysql_cluster" "<cluster_name>" {
     ...
     resources {
       disk_size = <storage_size_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_mysql_cluster" "<cluster_name>" {
  ...
  timeouts {
    create = "1h30m" # 1 hour 30 minutes
    update = "2h"    # 2 hours
    delete = "30m"   # 30 minutes
  }
}

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.
• Storage size in the configSpec.resources.diskSize parameter.
• List of cluster configuration fields to update in the updateMask parameter (in this case, configSpec.resources.diskSize).

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 MySQL® settings:

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

   yc managed-mysql cluster update-config --help
   

2. Set the required parameter values.

   All supported parameters are listed in the request format for the update method, in the mysql_config_5_7 field. To specify the parameter name in the CLI's call, convert the name from lowerCamelCase to snake_case. For example, the logMinDurationStatement parameter from an API request should be converted to log_min_duration_statement for the CLI command:

   yc managed-mysql cluster update-config <cluster_name>
      --set log_min_duration_statement=100,<parameter_name>=<value>,...
   

   Managed Service for MySQL® runs the update cluster settings operation.

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

   For more information about how to create this file, see Creating clusters.

2. In the Managed Service for MySQL® cluster description, add or update the DBMS settings under mysql_config:

   resource "yandex_mdb_mysql_cluster" "<cluster_name>" {
     ...
     mysql_config = {
       <MySQL®_setting_name> = <value>
       ...
     }
   }
   

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_mysql_cluster" "<cluster_name>" {
  ...
  timeouts {
    create = "1h30m" # 1 hour 30 minutes
    update = "2h"    # 2 hours
    delete = "30m"   # 30 minutes
  }
}

To change MySQL® 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.
• Array with new MySQL® settings in the following parameter:
  • configSpec.mysqlConfig_5_7.sqlMode for MySQL® 5.7.
  • configSpec.mysqlConfig_8_0.sqlMode for MySQL® 8.0.
• 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 change additional cluster settings:

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

   yc managed-mysql cluster update --help
   

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

   yc managed-mysql cluster update <cluster_name_or_ID> \
     --backup-window-start <backup_start_time> \
     --backup-retain-period-days=<backup_retention_period> \
     --datalens-access=<true_or_false> \
     --websql-access=<true_or_false> \
     --maintenance-window type=<maintenance_type>,`
                         `day=<day_of_week>,`
                         `hour=<hour> \
     --deletion-protection=<deletion_protection> \
     --performance-diagnostics enabled=true,`
                              `sessions-sampling-interval=<session_sampling_interval>,`
                              `statements-sampling-interval=<statement_sampling_interval>
   

You can change the following settings:

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

• --backup-retain-period-days: Retention period for automatic backups (in days). Acceptable values are from 7 to 60. The default value is 7.

• --datalens-access: Enables access from DataLens. The default value is false. For more information about setting up a connection, see Connecting to a MySQL® cluster from DataLens.

• --websql-access: Enables you to run SQL queries to cluster databases from the Yandex Cloud management console using Yandex WebSQL. The default value is false.

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

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

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

• performance-diagnostics: Enabling statistics collection for cluster performance diagnostics. The values of the sessions-sampling-interval and the statements-sampling-interval parameters may range from 1 to 86400 seconds.

You can retrieve the cluster name with a list of clusters in the folder.

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

   For more information about how to create this file, see Creating clusters.

2. To change the backup start time, add a backup_window_start block to the Managed Service for MySQL® cluster description:

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

   Where:

   • hours: Backup starting hour
   • minutes: Backup starting minutes

3. To change the retention period for backup files, define the backup_retain_period_days parameter in the cluster description:

     resource "yandex_mdb_mysql_cluster" "<cluster_name>" {
       ...
       backup_retain_period_days = <backup_retention_period>
       ...
     }
   

   Where backup_retain_period_days is the retention period for automatic backups (in days). Acceptable values are from 7 to 60. The default value is 7.

4. To enable access from DataLens and allow execution of SQL queries from the management console using Yandex WebSQL, add a section named access to the cluster description:

   resource "yandex_mdb_mysql_cluster" "<cluster_name>" {
     ...
     access {
       data_lens = <true_or_false>
       web_sql   = <true_or_false>
       ...
     }
     ...
   }
   

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

   resource "yandex_mdb_mysql_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.

6. 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_mysql_cluster" "<cluster_name>" {
     ...
     deletion_protection = <deletion_protection>
   }
   

   Where deletion_protection is cluster deletion protection, true or false.

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

7. To enable statistics collection for cluster performance diagnostics, add the performance_diagnostics section to your Managed Service for MySQL® cluster description:

   resource "yandex_mdb_mysql_cluster" "<cluster_name>" {
     ...
     performance_diagnostics {
       enabled = true
       sessions_sampling_interval = <session_sampling_interval>
       statements_sampling_interval = <statement_sampling_interval>
     }
     ...
   }
   

   The values of the sessions_sampling_interval and the statements_sampling_interval parameters may range from 1 to 86400 seconds.

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

9. 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_mysql_cluster" "<cluster_name>" {
  ...
  timeouts {
    create = "1h30m" # 1 hour 30 minutes
    update = "2h"    # 2 hours
    delete = "30m"   # 30 minutes
  }
}

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.

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

• Backup window settings in the configSpec.backupWindowStart parameter.

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

• Retention period of automatic backups in the configSpec.backupRetainPeriodDays parameter. Acceptable values are from 7 to 60. The default value is 7.

• Cluster deletion protection settings in the deletionProtection parameter.

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

• Settings of statistics collection for cluster performance diagnostics in the configSpec.performanceDiagnostics parameter.

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

If you do not have the Yandex Cloud command line interface yet, install and initialize it.

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

To move a cluster:

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

   yc managed-mysql cluster move --help
   

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

   yc managed-mysql cluster move <cluster_ID> \
      --destination-folder-name=<destination_folder_name>
   

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

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

   For more information about how to create this file, see Creating clusters.

2. In the Managed Service for MySQL® cluster description, add or edit the folder_id parameter value:

   resource "yandex_mdb_mysql_cluster" "<cluster_name>" {
     ...
     folder_id = "<target_folder_ID>"
   }
   

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_mysql_cluster" "<cluster_name>" {
  ...
  timeouts {
    create = "1h30m" # 1 hour 30 minutes
    update = "2h"    # 2 hours
    delete = "30m"   # 30 minutes
  }
}

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 a description of the update cluster CLI command:

   yc managed-mysql cluster update --help
   

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

   yc managed-mysql 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 how to create this file, see Creating clusters.

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

   resource "yandex_mdb_mysql_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_mysql_cluster" "<cluster_name>" {
  ...
  timeouts {
    create = "1h30m" # 1 hour 30 minutes
    update = "2h"    # 2 hours
    delete = "30m"   # 30 minutes
  }
}

To edit the list of cluster 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 settings to update (in this case, securityGroupIds) in the updateMask parameter.