Updating ClickHouse® cluster settings

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 change the host class for a cluster:

1. View the description of the CLI command for updating a cluster:

   yc managed-clickhouse cluster update --help
   

2. Get the list of available host classes (the ZONE IDS column lists the availability zones you can select a class in):

   yc managed-clickhouse resource-preset list
   
   +-----------+--------------------------------+-------+----------+
   |    ID     |            ZONE IDS            | CORES |  MEMORY  |
   +-----------+--------------------------------+-------+----------+
   | s1.micro  | ru-central1-a, ru-central1-b,  |     2 | 8.0 GB   |
   |           | ru-central1-d                  |       |          |
   | ...                                                           |
   +-----------+--------------------------------+-------+----------+
   

3. Specify the required host class in the cluster update command:

   yc managed-clickhouse cluster update <cluster_name_or_ID> \
      --clickhouse-resource-preset=<class_ID>
   

   Managed Service for ClickHouse® will start updating the host class for your cluster.

4. To change the class of a ZooKeeper host, provide the value you need in the --zookeeper-resource-preset parameter.

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

   Learn how to create this file in Creating a cluster.

2. In the Managed Service for ClickHouse® cluster description, change the resource_preset_id value in the clickhouse.resources and zookeeper.resources sections for ClickHouse® and ZooKeeper hosts, respectively:

   resource "yandex_mdb_clickhouse_cluster" "<cluster_name>" {
     ...
     clickhouse {
       resources {
         resource_preset_id = "<ClickHouse®_host_class>"
         ...
       }
     }
     zookeeper {
       resources {
         resource_preset_id = "<ZooKeeper_host_class>"
         ...
       }
     }
   }
   

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

resource "yandex_mdb_clickhouse_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 put it in an environment variable:

   export IAM_TOKEN="<IAM_token>"
   

2. Get the list of available host classes:

   1. Call the ResourcePreset.List method, e.g., via the following cURL request:

      curl \
          --request GET \
          --header "Authorization: Bearer $IAM_TOKEN" \
          --url 'https://mdb.api.cloud.yandex.net/managed-clickhouse/v1/resourcePresets'
      

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

3. Change the host class as appropriate:

   1. 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-clickhouse/v1/clusters/<cluster_ID>' \
          --data '{
                    "updateMask": "configSpec.clickhouse.resources.resourcePresetId,configSpec.zookeeper.resources.resourcePresetId",
                    "configSpec": {
                      "clickhouse": {
                        "resources": {
                          "resourcePresetId": "<ClickHouse®_host_class_ID>"
                        }
                      },
                      "zookeeper": {
                        "resources": {
                          "resourcePresetId": "<ZooKeeper_host_class_ID>"
                        }
                      }
                    }
                  }'
      

      Where:

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

        Specify the relevant parameters:

        • configSpec.clickhouse.resources.resourcePresetId: To change the ClickHouse® host class.
        • configSpec.zookeeper.resources.resourcePresetId: To change the ZooKeeper host class.

        In our request example, we are changing the host class for both ClickHouse® and ZooKeeper hosts.

      • configSpec.clickhouse.resources.resourcePresetId: ClickHouse® host class ID.

      • configSpec.zookeeper.resources.resourcePresetId: ZooKeeper host class ID.

      You can get the cluster ID with the list of clusters in the folder. Earlier, you already obtained the list of available host classes with their IDs.

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

1. Get an IAM token for API authentication and put it in 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. Get the list of available host classes:

   1. Call the ResourcePresetService.List method, e.g., via the following gRPCurl request:

      grpcurl \
          -format json \
          -import-path ~/cloudapi/ \
          -import-path ~/cloudapi/third_party/googleapis/ \
          -proto ~/cloudapi/yandex/cloud/mdb/clickhouse/v1/resource_preset_service.proto \
          -rpc-header "Authorization: Bearer $IAM_TOKEN" \
          mdb.api.cloud.yandex.net:443 \
          yandex.cloud.mdb.clickhouse.v1.ResourcePresetService.List
      

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

