Creating a MySQL® cluster

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 create a Managed Service for MySQL® cluster:

1. Check whether the folder has any subnets for the Managed Service for MySQL® cluster hosts:

   yc vpc subnet list
   

   If your folder has no subnets, create them in Yandex Virtual Private Cloud.

2. See the description of the CLI command for creating a Managed Service for MySQL® cluster:

   yc managed-mysql cluster create --help
   

3. Specify the Managed Service for MySQL® cluster parameters in the command:

   yc managed-mysql cluster create \
     --name=<cluster_name> \
     --environment <environment> \
     --network-name <network_name> \
     --host zone-id=<availability_zone>,`
       `subnet-id=<subnet_ID>,`
       `assign-public-ip=<allow_public_access_to_host>,`
       `priority=<priority_when_selecting_master_host>,`
       `backup-priority=<backup_priority> \
     --mysql-version <MySQL®_version> \
     --resource-preset <host_class> \
     --user name=<username>,password=<user_password> \
     --database name=<DB_name> \
     --disk-size <storage_size_in_GB> \
     --disk-type <network-hdd|network-ssd|network-ssd-nonreplicated|local-ssd> \
     --security-group-ids <list_of_security_group_IDs>
   

   You need to specify the subnet-id if the selected availability zone has two or more subnets.

   Where:

   • --environment: Environment, prestable or production.

   • --assign-public-ip: Public access to the host, true or false.

   • --disk-type: Disk type.

   • --priority: Host priority when selecting a new master host, between 0 and 100.

   • --backup-priority: Backup priority, between 0 and 100.

   • --mysql-version: MySQL® version, 5.7 or 8.0.

   • --user: Contains the MySQL® user name and password.

     The username may contain Latin letters, numbers, hyphens, and underscores, and must start with a letter, number, or underscore. It must be from 1 to 32 characters long.

     The password must be from 8 to 128 characters long.

     Note

     You can also generate a password using Connection Manager. To do this, modify the command, specifying user parameters as follows:

       --user name=<username>,generate-password=true
     

     To view the password, select your cluster in the management console, navigate to the Users tab, and click View password for the relevant user. This will open the page of the Yandex Lockbox secret containing the password. To view passwords, you need the lockbox.payloadViewer role.

   • --database name: Database name.

     The DB name may contain Latin letters, numbers, hyphens, and underscores. The name may be up to 63 characters long. Such names as mysql, sys, information_schema, and performance_schema are reserved for Managed Service for MySQL®. You cannot create DBs with these names.

   Specify additional Managed Service for MySQL® cluster settings, if required:

   yc managed-mysql cluster create \
     ...
     --backup-window-start <backup_start_time> \
     --backup-retain-period-days=<backup_retention_period> \
     --disk-encryption-key-id <KMS_key_ID> \
     --datalens-access=<allow_access_from_DataLens> \
     --websql-access=<allow_access_from_WebSQL> \
     --yandexquery-access=<allow_access_from_Yandex_Query> \
     --deletion-protection \
     --performance-diagnostics enabled=true,`
                              `sessions-sampling-interval=<session_sampling_interval>,`
                              `statements-sampling-interval=<statement_sampling_interval>
     --disk-size-autoscaling disk-size-limit=<max_storage_size_in_GB>,`
                            `planned-usage-threshold=<threshold_for_scheduled_increase_in_percent>,`
                            `emergency-usage-threshold=<threshold_for_immediate_increase_in_percent> \
     --maintenance-window type=<maintenance_type>,`
                         `day=<day_of_week>,`
                         `hour=<hour>
   

   Where:

   • --backup-window-start: Backup start time.

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

   • --disk-encryption-key-id: Disk encryption using a custom KMS key.

     To learn more about disk encryption, see Storage.

   • --datalens-access: Enables access to the cluster from Yandex 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 SQL queries against cluster databases from the Yandex Cloud management console using Yandex WebSQL. The default value is false.

   • --yandexquery-access: Enables YQL queries against cluster databases from Yandex Query. This feature is currently at the Preview stage. The default value is false.

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

   • --performance-diagnostics: Enables statistics collection for cluster performance diagnostics. For sessions-sampling-interval and statements-sampling-interval, the valid values range from 1 to 86400 seconds.

   • --disk-size-autoscaling: Automatic storage size increase settings:

     • planned-usage-threshold: Storage utilization threshold to trigger a storage increase during the next maintenance window, in percent. This is an optional setting. The default setting is 0 (automatic increase disabled).

       The valid values range from 0 to 100.

     • emergency-usage-threshold: Storage utilization threshold to trigger a storage increase right away, in percent. This is an optional setting. The default setting is 0 (automatic increase disabled).

       The valid values range from 0 to 100.

     • disk-size-limit: Maximum object size after increase, in GB.

     Warning

     • Automatic increase of storage size is not supported on dedicated hosts.

     • When using planned-usage-threshold, make sure to specify the --maintenance-window setting.

     • If you specify both thresholds, emergency-usage-threshold must be greater than planned-usage-threshold.

   • --maintenance-window: Maintenance window settings (including for disabled clusters), where type is 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.

   Configure the DBMS, if required.

