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 request 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 request 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>

Where --shards is the list of shard names to include in the group.

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

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

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

   For more on how to create this 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 = "<optional_description_for_shard_group>"
       shard_names = [
         # List of shards in the group
         "<shard_1_name>",
         ...
         "<shard_N_name>"
       ]
     }
   }
   

3. Validate your configuration.

   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_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>"
               ]
             }'
   

   Where:

   • shardGroupName: Shard group name.
   • description: Shard group description.
   • shardNames: List of shards to include in the new group.

   You can request 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>"
             ]
           }' \
       mdb.api.cloud.yandex.net:443 \
       yandex.cloud.mdb.clickhouse.v1.ClusterService.CreateShardGroup
   

   Where:

   • shard_group_name: Shard group name.
   • description: Shard group description.
   • shard_names: List of shards to include in the new group.

   You can request 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>

Where --shards is the new list of shard names to include in the group.

This command replaces the existing list of shards in the group with the new one provided in the --shards parameter. Before running the command, make sure you have added all the required shards to the new list.

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.

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

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

   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        = "<new_name_for_shard_group>"
       description = "<new_description_for_shard_group>"
       shard_names = [
         # New list of shards in the group
         "<shard_1_name>",
         ...
         "<shard_N_name>"
       ]
     }
   }
   

3. Validate your configuration.

   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_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",
               "description": "<shard_group_description>",
               "shardNames": [
                 "<shard_1>", "<shard_2>", ... "<shard_N>"
               ]
             }'
   

   Where:

   • updateMask: Comma-separated string of settings to update.
   • description: New description for the shard group.
   • shardNames: New list of 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.

   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"
             ]
           },
           "description": "<shard_group_description>",
           "shard_names": [
             "<shard_1>", "<shard_2>", ... "<shard_N>"
           ]
         }' \
     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 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.

   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 describing your infrastructure.

   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. Validate your configuration.

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