4. Change the host class as appropriate:

   1. 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/clickhouse/v1/cluster_service.proto \
          -rpc-header "Authorization: Bearer $IAM_TOKEN" \
          -d '{
                "cluster_id": "<cluster_ID>",
                "update_mask": {
                  "paths": [
                    "config_spec.clickhouse.resources.resource_preset_id",
                    "config_spec.zookeeper.resources.resource_preset_id"
                  ]
                },
                "config_spec": {
                  "clickhouse": {
                    "resources": {
                      "resource_preset_id": "<ClickHouse®_host_class_ID>"
                    }
                  },
                  "zookeeper": {
                    "resources": {
                      "resource_preset_id": "<ZooKeeper_host_class_ID>"
                    }
                  }
                }
              }' \
          mdb.api.cloud.yandex.net:443 \
          yandex.cloud.mdb.clickhouse.v1.ClusterService.Update
      

      Where:

      • update_mask: List of settings you want to update as an array of strings (paths[]).

        Specify the relevant parameters:

        • config_spec.clickhouse.resources.resource_preset_id: To change the ClickHouse® host class.
        • config_spec.zookeeper.resources.resource_preset_id: To change the ZooKeeper host class.

        In our request example, we are changing the host class for both ClickHouse® and ZooKeeper hosts.

      • config_spec.clickhouse.resources.resource_preset_id: ClickHouse® host class ID.

      • config_spec.zookeeper.resources.resource_preset_id: ZooKeeper host class ID.

      You can get the cluster ID with the list of clusters in the folder. Earlier, you already obtained the list of available host classes with their IDs.

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

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 change the disk type and increase the storage size for a cluster:

1. View the description of the CLI command for updating a cluster:

   yc managed-clickhouse cluster update --help
   

2. Specify the required disk type and storage size in the cluster update command:

   yc managed-clickhouse cluster update <cluster_name_or_ID> \
     --clickhouse-disk-size <storage_size_in_GB> \
     --clickhouse-disk-type <disk_type>
   

   The new storage size must be at least as large as the disk_size in the cluster properties.

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

3. To change the disk type and increase the storage size for your ZooKeeper hosts, provide the appropriate values in the --zookeeper-disk-size parameter.

To change the disk type and increase the storage size, do the following:

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

   Learn how to create this file in Creating a cluster.

2. In the Managed Service for ClickHouse® cluster description, change the disk_size and disk_type_id values in the clickhouse.resources and zookeeper.resources sections for ClickHouse® and ZooKeeper hosts, respectively:

   resource "yandex_mdb_clickhouse_cluster" "<cluster_name>" {
     ...
     clickhouse {
       resources {
         disk_size = <storage_size_in_GB>
         disk_type_id = "<disk_type>"
         ...
       }
     }
     zookeeper {
       resources {
         disk_size = <storage_size_in_GB>
         disk_type_id = "<disk_type>"
         ...
       }
     }
   }
   

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

resource "yandex_mdb_clickhouse_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 put it in 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-clickhouse/v1/clusters/<cluster_ID>' \
       --data '{
                 "updateMask": "configSpec.clickhouse.resources.diskSize,configSpec.clickhouse.resources.diskTypeId,configSpec.zookeeper.resources.diskSize,configSpec.zookeeper.resources.diskTypeId",
                 "configSpec": {
                   "clickhouse": {
                     "resources": {
                       "diskSize": "<storage_size_in_bytes>",
                       "diskTypeId": "<disk_type>"
                     }
                   },
                   "zookeeper": {
                     "resources": {
                       "diskSize": "<storage_size_in_bytes>",
                       "diskTypeId": "<disk_type>"
                     }
                   }
                 }
               }'
   

   Where:

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

     Specify the relevant parameters:

     • configSpec.clickhouse.resources.diskSize,configSpec.clickhouse.resources.diskTypeId: To change the disk type and increase the storage size for your ClickHouse® hosts.
     • configSpec.zookeeper.resources.diskSize,configSpec.zookeeper.resources.diskTypeId: To change the disk type and increase the storage size for your ZooKeeper hosts.

     In our request example, we are resizing the storage and updating the disk type for both ClickHouse® and ZooKeeper hosts.

   • configSpec.clickhouse.resources.diskSize: ClickHouse® host storage size, in bytes.

   • configSpec.clickhouse.resources.diskTypeId: Disk type of ClickHouse® hosts.

   • configSpec.zookeeper.resources.diskSize: ZooKeeper host storage size, in bytes.

   • configSpec.zookeeper.resources.diskTypeId: Disk type of ZooKeeper hosts.

   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 put it in 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/clickhouse/v1/cluster_service.proto \
       -rpc-header "Authorization: Bearer $IAM_TOKEN" \
       -d '{
             "cluster_id": "<cluster_ID>",
             "update_mask": {
               "paths": [
                 "config_spec.clickhouse.resources.disk_size",
                 "config_spec.clickhouse.resources.disk_type_id",
                 "config_spec.zookeeper.resources.disk_size",
                 "config_spec.zookeeper.resources.disk_type_id"
               ]
             },
             "config_spec": {
               "clickhouse": {
                 "resources": {
                   "disk_size": "<storage_size_in_bytes>",
                   "disk_type_id": "<disk_type>"
                 }
               },
               "zookeeper": {
                 "resources": {
                   "disk_size": "<storage_size_in_bytes>",
                   "disk_type_id": "<disk_type>"
                 }
               }
             }
           }' \
       mdb.api.cloud.yandex.net:443 \
       yandex.cloud.mdb.clickhouse.v1.ClusterService.Update
   

   Where:

   • update_mask: List of settings you want to update as an array of strings (paths[]).

     Specify the relevant parameters:

     • config_spec.clickhouse.resources.disk_size: To expand the storage of ClickHouse® hosts.
     • config_spec.clickhouse.resources.disk_type_id: To change the disk type for ClickHouse® hosts.
     • config_spec.zookeeper.resources.disk_size: To expand the storage of ZooKeeper hosts.
     • config_spec.zookeeper.resources.disk_type_id: To change the disk type for ZooKeeper hosts.

     In our request example, we are resizing the storage and updating the disk type for both ClickHouse® and ZooKeeper hosts.

   • config_spec.clickhouse.resources.disk_size: ClickHouse® host storage size, in bytes.

   • config_spec.clickhouse.resources.disk_type_id: Disk type of ClickHouse® hosts.

   • config_spec.zookeeper.resources.disk_size: ZooKeeper host storage size, in bytes.

   • config_spec.zookeeper.resources.disk_type_id: Disk type of ZooKeeper hosts.

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

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

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.