With Terraform, you can quickly create a cloud infrastructure in Yandex Cloud and manage it using configuration files. These files store the infrastructure description written in HashiCorp Configuration Language (HCL). If you change the configuration files, Terraform automatically detects which part of your configuration is already deployed, and what should be added or removed.

Terraform is distributed under the Business Source License. The Yandex Cloud provider for Terraform is distributed under the MPL-2.0 license.

For more information about the provider resources, see the relevant documentation on the Terraform website or its mirror.

If you do not have Terraform yet, install it and configure the Yandex Cloud provider.

To create a Managed Service for MySQL® cluster:

1. In the configuration file, describe the properties of resources you want to create:

   • Database cluster: Description of the cluster and its hosts.

   • Database: Cluster database description.

     The DB name may contain Latin letters, numbers, hyphens, and underscores. The name may be up to 63 characters long. Such names as mysql, sys, information_schema, and performance_schema are reserved for Managed Service for MySQL®. You cannot create DBs with these names.

   • User: Cluster user description.

   • Network: Description of the cloud network where a cluster will be located. If you already have a suitable network, you don't have to describe it again.

   • Subnets: Description of the subnets to connect the cluster hosts to. If you already have suitable subnets, you don't have to describe them again.

   Here is an example of the configuration file structure:

   resource "yandex_mdb_mysql_cluster" "<cluster_name>" {
     name                = "<cluster_name>"
     environment         = "<environment>"
     network_id          = "<network_ID>"
     version             = "<MySQL®_version>"
     security_group_ids  = [ "<list_of_security_group_IDs>" ]
     deletion_protection = <protect_cluster_from_deletion>
   
     resources {
       resource_preset_id = "<host_class>"
       disk_type_id       = "<disk_type>"
       disk_size          = "<storage_size_in_GB>"
     }
   
     host {
       zone             = "<availability_zone>"
       subnet_id        = "<subnet_ID>"
       assign_public_ip = <allow_public_access_to_host>
       priority         = <priority_when_selecting_master_host>
       backup_priority  = <backup_priority>
     }
   }
   
   resource "yandex_mdb_mysql_database" "<DB_name>" {
     cluster_id = "<cluster_ID>"
     name       = "<DB_name>"
   }
   
   resource "yandex_mdb_mysql_user" "<username>" {
     cluster_id = "<cluster_ID>"
     name       = "<username>"
     password   = "<user_password>"
     permission {
       database_name = "<DB_name>"
       roles         = ["ALL"]
     }
   }
   
   resource "yandex_vpc_network" "<network_name>" { name = "<network_name>" }
   
   resource "yandex_vpc_subnet" "<subnet_name>" {
     name           = "<subnet_name>"
     zone           = "<availability_zone>"
     network_id     = "<network_ID>"
     v4_cidr_blocks = ["<range>"]
   }
   

   Where:

   • environment: Environment, PRESTABLE or PRODUCTION.

   • version: MySQL® version, 5.7 or 8.0.

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

   • assign_public_ip: Public access to the host, true or false.

   • priority: Host priority when selecting a new master host, between 0 and 100.

   • backup_priority: Backup priority, between 0 and 100.

   • name and password: MySQL® username and password, respectively.

     The username may contain Latin letters, numbers, hyphens, and underscores, and must start with a letter, number, or underscore. It must be from 1 to 32 characters long.

     The password must be from 8 to 128 characters long.

     Note

     You can also generate a password using Connection Manager. To do this, specify generate_password = true rather than password = "<user_password>".

     To view the password, select your cluster in the management console, navigate to the Users tab, and click View password for the relevant user. This will open the page of the Yandex Lockbox secret containing the password. To view passwords, you need the lockbox.payloadViewer role.

   • To configure automatic increase of storage size, add the disk_size_autoscaling section to the cluster description:

     resource "yandex_mdb_mysql_cluster" "<cluster_name>" {
       ...
       disk_size_autoscaling {
         disk_size_limit           = <maximum_storage_size_in_GB>
         emergency_usage_threshold = <threshold_for_immediate_increase_in_percent>
         planned_usage_threshold   = <threshold_for_scheduled_increase_in_percent>
       }
       ...
     }
     

     Where:

     • disk_size_limit: Maximum object size after increase, in gibibytes.

     • emergency_usage_threshold: Storage utilization threshold to trigger a storage increase right away, in percent. This is an optional setting. The default setting is 0 (automatic increase disabled).

       The valid values range from 0 to 100.

     • planned_usage_threshold: Storage utilization threshold to trigger a storage increase during the next maintenance window, in percent. This is an optional setting. The default setting is 0 (automatic increase disabled).

       The valid values range from 0 to 100.

     Warning

     • Automatic increase of storage size is not supported on dedicated hosts.

     • When using planned_usage_threshold, make sure to set the maintenance_window.

     • If you specify both thresholds, emergency_usage_threshold must be greater than planned_usage_threshold.

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

   • To encrypt the disk with a custom KMS key, add the disk_encryption_key_id parameter:

     resource "yandex_mdb_mysql_cluster" "<cluster_name>" {
       ...
       disk_encryption_key_id = <KMS_key_ID>
       ...
     }
     

     To learn more about disk encryption, see Storage.

   • To enable access from DataLens and allow 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>
       }
       ...
     }
     

   • To set the backup start time, add the backup_window_start section to your Managed Service for MySQL® cluster description:

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

     Where:

     • hours: Backup start hour.
     • minutes: Backup start minute.

   • To set the backup retention period, specify the backup_retain_period_days parameter in the Managed Service for MySQL® cluster description:

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

     Where backup_retain_period_days is automatic backup retention period, in days.

     The valid values range from 7 to 60. The default value is 7.

   • To enable statistics collection for cluster performance diagnostics, add a 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>
       }
       ...
     }
     

     For sessions_sampling_interval and statements_sampling_interval, the valid values range from 1 to 86400 seconds.

   For more information about the resources you can create with Terraform, see this provider article.

