Managing shard groups in a ClickHouse® cluster

If you do not have the Yandex Cloud CLI yet, install and initialize it.

The folder used by default is the one specified when creating the CLI profile. To change the default folder, use the yc config set folder-id <folder_ID> command. You can also specify a different folder for any command using --folder-name or --folder-id.

If you access a resource by its name, the search will be limited to the default folder. If you access a resource by its ID, the search will be global, i.e., through all folders based on access permissions.

To get a list of shard groups in a cluster, run this command:

yc managed-clickhouse shard-groups list \
   --cluster-name=<cluster_name>

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

1. Get an IAM token for API authentication and put it into an environment variable:

   export IAM_TOKEN="<IAM_token>"
   

2. Call the Cluster.ListShardGroups 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/clusters/<cluster_ID>/shardGroups'
   

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

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

1. Get an IAM token for API authentication and put it into 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 that the repository contents reside in the ~/cloudapi/ directory.

3. Call the ClusterService.ListShardGroups 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>"
         }' \
     mdb.api.cloud.yandex.net:443 \
     yandex.cloud.mdb.clickhouse.v1.ClusterService.ListShardGroups
   

   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 yet, install and initialize it.

The folder used by default is the one specified when creating the CLI profile. To change the default folder, use the yc config set folder-id <folder_ID> command. You can also specify a different folder for any command using --folder-name or --folder-id.

If you access a resource by its name, the search will be limited to the default folder. If you access a resource by its ID, the search will be global, i.e., through all folders based on access permissions.

To view detailed information about a shard group in a cluster, run this command:

yc managed-clickhouse shard-groups get \
  --cluster-name=<cluster_name> \
  --name=<shard_group_name>

You can get the cluster name from the list of clusters in your folder.

1. Get an IAM token for API authentication and put it into an environment variable:

   export IAM_TOKEN="<IAM_token>"
   

2. Call the Cluster.GetShardGroup 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/clusters/<cluster_ID>/shardGroups/<shard_group_name>'
   

   You can get the cluster ID with the list of clusters in the folder, and the shard group name, with the list of groups in the cluster.

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

1. Get an IAM token for API authentication and put it into 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 that the repository contents reside in the ~/cloudapi/ directory.

3. Call the ClusterService.GetShardGroup 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>",
           "shard_group_name": "<shard_group_name>"
         }' \
     mdb.api.cloud.yandex.net:443 \
     yandex.cloud.mdb.clickhouse.v1.ClusterService.GetShardGroup
   

   You can get the cluster ID with the list of clusters in the folder, and the shard group name, with the list of groups in the cluster.

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

If you do not have the Yandex Cloud CLI yet, install and initialize it.

The folder used by default is the one specified when creating the CLI profile. To change the default folder, use the yc config set folder-id <folder_ID> command. You can also specify a different folder for any command using --folder-name or --folder-id.

If you access a resource by its name, the search will be limited to the default folder. If you access a resource by its ID, the search will be global, i.e., through all folders based on access permissions.

To create a shard group in a cluster, run this command:

yc managed-clickhouse shard-groups create \
  --cluster-name=<cluster_name> \
  --name=<shard_group_name> \
  --description="<shard_group_description>" \
  --shards=<list_of_shard_names> \
  --external-shard name=<shard_name>,`
                  `weight=<shard_weight> \
  --external-shard-replica shard=<shard_name>,`
                          `host=<host_FQDN_or_IP_address>,`
                          `port=<port>,`
                          `secure=<use_SSL_connection>,`
                          `user=<username>,`
                          `password=<password>,`
                          `priority=<host_priority>

Where:

• --cluster-name: Cluster name you can request with the list of clusters in the folder.

• --name: Shard group name.

  A name may include Latin letters, numbers, hyphens, and underscores. It must be from 1 to 63 characters long.

• --description: Shard group description.

• --shards: List of cluster shard names.

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