1. To enable user management via SQL:

   • Set --enable-sql-user-management to true.
   • Set a password for admin in the --admin-password parameter.

   yc managed-clickhouse cluster update <cluster_name_or_ID> \
      ...
      --enable-sql-user-management true \
      --admin-password "<admin_password>"
   

2. To enable database management via SQL:

   • Set --enable-sql-user-management and --enable-sql-database-management to true.
   • Set a password for admin in the --admin-password parameter.

   yc managed-clickhouse cluster update <cluster_name_or_ID> \
      ...
      --enable-sql-user-management true \
      --enable-sql-database-management true \
      --admin-password "<admin_password>"
   

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

   Learn how to create this file in Creating a cluster.

2. To enable user management via SQL, add the sql_user_management field set to true as well as the admin_password field with the admin password to the cluster description:

   resource "yandex_mdb_clickhouse_cluster" "<cluster_name>" {
     name                = "<cluster_name>"
     ...
     admin_password      = "<admin_password>"
     sql_user_management = true
     ...
   }
   

3. To enable database management via SQL, add the sql_user_management and sql_database_management fields set to true as well as the admin_password field with the admin password to the cluster description:

   resource "yandex_mdb_clickhouse_cluster" "<cluster_name>" {
     name                    = "<cluster_name>"
     ...
     admin_password          = "<admin_password>"
     sql_database_management = true
     sql_user_management     = true
     ...
   }
   

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

5. 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 guide.

resource "yandex_mdb_clickhouse_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 put it in 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-clickhouse/v1/clusters/<cluster_ID>' \
       --data '{
                 "updateMask": "configSpec.adminPassword,configSpec.sqlUserManagement,configSpec.sqlDatabaseManagement",
                 "configSpec": {
                   "adminPassword": "<admin_password>",
                   "sqlUserManagement": <user_management_via_SQL>,
                   "sqlDatabaseManagement": <database_management_via_SQL>
                 }
               }'
   

   Where:

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

     Specify the relevant parameters:

     • configSpec.adminPassword: Password of the admin account used for management.
     • configSpec.sqlUserManagement: To enable user management via SQL.
     • configSpec.sqlDatabaseManagement: To enable database management via SQL.

     In our request example, both user and database management via SQL are enabled.

   • configSpec.adminPassword: admin password.

   • configSpec.sqlUserManagement: User management via SQL, true or false.

   • configSpec.sqlDatabaseManagement: Database management via SQL, true or false. For that, you also need to enable user management via SQL.

   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 put it in 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/clickhouse/v1/cluster_service.proto \
       -rpc-header "Authorization: Bearer $IAM_TOKEN" \
       -d '{
             "cluster_id": "<cluster_ID>",
             "update_mask": {
               "paths": [
                 "config_spec.admin_password",
                 "config_spec.sql_user_management",
                 "config_spec.sql_database_management"
               ]
             },
             "config_spec": {
               "admin_password": "<admin_password>",
               "sql_user_management": <user_management_via_SQL>,
               "sql_database_management": <database_management_via_SQL>
             }
           }' \
       mdb.api.cloud.yandex.net:443 \
       yandex.cloud.mdb.clickhouse.v1.ClusterService.Update
   

   Where:

   • update_mask: List of settings you want to update as an array of strings (paths[]).

     Specify the relevant parameters:

     • config_spec.admin_password: Password of the admin account used for management.
     • config_spec.sql_user_management: To enable user management via SQL.
     • config_spec.sql_database_management: To enable database management via SQL.

     In our request example, both user and database management via SQL are enabled.

   • config_spec.admin_password: admin user password.

   • config_spec.sql_user_management: User management via SQL, true or false.

   • config_spec.sql_database_management: Database management via SQL, true or false. For that, you also need to enable user management via SQL.

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

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

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 change additional cluster settings:

