Changing ClickHouse® settings at the server level

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 configure ClickHouse®:

1. View the full list of settings specified for the cluster:

   yc managed-clickhouse cluster get <cluster_name_or_ID> --full
   

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

   yc managed-clickhouse cluster update-config --help
   

3. Set the required parameter values:

   yc managed-clickhouse cluster update-config <cluster_name_or_ID> \
      --set <parameter_1_name>=<value_1>,...
   

To configure ClickHouse®:

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 ClickHouse® cluster description, under clickhouse.config, change the values of the following parameters:

   resource "yandex_mdb_clickhouse_cluster" "<cluster_name>" {
     ...
     clickhouse {
       ...
   
       config {
         # General DBMS settings
         ...
   
         merge_tree {
           # MergeTree engine settings
           ...
         }
   
         kafka {
           # General settings to get data from Apache Kafka
           ...
         }
   
         kafka_topic {
           # Settings for an individual Apache Kafka topic
           ...
         }
   
         rabbit_mq {
           # Settings for getting data from RabbitMQ
           username = "<username>"
           password = "<password>"
         }
   
         compression {
           # Data compression settings
           method              = "<compression_method>"
           min_part_size       = <data_part_size>
           min_part_size_ratio = <size_ratio>
         }
   
         graphite_rollup {
           # GraphiteMergeTree engine settings for thinning, aggregating, and averaging (rollup) Graphite data.
           ...
         }
       }
       ...
     }
     ...
   }
   

   Where:

   • method: Compression method, LZ4 or ZSTD.
   • min_part_size: Minimum size of a table data part, bytes.
   • min_part_size_ratio: Smallest table data part to the full table size ratio.

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 configure ClickHouse®, 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.
• Required values in the configSpec.clickhouse.config parameter.
• List of settings to update, in the updateMask parameter.