2. Make sure the configuration files are correct.

   1. In the command line, go to the folder where you created the configuration file.

   2. Run a check using this command:

      terraform plan
      

   If the configuration is described correctly, the terminal will display a list of created resources and their parameters. If the configuration contains any errors, Terraform will point them out. This is a test step; no resources will be created.

3. Create your Managed Service for MySQL® cluster.

   1. If the configuration does not contain any errors, run this command:

      terraform apply
      

   2. Confirm that you want to create the resources.

   After this, all required resources will be created in the specified folder and the IP addresses of the VMs will be displayed in the terminal. You can check the new resources and their configuration using the management console.

   Time limits

   A Terraform provider sets the timeout for Managed Service for MySQL® cluster operations:

   • Creating a cluster, including by restoring one from a backup: 15 minutes.
   • Editing a cluster, including the MySQL® version update: 60 minutes.
   • Deleting a cluster: 15 minutes.

   Operations exceeding the set timeout are interrupted.

   How do I change these limits?

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

   resource "yandex_mdb_mysql_cluster" "<cluster_name>" {
     ...
     timeouts {
       create = "1h30m" # 1 hour 30 minutes
       update = "2h"    # 2 hours
       delete = "30m"   # 30 minutes
     }
   }
   

1. Get an IAM token for API authentication and set it as an environment variable:

   export IAM_TOKEN="<IAM_token>"
   