1. View the description of the CLI command for updating a cluster:

   yc managed-clickhouse cluster update --help
   

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

   yc managed-clickhouse cluster update <cluster_name_or_ID> \
      --backup-window-start <backup_start_time> \
      --backup-retain-period-days <automatic_backup_retention_period> \
      --datalens-access=<true_or_false> \
      --metrika-access=<true_or_false> \
      --serverless-access=<true_or_false> \
      --websql-access=<true_or_false> \
      --yandexquery-access=<true_or_false> \
      --deletion-protection \
      --disk-size-autoscaling clickhouse-disk-size-limit=<maximum_storage_size_in_GB>,`
                             `clickhouse-planned-usage-threshold=<threshold_for_scheduled_increase_in_percent>,`
                             `clickhouse-emergency-usage-threshold=<threshold_for_immediate_increase_in_percent>,`
                             `zookeeper-disk-size-limit=<maximum_storage_size_in_GB>,`
                             `zookeeper-planned-usage-threshold=<threshold_for_scheduled_increase_in_percent>,`
                             `zookeeper-emergency-usage-threshold=<threshold_for_immediate_expansion_in_percent> \
      --maintenance-window type=<maintenance_type>,`
                          `day=<day_of_week>,`
                          `hour=<hour>
   

You can update 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: Automatic backup retention period, in days.

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

• --metrika-access: Enables data import from AppMetrica to your cluster. The default value is false.

• --serverless-access: Enables access to the cluster from Yandex Cloud Functions. The default value is false. For details on setting up access, see this Cloud Functions guide.

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

• --yandexquery-access=true: Enables access to the cluster from Yandex Query. This feature is 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.

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

  • clickhouse-disk-size-limit: Maximum ClickHouse® storage size, in GB.

  • clickhouse-planned-usage-threshold: ClickHouse® storage utilization threshold to trigger an increase during the next maintenance window, in percent. The default value is 0 (auto increasing disabled).

    The valid values range from 0 to 100.

  • clickhouse-emergency-usage-threshold: ClickHouse® storage utilization threshold to trigger an immediate increase, in percent. The default value is 0 (auto increasing disabled).

    The valid values range from 0 to 100.

  • zookeeper-disk-size-limit: Maximum ZooKeeper storage size, in GB.

  • zookeeper-planned-usage-threshold: ZooKeeper storage utilization threshold to trigger an increase during the next maintenance window, in percent. The default value is 0 (auto increasing disabled).

    The valid values range from 0 to 100.

  • zookeeper-emergency-usage-threshold: ZooKeeper storage utilization threshold to trigger an immediate increase, in percent. The default value is 0 (auto increasing disabled).

    The valid values range from 0 to 100.

  Warning

  • If you specify both thresholds for ClickHouse®, clickhouse-emergency-usage-threshold must not be less than clickhouse-planned-usage-threshold.

  • If you specify both thresholds for ZooKeeper, zookeeper-emergency-usage-threshold must not be less than zookeeper-planned-usage-threshold.

  • When using clickhouse-planned-usage-threshold and zookeeper-planned-usage-threshold, make sure to set up a maintenance window.

  The automatic storage size increase settings for ClickHouse® apply to all existing shards. If you add a new shard, it will use the settings of the oldest shard. These values are not saved in the ClickHouse® configuration and not displayed in the yc managed-clickhouse cluster get command output.

  To view a specific shard's info, including automatic storage size increase settings, use this command:

  yc managed-clickhouse shards get <shard_name> --cluster-id <cluster_ID>
  

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

  You can get the shard name with the list of shards in the cluster.