• --external-shard: External shard settings. This parameter is specified separately for each external shard and has the following structure:

  • name: Shard name.

    A name may include Latin letters, numbers, hyphens, and underscores. It must be from 1 to 63 characters long.

  • --weight: Shard weight within a group.

    By default, each external shard is assigned a weight of 100. If some shards (either external or the cluster's own) in the group have weights different from 100, the data within the shard group will be distributed between the shards according to their weights.

    To calculate the shard's priority for data distribution within the group, the weight of each shard should be divided by the total weight of all shards in the group. For example, if an external shard has a weight of 100 and a cluster shard has a weight of 300, then the first shard's priority is 1/4, and the second shard's priority is 3/4. The higher the priority, the more data the shard will get.

    For more information, see this ClickHouse® guide.

• --external-shard-replica: External shard replica settings. This parameter is specified separately for each replica and has the following structure:

  • shard: Name of the external shard the replica belongs to.

  • host: Host FQDN or IP address.

    Learn how to get a host FQDN in this guide.

  • port: Port for connecting to ClickHouse®.

  • secure: Use an encrypted SSL/TLS connection when connecting to a host: true or false.

  • user, password: Username and password for access to the ClickHouse® database.

  • priority: Host priority for balancing shard connections. The default value is 0. A lower value assigns a higher priority when selecting a host for shard connections.

1. Open the current Terraform configuration file with the infrastructure plan.

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

2. Add the shard_group section to the Managed Service for ClickHouse® cluster description.

   resource "yandex_mdb_clickhouse_cluster_v2" "<cluster_name>" {
     ...
     shard_group {
       name        = "<shard_group_name>"
       description = "<shard_group_description>"
       shard_names = [
         "<shard_1_name>",
         ...
         "<shard_N_name>"
       ]
   
       external_shard {
         name   = "<shard_name>"
         weight = <shard_weight>
   
         replica {
           host     = "<host_FQDN_or_IP_address>"
           port     = <port>
           secure   = <use_SSL_connection>
           user     = "<username>"
           password = "<password>"
           priority = <host_priority>
         }
       }
     }
   }
   

   Where:

   • name: Shard group name.

     A name may include Latin letters, numbers, hyphens, and underscores. It must be from 1 to 63 characters long.

   • description: Shard group description.

   • shard_names: List of cluster shard names.

   • external_shard: External shard settings. This section is specified separately for each external shard and includes the following parameters:

     • name: Shard name.

       A name may include Latin letters, numbers, hyphens, and underscores. It must be from 1 to 63 characters long.

     • --weight: Shard weight within a group.

       By default, each external shard is assigned a weight of 100. If some shards (either external or the cluster's own) in the group have weights different from 100, the data within the shard group will be distributed between the shards according to their weights.

       To calculate the shard's priority for data distribution within the group, the weight of each shard should be divided by the total weight of all shards in the group. For example, if an external shard has a weight of 100 and a cluster shard has a weight of 300, then the first shard's priority is 1/4, and the second shard's priority is 3/4. The higher the priority, the more data the shard will get.

       For more information, see this ClickHouse® guide.

     • replica: External shard replica settings. This section is specified separately for each replica and includes the following parameters:

       • host: Host FQDN or IP address.

         Learn how to get a host FQDN in this guide.

       • port: Port for connecting to ClickHouse®.

       • secure: Use an encrypted SSL/TLS connection when connecting to a host: true or false.

       • user, password: Username and password for access to the ClickHouse® database.

       • priority: Host priority for balancing shard connections. The default value is 0. A lower value assigns a higher priority when selecting a host for shard connections.

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 resource changes.

   1. Run this command to view the intended 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_v2" "<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 into an environment variable:

   export IAM_TOKEN="<IAM_token>"
   

2. Call the Cluster.CreateShardGroup 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>/shardGroups' \
     --data '{
               "shardGroupName": "<shard_group_name>",
               "description": "<shard_group_description>",
               "shardNames": [
                 "<shard_1>", "<shard_2>", ... "<shard_N>"
               ],
               "externalShards" [
                 {
                   "name": "<external_shard_1>",
                   "weight": <shard_weight_when_writing_data>,
                   "replicas": [
                     {
                       "host": "<host_FQDN>",
                       "port": "<port>",
                       "secure": <use_SSL_connection>,
                       "user": "<username>",
                       "password": "<password>",
                       "priority": <host_priority>
                     },
                     {
                       <host_2_parameters>
                     },
                     ...
                     {
                       <host_N_parameters>
                     }
                   ]
                 },
                 {
                   <external_shard_2_parameters>
                 },
                 ...
                 {
                   <external_shard_N_parameters>
                 }
               ]
             }'
   

   Where:

   • shardGroupName: Shard group name.

     A name may include Latin letters, numbers, hyphens, and underscores. It must be from 1 to 63 characters long.

   • description: Shard group description.

   • shardNames: List of shards to include in the new group.

   • externalShards: List of external shards to include in the new group. An external shard is a shard from another Managed Service for ClickHouse® cluster or a custom ClickHouse® installation. one per shard. Each element has the following structure:

     • name: Shard name.

       A name may include Latin letters, numbers, hyphens, and underscores. It must be from 1 to 63 characters long.

     • --weight: Shard weight within a group.

       By default, each external shard is assigned a weight of 100. If some shards (either external or the cluster's own) in the group have weights different from 100, the data within the shard group will be distributed between the shards according to their weights.

       To calculate the shard's priority for data distribution within the group, the weight of each shard should be divided by the total weight of all shards in the group. For example, if an external shard has a weight of 100 and a cluster shard has a weight of 300, then the first shard's priority is 1/4, and the second shard's priority is 3/4. The higher the priority, the more data the shard will get.

       For more information, see this ClickHouse® guide.

     • replicas: Shard host settings:

       • host: Host FQDN or IP address.

         Learn how to get a host FQDN in this guide.

       • port: Port for connecting to ClickHouse®.

       • secure: Use an encrypted SSL/TLS connection when connecting to a host: true or false.

       • user, password: Username and password for access to the ClickHouse® database.

       • priority: Host priority for balancing shard connections. The default value is 0. A lower value assigns a higher priority when selecting a host for shard connections.

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

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

1. Get an IAM token for API authentication and put it into 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 that the repository contents reside in the ~/cloudapi/ directory.

3. Call the ClusterService.CreateShardGroup 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>",
             "shard_group_name": "<shard_group_name>",
             "description": "<shard_group_description>",
             "shard_names": [
               "<shard_1>", "<shard_2>", ... "<shard_N>"
             ],
             "external_shards" [
               {
                 "name": "<external_shard_1>",
                 "weight": <shard_weight_when_writing_data>,
                 "replicas": [
                   {
                     "host": "<host_FQDN>",
                     "port": <port>,
                     "secure": <use_SSL_connection>,
                     "user": "<username>",
                     "password": "<password>",
                     "priority": <host_priority>
                   },
                   {
                     <host_2_parameters>
                   },
                   ...
                   {
                     <host_N_parameters>
                   }
                 ]
               },
               {
                 <external_shard_2_parameters>
               },
               ...
               {
                 <external_shard_N_parameters>
               }
             ]
           }' \
       mdb.api.cloud.yandex.net:443 \
       yandex.cloud.mdb.clickhouse.v1.ClusterService.CreateShardGroup
   

   Where:

   • shard_group_name: Shard group name.

     A name may include Latin letters, numbers, hyphens, and underscores. It must be from 1 to 63 characters long.

   • description: Shard group description.

   • shard_names: List of shards to include in the new group.

   • external_shards: List of external shards to include in the new group. An external shard is a shard from another Managed Service for ClickHouse® cluster or a custom ClickHouse® installation. one per shard. Each element has the following structure:

     • name: Shard name.

       A name may include Latin letters, numbers, hyphens, and underscores. It must be from 1 to 63 characters long.

     • --weight: Shard weight within a group.

       By default, each external shard is assigned a weight of 100. If some shards (either external or the cluster's own) in the group have weights different from 100, the data within the shard group will be distributed between the shards according to their weights.

       To calculate the shard's priority for data distribution within the group, the weight of each shard should be divided by the total weight of all shards in the group. For example, if an external shard has a weight of 100 and a cluster shard has a weight of 300, then the first shard's priority is 1/4, and the second shard's priority is 3/4. The higher the priority, the more data the shard will get.

       For more information, see this ClickHouse® guide.

     • replicas: Shard host settings:

       • host: Host FQDN or IP address.

         Learn how to get a host FQDN in this guide.

       • port: Port for connecting to ClickHouse®.

       • secure: Use an encrypted SSL/TLS connection when connecting to a host: true or false.

       • user, password: Username and password for access to the ClickHouse® database.

       • priority: Host priority for balancing shard connections. The default value is 0. A lower value assigns a higher priority when selecting a host for shard connections.

   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 yet, install and initialize it.

The folder used by default is the one specified when creating the CLI profile. To change the default folder, use the yc config set folder-id <folder_ID> command. You can also specify a different folder for any command using --folder-name or --folder-id.

If you access a resource by its name, the search will be limited to the default folder. If you access a resource by its ID, the search will be global, i.e., through all folders based on access permissions.

To update a shard group in a cluster, run this command:

yc managed-clickhouse shard-groups update \
  --cluster-name=<cluster_name> \
  --name=<shard_group_name> \
  --description="<new_description_for_shard_group>" \
  --shards=<new_list_of_shard_names> \
  --external-shard name=<shard_name>,`
                  `weight=<shard_weight> \
  --external-shard-replica shard=<shard_name>,`
                          `host=<host_FQDN_or_IP_address>,`
                          `port=<port>,`
                          `secure=<use_SSL_connection>,`
                          `user=<username>,`
                          `password=<password>,`
                          `priority=<host_priority>

Where:

• --cluster-name: Cluster name you can request with the list of clusters in the folder.

• --name: Name of the edited shard group, which you can get with the list of shard groups in the cluster.

• --description: New description for the shard group.

• --shards: New list of cluster shard names. The new list will override the current one, so make sure it includes all the required shards.

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

• --external-shard: External shard settings. This parameter is specified separately for each external shard and has the following structure:

  • name: Shard name.

    A name may include Latin letters, numbers, hyphens, and underscores. It must be from 1 to 63 characters long.

  • --weight: Shard weight within a group.

    By default, each external shard is assigned a weight of 100. If some shards (either external or the cluster's own) in the group have weights different from 100, the data within the shard group will be distributed between the shards according to their weights.

    To calculate the shard's priority for data distribution within the group, the weight of each shard should be divided by the total weight of all shards in the group. For example, if an external shard has a weight of 100 and a cluster shard has a weight of 300, then the first shard's priority is 1/4, and the second shard's priority is 3/4. The higher the priority, the more data the shard will get.

    For more information, see this ClickHouse® guide.

  Warning

  When using --external-shard, the new external shard settings will override the current ones.

• --external-shard-replica: External shard replica settings. This parameter is specified separately for each replica and has the following structure:

  • shard: Name of the external shard the replica belongs to.

  • host: Host FQDN or IP address.

    Learn how to get a host FQDN in this guide.

  • port: Port for connecting to ClickHouse®.

  • secure: Use an encrypted SSL/TLS connection when connecting to a host: true or false.

  • user, password: Username and password for access to the ClickHouse® database.

  • priority: Host priority for balancing shard connections. The default value is 0. A lower value assigns a higher priority when selecting a host for shard connections.

1. Open the current Terraform configuration file with the infrastructure plan.

   For more on how to create this file, see Creating a cluster.

2. In the Managed Service for ClickHouse® cluster description, update the shard_group section for the shard group you need:

   resource "yandex_mdb_clickhouse_cluster_v2" "<cluster_name>" {
     ...
     shard_group {
       name        = "<shard_group_name>"
       description = "<shard_group_description>"
       shard_names = [
         "<shard_1_name>",
         ...
         "<shard_N_name>"
       ]
   
       external_shard {
         name   = "<shard_name>"
         weight = <shard_weight>
   
         replica {
           host     = "<host_FQDN_or_IP_address>"
           port     = <port>
           secure   = <use_SSL_connection>
           user     = "<username>"
           password = "<password>"
           priority = <host_priority>
         }
       }
     }
   }
   

   Where:

   • name: Shard group name.

     A name may include Latin letters, numbers, hyphens, and underscores. It must be from 1 to 63 characters long.

   • description: Shard group description.

   • shard_names: List of cluster shard names.

   • external_shard: External shard settings. This section is specified separately for each external shard and includes the following parameters:

     • name: Shard name.

       A name may include Latin letters, numbers, hyphens, and underscores. It must be from 1 to 63 characters long.

     • --weight: Shard weight within a group.

       By default, each external shard is assigned a weight of 100. If some shards (either external or the cluster's own) in the group have weights different from 100, the data within the shard group will be distributed between the shards according to their weights.

       To calculate the shard's priority for data distribution within the group, the weight of each shard should be divided by the total weight of all shards in the group. For example, if an external shard has a weight of 100 and a cluster shard has a weight of 300, then the first shard's priority is 1/4, and the second shard's priority is 3/4. The higher the priority, the more data the shard will get.

       For more information, see this ClickHouse® guide.

     • replica: External shard replica settings. This section is specified separately for each replica and includes the following parameters:

       • host: Host FQDN or IP address.

         Learn how to get a host FQDN in this guide.

       • port: Port for connecting to ClickHouse®.

       • secure: Use an encrypted SSL/TLS connection when connecting to a host: true or false.

       • user, password: Username and password for access to the ClickHouse® database.

       • priority: Host priority for balancing shard connections. The default value is 0. A lower value assigns a higher priority when selecting a host for shard connections.

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 resource changes.

   1. Run this command to view the intended 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_v2" "<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 into an environment variable:

   export IAM_TOKEN="<IAM_token>"
   

2. Call the Cluster.updateShardGroup 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>/shardGroups/<shard_group_name>' \
     --data '{
               "updateMask": "description,shardNames,externalShards",
               "description": "<shard_group_description>",
               "shardNames": [
                 "<shard_1>", "<shard_2>", ... "<shard_N>"
               ],
               "externalShards" [
                 {
                   "name": "<external_shard_1>",
                   "weight": <shard_weight_when_writing_data>,
                   "replicas": [
                     {
                       "host": "<host_FQDN>",
                       "port": "<port>",
                       "secure": <use_SSL_connection>,
                       "user": "<username>",
                       "password": "<password>",
                       "priority": <host_priority>
                     },
                     {
                       <host_2_parameters>
                     },
                     ...
                     {
                       <host_N_parameters>
                     }
                   ]
                 },
                 {
                   <external_shard_2_parameters>
                 },
                 ...
                 {
                   <external_shard_N_parameters>
                 }
               ]
             }'
   

   Where:

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

   • description: New description for the shard group.

   • shardNames: New list of cluster shards to include in the group. To learn shard names, get the list of shards in the cluster. This list will replace the current one, so make sure you have added all the required shards to the new list.

   • externalShards: List of external shards with updated settings to include in the group. An external shard is a shard from another Managed Service for ClickHouse® cluster or a custom ClickHouse® installation. one per shard. Each element has the following structure:

     • name: Shard name.

       A name may include Latin letters, numbers, hyphens, and underscores. It must be from 1 to 63 characters long.

     • --weight: Shard weight within a group.

       By default, each external shard is assigned a weight of 100. If some shards (either external or the cluster's own) in the group have weights different from 100, the data within the shard group will be distributed between the shards according to their weights.

       To calculate the shard's priority for data distribution within the group, the weight of each shard should be divided by the total weight of all shards in the group. For example, if an external shard has a weight of 100 and a cluster shard has a weight of 300, then the first shard's priority is 1/4, and the second shard's priority is 3/4. The higher the priority, the more data the shard will get.

       For more information, see this ClickHouse® guide.

     • replicas: Shard host settings:

       • host: Host FQDN or IP address.

         Learn how to get a host FQDN in this guide.

       • port: Port for connecting to ClickHouse®.

       • secure: Use an encrypted SSL/TLS connection when connecting to a host: true or false.

       • user, password: Username and password for access to the ClickHouse® database.

       • priority: Host priority for balancing shard connections. The default value is 0. A lower value assigns a higher priority when selecting a host for shard connections.

   You can get the cluster ID with the list of clusters in the folder, and the shard group name, with the list of groups in the cluster.

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

1. Get an IAM token for API authentication and put it into 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 that the repository contents reside in the ~/cloudapi/ directory.

3. Call the ClusterService.UpdateShardGroup 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>",
           "shard_group_name": "<shard_group_name>",
           "update_mask": {
             "paths": [
               "description", "shard_names", "external_shards"
             ]
           },
           "description": "<shard_group_description>",
           "shard_names": [
             "<shard_1>", "<shard_2>", ... "<shard_N>"
           ],
           "external_shards" [
             {
               "name": "<external_shard_1>",
               "weight": <shard_weight_when_writing_data>,
               "replicas": [
                 {
                   "host": "<host_FQDN>",
                   "port": <port>,
                   "secure": <use_SSL_connection>,
                   "user": "<username>",
                   "password": "<password>",
                   "priority": <host_priority>
                 },
                 {
                   <host_2_parameters>
                 },
                 ...
                 {
                   <host_N_parameters>
                 }
               ]
             },
             {
               <external_shard_2_parameters>
             },
             ...
             {
               <external_shard_N_parameters>
             }
           ]
         }' \
     mdb.api.cloud.yandex.net:443 \
     yandex.cloud.mdb.clickhouse.v1.ClusterService.UpdateShardGroup
   

   Where:

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

   • description: New description for the shard group.

   • shard_names: New list of cluster shards to include in the group. To learn shard names, get the list of shards in the cluster. This list will replace the current one, so make sure you have added all the required shards to the new list.

   • external_shards: List of external shards with updated settings to include in the group. An external shard is a shard from another Managed Service for ClickHouse® cluster or a custom ClickHouse® installation. one per shard. Each element has the following structure:

     • name: Shard name.

       A name may include Latin letters, numbers, hyphens, and underscores. It must be from 1 to 63 characters long.

     • --weight: Shard weight within a group.

       By default, each external shard is assigned a weight of 100. If some shards (either external or the cluster's own) in the group have weights different from 100, the data within the shard group will be distributed between the shards according to their weights.

       To calculate the shard's priority for data distribution within the group, the weight of each shard should be divided by the total weight of all shards in the group. For example, if an external shard has a weight of 100 and a cluster shard has a weight of 300, then the first shard's priority is 1/4, and the second shard's priority is 3/4. The higher the priority, the more data the shard will get.

       For more information, see this ClickHouse® guide.

     • replicas: Shard host settings:

       • host: Host FQDN or IP address.

         Learn how to get a host FQDN in this guide.

       • port: Port for connecting to ClickHouse®.

       • secure: Use an encrypted SSL/TLS connection when connecting to a host: true or false.

       • user, password: Username and password for access to the ClickHouse® database.

       • priority: Host priority for balancing shard connections. The default value is 0. A lower value assigns a higher priority when selecting a host for shard connections.

   You can get the cluster ID with the list of clusters in the folder, and the shard group name, with the list of groups in the cluster.

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

If you do not have the Yandex Cloud CLI yet, install and initialize it.

The folder used by default is the one specified when creating the CLI profile. To change the default folder, use the yc config set folder-id <folder_ID> command. You can also specify a different folder for any command using --folder-name or --folder-id.

If you access a resource by its name, the search will be limited to the default folder. If you access a resource by its ID, the search will be global, i.e., through all folders based on access permissions.

To delete a shard group in a cluster, run this command:

yc managed-clickhouse shard-groups delete \
   --cluster-name=<cluster_name> \
   --name=<shard_group_name>

You can get the cluster name from the list of clusters in your folder.

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

1. Open the current Terraform configuration file with the infrastructure plan.

   For more on how to create this file, see Creating a cluster.

2. Delete the shard_group section for the group in question from the Managed Service for ClickHouse® cluster description.

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. Type yes and press Enter.

   1. Run this command to view the intended 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_v2" "<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 into an environment variable:

   export IAM_TOKEN="<IAM_token>"
   

2. Call the Cluster.DeleteShardGroup method, e.g., via the following cURL request:

   curl \
     --request DELETE \
     --header "Authorization: Bearer $IAM_TOKEN" \
     --url 'https://mdb.api.cloud.yandex.net/managed-clickhouse/v1/clusters/<cluster_ID>/shardGroups/<shard_group_name>'
   

   You can get the cluster ID with the list of clusters in the folder, and the shard group name, with the list of groups in the cluster.

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

1. Get an IAM token for API authentication and put it into 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 that the repository contents reside in the ~/cloudapi/ directory.

3. Call the ClusterService.DeleteShardGroup 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>",
           "shard_group_name": "<shard_group_name>"
         }' \
     mdb.api.cloud.yandex.net:443 \
     yandex.cloud.mdb.clickhouse.v1.ClusterService.DeleteShardGroup
   

   You can get the cluster ID with the list of clusters in the folder, and the shard group name, with the list of groups in the cluster.

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