2. Create a file named body.json and paste the following code into it:

   {
       "folderId": "<folder_ID>",
       "name": "<cluster_name>",
       "environment": "<environment>",
       "networkId": "<network_ID>",
       "securityGroupIds": [
           "<security_group_1_ID>",
           "<security_group_2_ID>",
           ...
           "<security_group_N_ID>"
       ],
       "deletionProtection": <protect_cluster_from_deletion>,
       "configSpec": {
           "version": "<MySQL®_version>",
           "resources": {
               "resourcePresetId": "<host_class>",
               "diskSize": "<storage_size_in_bytes>",
               "diskTypeId": "<disk_type>"
           },
           "access": {
               "dataLens": <allow_access_from_DataLens>,
               "webSql": <allow_access_from_WebSQL>,
               "yandexQuery": <allow_access_from_Yandex_Query>
           },
           "performanceDiagnostics": {
               "enabled": <enable_statistics_collection>,
               "sessionsSamplingInterval": "<session_sampling_interval>",
               "statementsSamplingInterval": "<statement_sampling_interval>"
           },
           "diskSizeAutoscaling": {
               "plannedUsageThreshold": "<threshold_for_scheduled_increase_in_percent>",
               "emergencyUsageThreshold": "<threshold_for_immediate_increase_in_percent>",
               "diskSizeLimit": "<maximum_storage_size_in_bytes>"
           }
       },
       "databaseSpecs": [
           {
               "name": "<DB_name>"
           },
           { <similar_configuration_for_DB_2> },
           { ... },
           { <similar_configuration_for_DB_N> }
       ],
       "userSpecs": [
           {
               "name": "<username>",
               "password": "<user_password>",
               "permissions": [
                   {
                       "databaseName": "<DB_name>",
                       "roles": [
                           "<privilege_1>", "<privilege_2>", ..., "<privilege_N>"
                       ]
                   }
               ]
           },
           { <similar_settings_for_user_2> },
           { ... },
           { <similar_settings_for_user_N> }
       ],
       "hostSpecs": [
           {
               "zoneId": "<availability_zone>",
               "subnetId": "<subnet_ID>",
               "assignPublicIp": <allow_public_access_to_host>
           },
           { <similar_settings_for_host_2> },
           { ... },
           { <similar_settings_for_host_N> }
       ],
       "maintenanceWindow": {
           "weeklyMaintenanceWindow": {
               "day": "<day_of_week>",
               "hour": "<hour>"
           }
       }
   }
   

   Where:

   • folderId: Folder ID. You can get it with the list of folders in the cloud.

   • name: Cluster name.

   • environment: Cluster environment, PRODUCTION or PRESTABLE.

   • networkId: ID of the network where the cluster will be deployed.

   • securityGroupIds: Security group IDs.

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

   • configSpec: Cluster settings:

     • version: MySQL® version.

     • resources: Cluster resources:

       • resourcePresetId: Host class.
       • diskSize: Disk size, in bytes.
       • diskTypeId: Disk type.

     • access: Settings for cluster access from Yandex Cloud services:

       • dataLens: Access from Yandex DataLens. For more information about setting up a connection, see Connecting to a MySQL® cluster from DataLens.
       • webSql: SQL queries against cluster databases from the Yandex Cloud management console using Yandex WebSQL.
       • yandexQuery: YQL queries against cluster databases from Yandex Query. This feature is currently at the Preview.

       The possible setting values are true or false.

   • performanceDiagnostics: Statistics collection settings:

     • enabled: Enables statistics collection, true or false.
     • sessionsSamplingInterval: Session sampling interval, from 1 to 86400 seconds.
     • statementsSamplingInterval: Statement sampling interval, from 1 to 86400 seconds.

   • diskSizeAutoscaling: Automatic storage size increase settings:

     • plannedUsageThreshold: Storage utilization threshold to trigger a storage increase during the next maintenance window, in percent. This is an optional setting. The default setting is 0 (automatic increase disabled).

       The valid values range from 0 to 100.

     • emergencyUsageThreshold: Storage utilization threshold to trigger a storage increase right away, in percent. This is an optional setting. The default setting is 0 (automatic increase disabled).

       The valid values range from 0 to 100.

     • diskSizeLimit: Maximum object size after increase, in bytes.

     Warning

     • Automatic increase of storage size is not supported on dedicated hosts.

     • When using plannedUsageThreshold, make sure to specify the maintenanceWindow setting.

     • If you specify both thresholds, emergencyUsageThreshold must be greater than plannedUsageThreshold.

   • databaseSpecs: Database settings as an array of elements, one per database. Each element contains the name parameter with the database name.

     The DB name may contain Latin letters, numbers, hyphens, and underscores. The name may be up to 63 characters long. Such names as mysql, sys, information_schema, and performance_schema are reserved for Managed Service for MySQL®. You cannot create DBs with these names.

   • userSpecs: User settings as an array of elements, one per user. Each element has the following structure:

     • name: Username.

     • password: Password. The password must be from 8 to 128 characters long.

       You can also generate a password using Connection Manager. To do this, specify "generatePassword": true rather than "password": "<user_password>".

       To view the password, select your cluster in the management console, navigate to the Users tab, and click View password for the relevant user. This will open the page of the Yandex Lockbox secret containing the password. To view passwords, you need the lockbox.payloadViewer role.

     • permissions: User permission settings:

       • databaseName: Name of the database to which the user will have access.
       • roles: Array of user privileges, each provided as a separate string in the array. For the list of possible values, see User privileges in a cluster.

       For each database, add a separate element with permission settings to the permissions array.

   • hostSpecs: Cluster host settings as an array of elements, one per host. Each element has the following structure:

     • zoneId: Availability zone.
     • subnetId: Subnet ID.
     • assignPublicIp: Permission to connect to the host from the internet, true or false.

   • maintenanceWindow: Maintenance window settings (including for disabled clusters). Provide one of these parameters:

     • anytime (default): Maintenance can take place at any time.

     • weeklyMaintenanceWindow: Scheduled maintenance:

       • day: Day of week, in DDD format. Valid values: MON, TUE, WED, THU, FRI, SAT, SUN.
       • hour: Time of day (UTC) in HH format. The valid values range from 1 to 24.