• --maintenance-window: Maintenance window settings (including for stopped 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.

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

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

   Learn how to create this file in Creating a cluster.

2. To change the backup start time, add the backup_window_start section to the Managed Service for ClickHouse® cluster description:

   resource "yandex_mdb_clickhouse_cluster" "<cluster_name>" {
     ...
     backup_window_start {
       hours   = <backup_start_hour>
       minutes = <backup_start_minute>
     }
     ...
   }
   

3. To enable cluster access from other services and allow running SQL queries from the management console using Yandex WebSQL, edit the values of the appropriate fields in the access section:

   resource "yandex_mdb_clickhouse_cluster" "<cluster_name>" {
     ...
     access {
       data_lens    = <access_from_DataLens>
       metrika      = <access_from_Metrica_and_AppMetrica>
       serverless   = <access_from_Cloud_Functions>
       web_sql      = <run_SQL_queries_from_management_console>
       yandex_query = <access_from_Yandex_Query>
     }
     ...
   }
   

   Where:

   • data_lens: Access from DataLens, true or false.

   • metrika: Access from Yandex Metrica and AppMetrica, true or false.

   • serverless: Access from Cloud Functions, true or false.

   • yandex_query: Access from Yandex Query, true or false.

   • web_sql: Running SQL queries from the management console, true or false.

4. To set up the maintenance window that will also apply to disabled clusters, add the maintenance_window section to the cluster description:

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

5. 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_clickhouse_cluster" "<cluster_name>" {
     ...
     deletion_protection = <cluster_deletion_protection>
   }
   

   Even with cluster deletion protection enabled, one can still delete a user or database or connect manually and delete the database contents.

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

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

