Upgrading the ClickHouse® version

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 get a list of available versions, run the following command:

yc managed-clickhouse version list

To view the list of available versions, use the list REST API method for the Versions resource or the VersionsService/List gRPC API call.

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.

1. Get a list of your ClickHouse® clusters and view their versions:

   yc managed-clickhouse cluster list
   
   +----------------------+------+-------------+---------+---------------------+--------+---------+
   |          ID          | NAME | ENVIRONMENT | VERSION |     CREATED AT      | HEALTH | STATUS  |
   +----------------------+------+-------------+---------+---------------------+--------+---------+
   | c9qf1kmm0ebi******** | mych | PRODUCTION  |    23.8 | 2024-06-06 10:23:22 | ALIVE  | RUNNING |
   +----------------------+------+-------------+---------+---------------------+--------+---------+
   

2. Update the ClickHouse® version for any cluster as needed:

   yc managed-clickhouse cluster update --id <cluster_ID> --version <ClickHouse®_version>
   

   Specify the ClickHouse® version: 23.8, 24.3, 24.4 or 24.5.

When the update starts, the cluster status will switch to UPDATING. Wait for the operation to complete and then check the cluster version.

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 the Managed Service for ClickHouse® cluster description, add the version field or change its value if it is already there:

   resource "yandex_mdb_clickhouse_cluster" "<cluster_name>" {
     ...
     version = "<ClickHouse®_version>"
   }
   

   Specify the ClickHouse® version: 23.8, 24.3, 24.4 or 24.5.

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

To update a version, 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.
• ClickHouse® version in the configSpec.version parameter: 23.8, 24.3, 24.4 or 24.5.
• List of settings to update (in our case, configSpec.version) in the updateMask parameter.