3. Call the Cluster.create 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-mysql/v1/clusters' \
       --data "@body.json"
   

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

1. Get an IAM token for API authentication and save it as 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 the repository contents are stored in the ~/cloudapi/ directory.

3. Create a file named body.json and paste the following code into it:

   {
       "folder_id": "<folder_ID>",
       "name": "<cluster_name>",
       "environment": "<environment>",
       "network_id": "<network_ID>",
       "security_group_ids": [
           "<security_group_1_ID>",
           "<security_group_2_ID>",
           ...
           "<security_group_N_ID>"
       ],
       "deletion_protection": <protect_cluster_from_deletion>,
       "config_spec": {
           "version": "<MySQL®_version>",
           "resources": {
               "resource_preset_id": "<host_class>",
               "disk_size": "<storage_size_in_bytes>",
               "disk_type_id": "<disk_type>"
           },
           "access": {
               "data_lens": <allow_access_from_DataLens>,
               "web_sql": <allow_access_from_WebSQL>,
               "yandex_query": <allow_access_from_Yandex_Query>
           },
           "performance_diagnostics": {
               "enabled": <enable_statistics_collection>,
               "sessions_sampling_interval": "<session_sampling_interval>",
               "statements_sampling_interval": "<statement_sampling_interval>"
           },
           "disk_size_autoscaling": {
               "planned_usage_threshold": "<threshold_for_scheduled_increase_in_percent>",
               "emergency_usage_threshold": "<threshold_for_immediate_increase_in_percent>",
               "disk_size_limit": "<maximum_storage_size_in_bytes>"
           }
       },
       "database_specs": [
             {
                 "name": "<DB_name>"
             },
             { <similar_configuration_for_DB_2> },
             { ... },
             { <similar_configuration_for_DB_N> }
         ],
       "user_specs": [
           {
               "name": "<username>",
               "password": "<user_password>",
               "permissions": [
                   {
                       "database_name": "<DB_name>",
                       "roles": [
                           "<privilege_1>", "<privilege_2>", ..., "<privilege_N>"
                       ]
                   }
               ]
           }
       ],
       "host_specs": [
           {
               "zone_id": "<availability_zone>",
               "subnet_id": "<subnet_ID>",
               "assign_public_ip": <allow_public_access_to_host>
           }
       ],
       "maintenance_window": {
         "weekly_maintenance_window": {
           "day": "<day_of_week>",
           "hour": "<hour>"
         }
       }
   }
   

   Where:

   • folder_id: Folder ID. You can request it with the list of folders in the cloud.

   • name: Cluster name.

   • environment: Cluster environment, PRODUCTION or PRESTABLE.

   • network_id: ID of the network where the cluster will be deployed.

   • security_group_ids: Security group IDs.

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

   • config_spec: Cluster settings:

     • version: MySQL® version.

     • resources: Cluster resources:

       • resource_preset_id: Host class.
       • disk_size: Disk size, in bytes.
       • disk_type_id: Disk type.

     • access: Settings for cluster access from Yandex Cloud services:

       • data_lens: Access from Yandex DataLens. For more information about setting up a connection, see Connecting to a MySQL® cluster from DataLens.
       • web_sql: SQL queries against cluster databases from the Yandex Cloud management console using Yandex WebSQL.
       • yandex_query: YQL queries against cluster databases from Yandex Query. This feature is currently at the Preview.

       The possible setting values are true or false.

   • performance_diagnostics: Statistics collection settings:

     • enabled: Enables statistics collection, true or false.
     • sessions_sampling_interval: Session sampling interval, from 1 to 86400 seconds.
     • statements_sampling_interval: Statement sampling interval, from 60 to 86400 seconds.

   • disk_size_autoscaling: Automatic storage size increase settings:

     • planned_usage_threshold: Storage utilization threshold to trigger a storage increase during the next maintenance window, in percent. This is an optional setting. The default setting is 0 (automatic increase disabled).

       The valid values range from 0 to 100.

     • emergency_usage_threshold: Storage utilization threshold to trigger a storage increase right away, in percent. This is an optional setting. The default setting is 0 (automatic increase disabled).

       The valid values range from 0 to 100.

     • disk_size_limit: Maximum object size after increase, in bytes.

     Warning

     • Automatic increase of storage size is not supported on dedicated hosts.

     • When using planned_usage_threshold, make sure to specify the maintenance_window setting.

     • If you specify both thresholds, emergency_usage_threshold must be greater than planned_usage_threshold.

   • database_specs: Database settings as an array of elements, one per database. Each element contains the name parameter with the database name.

   • user_specs: User settings as an array of elements, one per user. Each element has the following structure:

     • name: Username.

     • password: Password. The password must be from 8 to 128 characters long.

       You can also generate a password using Connection Manager. To do this, specify "generate_password": true rather than "password": "<user_password>".

       To view the password, select your cluster in the management console, navigate to the Users tab, and click View password for the relevant user. This will open the page of the Yandex Lockbox secret containing the password. To view passwords, you need the lockbox.payloadViewer role.

     • permissions: User permission settings:

       • database_name: Name of the database to which the user will have access.
       • roles: Array of user privileges, each provided as a separate string in the array. For the list of possible values, see User privileges in a cluster.

       For each database, add a separate element with permission settings to the permissions array.

   • host_specs: Cluster host settings as an array of elements, one for each host. Each element has the following structure:

     • zone_id: Availability zone.
     • subnet_id: Subnet ID.
     • assign_public_ip: Permission to connect to the host from the internet, true or false.

   • maintenance_window: Maintenance window settings (including for disabled clusters). Provide one of these parameters:

     • anytime (default): Maintenance can take place at any time.

     • weekly_maintenance_window: Scheduled maintenance:

       • day: Day of week, in DDD format. Valid values: MON, TUE, WED, THU, FRI, SAT, SUN.
       • hour: Time of day (UTC) in HH format. The valid values range from 1 to 24.