resource "yandex_mdb_clickhouse_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 put it in 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.

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

      {
        "updateMask": "<list_of_settings_to_update>",
        "configSpec": {
          "backupWindowStart": {
            "hours": "<hours>",
            "minutes": "<minutes>",
            "seconds": "<seconds>",
            "nanos": "<nanoseconds>"
          },
          "clickhouse": {
            "diskSizeAutoscaling": {
              "plannedUsageThreshold": "<threshold_for_scheduled_increase_in_percent>",
              "emergencyUsageThreshold": "<threshold_for_immediate_increase_in_percent>",
              "diskSizeLimit": "<maximum_storage_size_in_bytes>"
            }
          },
          "zookeeper": {
            "diskSizeAutoscaling": {
              "plannedUsageThreshold": "<threshold_for_scheduled_increase_in_percent>",
              "emergencyUsageThreshold": "<threshold_for_immediate_increase_in_percent>",
              "diskSizeLimit": "<maximum_storage_size_in_bytes>"
            }
          },
          "access": {
            "dataLens": <access_from_DataLens>,
            "webSql": <run_SQL_queries>,
            "metrika": <import_data_from_AppMetrica>,
            "serverless": <access_from_Yandex Cloud Functions>,
            "dataTransfer": <access_from_Yandex Data Transfer>,
            "yandexQuery": <access_from_Yandex Query>
          }    
        },
        "maintenanceWindow": {
          "anytime": {},
          "weeklyMaintenanceWindow": {
            "day": "<day_of_week>",
            "hour": "<hour_UTC>"
          }
        },
        "deletionProtection": <cluster_deletion_protection>
      }
      

      Where:

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

      • configSpec.backupWindowStart: Backup start time (UTC):

        • hours: Hours in 24-hour format
        • minutes: Minutes
        • seconds: Seconds
        • nanos: Nanoseconds

      • configSpec.access: Settings enabling access to the cluster from other services and SQL queries from the management console using Yandex WebSQL:

        • dataLens: Enable access from DataLens, true or false. The default value is false. For more information about setting up a connection, see Connecting from DataLens.

        • webSql: Enable SQL queries against cluster databases from the Yandex Cloud management console using Yandex WebSQL, true or false. The default value is false.

        • metrika: Enable data import from AppMetrica to your cluster, true or false. The default value is false.

        • serverless: Enable access to the cluster from Yandex Cloud Functions, true or false. The default value is false. For more information about setting up access, see this Cloud Functions guide.

        • dataTransfer: Enable access to the cluster from Yandex Data Transfer in Serverless mode, true or false. The default value is false.

          This will enable you to connect to Yandex Data Transfer running in Kubernetes via a special network to make other operations, e.g., transfer launch and deactivation, run faster.

        • yandexQuery: Enable access to the cluster from Yandex Query, true or false. This feature is at the Preview stage. The default value is false.

      • configSpec.clickhouse.diskSizeAutoscaling: Automatic storage size increase settings for ClickHouse®:

        • plannedUsageThreshold: ClickHouse® storage utilization threshold to trigger an increase during the next maintenance window, in percent. The default value is 0 (auto increasing disabled).

          The valid values range from 0 to 100.

        • emergencyUsageThreshold: ClickHouse® storage utilization threshold to trigger an immediate increase, in percent. The default value is 0 (auto increasing disabled).

          The valid values range from 0 to 100.

        • diskSizeLimit: Maximum ClickHouse® storage size, in bytes.

        Warning

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

        • When using plannedUsageThreshold, make sure to set up a maintenance window.

        The automatic storage size increase settings for ClickHouse® apply to all existing shards. If you add a new shard, it will use the settings of the oldest shard. These values are not saved in the ClickHouse® configuration.

        To view information about a specific shard, including automatic storage size increase settings, use the Cluster.GetShard method and provide the cluster ID and shard name in the request.

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

        You can get the shard name with the list of shards in the cluster.

      • configSpec.zookeeper.diskSizeAutoscaling: Automatic storage size increase settings for ZooKeeper:

        • plannedUsageThreshold: Utilization threshold for the ZooKeeper storage capacity, in percent, to trigger an increase during the next maintenance window. The default value is 0 (auto increase disabled).

          The valid values range from 0 to 100.

        • emergencyUsageThreshold: Utilization threshold for the ZooKeeper storage capacity, in percent, to trigger an immediate increase. The default value is 0 (auto increase disabled).

          The valid values range from 0 to 100.

        • diskSizeLimit: Maximum ZooKeeper storage size, in bytes.

        Warning

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

        • When using plannedUsageThreshold, make sure to set up a maintenance window.

      • maintenanceWindow: Maintenance window settings, including those for stopped clusters. Select one of these options:

        • anytime: At any time (default).
        • weeklyMaintenanceWindow: On schedule:
          • day: Day of week in DDD format: MON, TUE, WED, THU, FRI, SAT, or SUN.
          • hour: Time of day (UTC) in HH format, from 1 to 24.

      • deletionProtection: Cluster protection from accidental deletion, true or false. The default value is false.

        Even with cluster deletion protection enabled, one can still delete a user or database or connect manually and delete the database contents.

   2. Run this request:

      curl \
        --request PATCH \
        --header "Authorization: Bearer $IAM_TOKEN" \
        --header "Content-Type: application/json" \
        --url 'https://mdb.api.cloud.yandex.net/managed-clickhouse/v1/clusters/<cluster_ID>' \
        --data '@body.json'
      

      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 put it in 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>"
       ]
   }
   

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

      {
        "cluster_id": "<cluster_ID>",
        "update_mask": {
          "paths": [
            <list_of_settings_to_update>
          ]
        },
        "config_spec": {
          "backup_window_start": {
            "hours": "<hours>",
            "minutes": "<minutes>",
            "seconds": "<seconds>",
            "nanos": "<nanoseconds>"
          },
          "clickhouse": {
            "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>"
            }
          },
          "zookeeper": {
            "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>"
            }
          },
          "access": {
            "data_lens": <access_from_DataLens>,
            "web_sql": <run_SQL_queries>,
            "metrika": <import_data_from_AppMetrica>,
            "serverless": <access_from_Yandex Cloud Functions>,
            "data_transfer": <access_from_Yandex Data Transfer>,
            "yandex_query": <access_from_Yandex Query>
          }
        },
        "maintenance_window": {
          "anytime": {},
          "weekly_maintenance_window": {
            "day": "<day_of_week>",
            "hour": "<hour_UTC>"
          }
        },
        "deletion_protection": <cluster_deletion_protection>
      }
      

      Where:

      • update_mask: List of settings you want to update as an array of strings (paths[]).

      • config_spec.backup_window_start: Backup start time (UTC):

        • hours: Hours in 24-hour format
        • minutes: Minutes
        • seconds: Seconds
        • nanos: Nanoseconds

      • config_spec.access: Settings enabling access to the cluster from other services and SQL queries from the management console using Yandex WebSQL:

        • data_lens: Enable access from DataLens, true or false. The default value is false. For more information about setting up a connection, see Connecting from DataLens.

        • web_sql: Enable SQL queries against cluster databases from the Yandex Cloud management console using Yandex WebSQL, true or false. The default value is false.

        • metrika: Enable data import from AppMetrica to your cluster, true or false. The default value is false.

        • serverless: Enable access to the cluster from Yandex Cloud Functions, true or false. The default value is false. For more information about setting up access, see this Cloud Functions guide.

        • data_transfer: Enable access to the cluster from Yandex Data Transfer in Serverless mode, true or false. The default value is false.

          This will enable you to connect to Yandex Data Transfer running in Kubernetes via a special network to make other operations, e.g., transfer launch and deactivation, run faster.

        • yandex_query: Enable access to the cluster from Yandex Query, true or false. This feature is at the Preview stage. The default value is false.

      • config_spec.clickhouse.disk_size_autoscaling: Automatic storage size increase settings for ClickHouse®:

        • planned_usage_threshold: Utilization threshold for the ClickHouse® storage capacity, in percent, to trigger an expansion during the next maintenance window. The default value is 0 (auto increasing disabled).

          The valid values range from 0 to 100.

        • emergency_usage_threshold: Utilization threshold for the ClickHouse® storage capacity, in percent, to trigger an immediate expansion. The default value is 0 (auto increasing disabled).

          The valid values range from 0 to 100.

        • disk_size_limit: Maximum ClickHouse® storage size, in bytes.

        Warning

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

        • When using planned_usage_threshold, make sure to set up a maintenance window.

        The automatic storage size increase settings for ClickHouse® apply to all existing shards. If you add a new shard, it will use the settings of the oldest shard. These values are not saved in the ClickHouse® configuration.

        To view information about a specific shard, including automatic storage expansion settings, use the ClusterService.GetShard method and provide the cluster ID and shard name in the request.

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

        You can get the shard name with the list of shards in the cluster.

      • config_spec.zookeeper.disk_size_autoscaling: Automatic storage size increase settings for ZooKeeper:

        • planned_usage_threshold: Utilization threshold for the ZooKeeper storage capacity, in percent, to trigger an increase during the next maintenance window. The default value is 0 (auto increase disabled).

          The valid values range from 0 to 100.

        • emergency_usage_threshold: Utilization threshold for the ZooKeeper storage capacity, in percent, to trigger an immediate increase. The default value is 0 (auto increase disabled).

          The valid values range from 0 to 100.

        • disk_size_limit: Maximum ZooKeeper storage size, in bytes.

        Warning

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

        • When using planned_usage_threshold, make sure to set up a maintenance window.

      • maintenance_window: Maintenance window settings, including those for stopped clusters. Select one of these options:

        • anytime: At any time (default).
        • weekly_maintenance_window: On schedule:
          • day: Day of week in DDD format: MON, TUE, WED, THU, FRI, SAT, or SUN.
          • hour: Time of day (UTC) in HH format, from 1 to 24.

      • deletion_protection: Cluster protection from accidental deletion, true or false. The default value is false.

        Even with cluster deletion protection enabled, one can still delete a user or database or connect manually and delete the database contents.

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

   2. Run this request:

      grpcurl \
        -format json \
        -import-path ~/cloudapi/ \
        -import-path ~/cloudapi/third_party/googleapis/ \
        -proto ~/cloudapi/yandex/cloud/mdb/clickhouse/v1/cluster_service.proto \
        -rpc-header "Authorization: Bearer $IAM_TOKEN" \
        -d @ \
        mdb.api.cloud.yandex.net:443 \
        yandex.cloud.mdb.clickhouse.v1.ClusterService.Update \
        < body.json
      

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

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 move a cluster:

