MySQL® version upgrade

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 upgrade a MySQL® version:

1. Get the list of your MySQL® clusters using this command:

   yc managed-mysql cluster list
   

2. Get the details of the cluster in question and check its MySQL® version in the config.version setting:

   yc managed-mysql cluster get <cluster_name_or_ID>
   

3. Run the MySQL® upgrade:

   yc managed-mysql cluster update <cluster_name_or_ID> \
      --mysql-version <new_version_number>
   

The time required for an upgrade depends on multiple factors, such as the amount of data or the number of databases in your cluster. Usually, an upgrade takes a few minutes; for large databases, it can take 10 minutes or more.

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

   For information on how to create such a file, see Creating a cluster.

2. Add the version field to the yandex_mdb_mysql_cluster resource or change the field value if it already exists:

   resource "yandex_mdb_mysql_cluster" "<cluster_name>" {
      ...
      version = "<MySQL®_version>"
      ...
   }
   

3. Make sure the settings are correct.

   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 updating the resources.

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

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. 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-mysql/v1/clusters/<cluster_ID>' \
      --data '{
                "updateMask": "configSpec.version",
                "configSpec": {
                  "version": "<MySQL®_version>"
                }
              }'
   

   Where:

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

     Here, we provide only one setting.

   • configSpec.version: New MySQL® version.

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

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

1. Get an IAM token for API authentication and set 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. 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/mysql/v1/cluster_service.proto \
      -rpc-header "Authorization: Bearer $IAM_TOKEN" \
      -d '{
            "cluster_id": "<cluster_ID>",
            "update_mask": {
              "paths": [
                "config_spec.version"
              ]
            },
            "config_spec": {
              "version": "<MySQL®_version>"
            }
          }' \
      mdb.api.cloud.yandex.net:443 \
      yandex.cloud.mdb.mysql.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.version: New MySQL® version.

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

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

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

2. Set the version field to 8.0 in the yandex_mdb_mysql_cluster resource:

   resource "yandex_mdb_mysql_cluster" "<cluster_name>" {
      ...
      version = "8.0"
      ...
   }
   

3. Make sure the settings are correct:

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

Terraform will automatically detect the need for version upgrade and start the process.