4. Use the ClusterService/Create 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/mysql/v1/cluster_service.proto \
       -rpc-header "Authorization: Bearer $IAM_TOKEN" \
       -d @ \
       mdb.api.cloud.yandex.net:443 \
       yandex.cloud.mdb.mysql.v1.ClusterService.Create \
       < body.json
   

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

Create a Managed Service for MySQL® cluster and a network for it with the following test specifications:

• Name: my-mysql.

• Version: 8.0.

• Environment: PRESTABLE.

• Cloud ID: b1gq90dgh25bebiu75o.

• Folder ID: b1gia87mbaomkfvsleds.

• Network: mynet (new one).

• Host class: s2.micro (one host), subnet: mysubnet, availability zone: ru-central1-a. mysubnet CIDR range: 10.5.0.0/24.

• Security group: mysql-sg (new one), allowing internet access to the Managed Service for MySQL® cluster on port 3306.

• Network SSD storage (network-ssd): 20 GB.

• User: user1, password: user1user1.

• Database: db1, where user1 has full privileges (same as GRANT ALL PRIVILEGES on db1.*).

• Deletion protection: Enabled.

The configuration file for this Managed Service for MySQL® cluster looks like this:

resource "yandex_mdb_mysql_cluster" "my-mysql" {
  name                = "my-mysql"
  environment         = "PRESTABLE"
  network_id          = yandex_vpc_network.mynet.id
  version             = "8.0"
  security_group_ids  = [ yandex_vpc_security_group.mysql-sg.id ]
  deletion_protection = true

  resources {
    resource_preset_id = "s2.micro"
    disk_type_id       = "network-ssd"
    disk_size          = 20
  }

  host {
    zone      = "ru-central1-a"
    subnet_id = yandex_vpc_subnet.mysubnet.id
  }
}