1. View the description of the CLI command for moving a cluster:

   yc managed-clickhouse cluster move --help
   

2. Specify the destination folder in the command for moving a cluster:

   yc managed-clickhouse cluster move <cluster_name_or_ID> \
      --destination-folder-name=<destination_folder_name>
   

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

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

   Learn how to create this file in Creating a cluster.

2. In the Managed Service for ClickHouse® cluster description, edit the folder_id value. If the argument does not exist, add it:

   resource "yandex_mdb_clickhouse_cluster" "<cluster_name>" {
     ...
     folder_id = "<destination_folder_ID>"
   }
   

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

resource "yandex_mdb_clickhouse_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 put it in an environment variable:

   export IAM_TOKEN="<IAM_token>"
   

2. Call the Cluster.Move 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-clickhouse/v1/clusters/<cluster_ID>:move' \
       --data '{
                 "destinationFolderId": "<destination_folder_ID>"
               }'
   

   Where destinationFolderId is the ID of the destination folder to move your cluster to. You can get this ID with the list of folders in the cloud.

   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 put it in 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.Move method, e.g., via the following gRPCurl request:

   grpcurl \
       -format json \
       -import-path ~/cloudapi/ \
       -import-path ~/cloudapi/third_party/googleapis/ \
       -proto ~/cloudapi/yandex/cloud/mdb/clickhouse/v1/cluster_service.proto \
       -rpc-header "Authorization: Bearer $IAM_TOKEN" \
       -d '{
             "cluster_id": "<cluster_ID>",
             "destination_folder_id": "<destination_folder_ID>"
           }' \
       mdb.api.cloud.yandex.net:443 \
       yandex.cloud.mdb.clickhouse.v1.ClusterService.Move
   

   Where destination_folder_id is the ID of the destination folder to move your cluster to. You can get this ID with the list of folders in the cloud.

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

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

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 edit the list of security groups for your cluster:

1. View the description of the CLI command for updating a cluster:

   yc managed-clickhouse cluster update --help
   

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

   yc managed-clickhouse cluster update <cluster_name> \
      --security-group-ids <list_of_security_group_IDs>
   

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

   Learn how to create this file in Creating a cluster.

2. Edit the security_group_ids value in the cluster description:

   resource "yandex_mdb_clickhouse_cluster" "<cluster_name>" {
     ...
     security_group_ids = [ <list_of_cluster_security_group_IDs> ]
   }
   

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