resource "yandex_mdb_mysql_database" "db1" {
  cluster_id = yandex_mdb_mysql_cluster.my-mysql.id
  name       = "db1"
}

resource "yandex_mdb_mysql_user" "user1" {
  cluster_id = yandex_mdb_mysql_cluster.my-mysql.id
  name       = "user1"
  password   = "user1user1"
  permission {
    database_name = yandex_mdb_mysql_database.db1.name
    roles         = ["ALL"]
  }
}

resource "yandex_vpc_network" "mynet" {
  name = "mynet"
}

resource "yandex_vpc_security_group" "mysql-sg" {
  name       = "mysql-sg"
  network_id = yandex_vpc_network.mynet.id

  ingress {
    description    = "MySQL®"
    port           = 3306
    protocol       = "TCP"
    v4_cidr_blocks = [ "0.0.0.0/0" ]
  }
}

resource "yandex_vpc_subnet" "mysubnet" {
  name           = "mysubnet"
  zone           = "ru-central1-a"
  network_id     = yandex_vpc_network.mynet.id
  v4_cidr_blocks = ["10.5.0.0/24"]
}

Create a Managed Service for MySQL® cluster and a network for it with the following test specifications:

• Name: my-mysql-3.

• Version: 8.0.

• Environment: PRESTABLE.

• Cloud ID: b1gq90dgh25bebiu75o.

• Folder ID: b1gia87mbaomkfvsleds.

• New network: mynet.

• s2.micro public hosts: 3.

  One host will be added to each new subnet:

  • mysubnet-a: 10.5.0.0/24, availability zone: ru-central1-a.
  • mysubnet-b: 10.6.0.0/24, availability zone: ru-central1-b.
  • mysubnet-d: 10.7.0.0/24, availability zone: ru-central1-d.

  These subnets will belong to the mynet network.

  The host residing in mysubnet-b will have the backup priority. If this host is not acting as the master, backups will be created from its data.

• New security group: mysql-sg, allowing connections to Managed Service for MySQL® clusters from the Internet through port 3306.

• Network SSD storage (network-ssd): 32 GB.

• User: user1, password: user1user1.

• Database: db1, where user1 has full privileges (same as GRANT ALL PRIVILEGES on db1.*).

The configuration file for this Managed Service for MySQL® cluster looks like this:

resource "yandex_mdb_mysql_cluster" "my-mysql-3" {
  name                = "my-mysql-3"
  environment         = "PRESTABLE"
  network_id          = yandex_vpc_network.mynet.id
  version             = "8.0"
  security_group_ids  = [ yandex_vpc_security_group.mysql-sg.id ]

  resources {
    resource_preset_id = "s2.micro"
    disk_type_id       = "network-ssd"
    disk_size          = 32
  }

  host {
    zone             = "ru-central1-a"
    subnet_id        = yandex_vpc_subnet.mysubnet-a.id
    assign_public_ip = true
  }

  host {
    zone             = "ru-central1-b"
    subnet_id        = yandex_vpc_subnet.mysubnet-b.id
    assign_public_ip = true
    backup_priority  = 10
  }

  host {
    zone             = "ru-central1-d"
    subnet_id        = yandex_vpc_subnet.mysubnet-d.id
    assign_public_ip = true
  }
}

resource "yandex_mdb_mysql_database" "db1" {
  cluster_id = yandex_mdb_mysql_cluster.my-mysql-3.id
  name       = "db1"
}

resource "yandex_mdb_mysql_user" "user1" {
  cluster_id = yandex_mdb_mysql_cluster.my-mysql-3.id
  name       = "user1"
  password   = "user1user1"
  permission {
    database_name = yandex_mdb_mysql_database.db1.name
    roles         = ["ALL"]
  }
}

resource "yandex_vpc_network" "mynet" {
  name = "mynet"
}

resource "yandex_vpc_security_group" "mysql-sg" {
  name       = "mysql-sg"
  network_id = yandex_vpc_network.mynet.id

  ingress {
    description    = "MySQL®"
    port           = 3306
    protocol       = "TCP"
    v4_cidr_blocks = [ "0.0.0.0/0" ]
  }
}

resource "yandex_vpc_subnet" "mysubnet-a" {
  name             = "mysubnet-a"
  zone             = "ru-central1-a"
  network_id       = yandex_vpc_network.mynet.id
  v4_cidr_blocks   = ["10.5.0.0/24"]
}

resource "yandex_vpc_subnet" "mysubnet-b" {
  name             = "mysubnet-b"
  zone             = "ru-central1-b"
  network_id       = yandex_vpc_network.mynet.id
  v4_cidr_blocks   = ["10.6.0.0/24"]
}

resource "yandex_vpc_subnet" "mysubnet-d" {
  name             = "mysubnet-d"
  zone             = "ru-central1-d"
  network_id       = yandex_vpc_network.mynet.id
  v4_cidr_blocks   = ["10.7.0.0/24"]
}