resource "yandex_mdb_clickhouse_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 put it in 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-clickhouse/v1/clusters/<cluster_ID>' \
       --data '{
                 "updateMask": "securityGroupIds",
                 "securityGroupIds": [
                   <list_of_security_group_IDs>
                 ]
               }'
   

   Where:

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

     Here, we only specified a single setting, securityGroupIds.

   • securityGroupIds: Array of strings. Each string is a security group ID.

     Warning

     The list of security groups assigned to the cluster will be completely overwritten by the list provided in the securityGroupIds parameter.

     Before running your request, make sure the list includes all the required security group IDs, including existing ones.

   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 put it in 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/clickhouse/v1/cluster_service.proto \
       -rpc-header "Authorization: Bearer $IAM_TOKEN" \
       -d '{
             "cluster_id": "<cluster_ID>",
             "update_mask": {
               "paths": [
                 "security_group_ids"
               ]
             },
             "security_group_ids": [
               <list_of_security_group_IDs>
             ]
           }' \
       mdb.api.cloud.yandex.net:443 \
       yandex.cloud.mdb.clickhouse.v1.ClusterService.Update
   

   Where:

   • update_mask: List of settings you want to update as an array of strings (paths[]).

     Here, we only specified a single setting, security_group_ids.

   • security_group_ids: Array of strings. Each string is a security group ID.

     Warning

     The list of security groups assigned to the cluster will be completely overwritten by the list provided in the security_group_ids parameter.

     Before running your request, make sure the list includes all the required security group IDs, including existing ones.

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

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

1. Get an IAM token for API authentication and put it in 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-clickhouse/v1/clusters/<cluster_ID>' \
       --data '{
                 "updateMask": "<list_of_settings_to_update>",
                 "configSpec": {
                   "cloudStorage": {
                     "enabled": <hybrid_storage_use>,
                     "moveFactor": "<share_of_free_space>",
                     "dataCacheEnabled": <temporary_file_storage>,
                     "dataCacheMaxSize": "<maximum_memory_for_file_storage>",
                     "preferNotToMerge": <disabling_data_part_merging>
                   }
                 }
               }'
   

   Where:

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

   • configSpec.cloudStorage: Hybrid storage settings:

     • enabled: Enable hybrid storage in the cluster if it is disabled, true or false. The default value is false (disabled).

       Note

       Once hybrid storage is enabled, you cannot disable it.

     • moveFactor: Minimum percentage of free space in the cluster storage. If your free space percentage is below this value, the data will be moved to Yandex Object Storage.

       The minimum value is 0, the maximum value is 1, and the default value is 0.01.

     • dataCacheEnabled: Enable caching files in the cluster storage, true or false.

       The default value is true (enabled).

     • dataCacheMaxSize: Maximum cache size, in bytes, allocated in the cluster storage.

       The default value is 1073741824 (1 GB).

     • preferNotToMerge: Disable merging of data parts in the cluster and object storage, true or false.

       To disable merging, set to true. To leave merging enabled, set to false.

   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 put it in 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/clickhouse/v1/cluster_service.proto \
       -rpc-header "Authorization: Bearer $IAM_TOKEN" \
       -d '{
             "cluster_id": "<cluster_ID>",
             "update_mask": {
               "paths": [
                 <list_of_settings_to_update>
               ]
             },
             "config_spec": {
               "cloud_storage": {
                 "enabled": <hybrid_storage_use>,
                 "move_factor": "<share_of_free_space>",
                 "data_cache_enabled": <temporary_file_storage>,
                 "data_cache_max_size": "<maximum_memory_for_file_storage>",
                 "prefer_not_to_merge": <disabling_data_part_merging>
               }
             }
           }' \
       mdb.api.cloud.yandex.net:443 \
       yandex.cloud.mdb.clickhouse.v1.ClusterService.Update
   

   Where:

   • update_mask: List of settings you want to update as an array of strings (paths[]).

   • config_spec.cloud_storage: Hybrid storage settings:

     • enabled: Enable hybrid storage in the cluster if it is disabled, true or false. The default value is false (disabled).

       Note

       Once hybrid storage is enabled, you cannot disable it.

     • move_factor: Minimum percentage of free space in the cluster storage. If your free space percentage is below this value, the data will be moved to Yandex Object Storage.

       The minimum value is 0, the maximum value is 1, and the default value is 0.01.

     • data_cache_enabled: Enable caching files in the cluster storage, true or false.

       The default value is true (enabled).

     • data_cache_max_size: Maximum cache size, in bytes, allocated in the cluster storage.

       The default value is 1073741824 (1 GB).

     • prefer_not_to_merge: Disable merging of data parts in the cluster and object storage, true or false.

       To disable merging, set to true. To leave merging enabled, set to false.

   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.