Managing disk space in a Managed Service for Apache Kafka® 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 change the disk type and expand the storage size for hosts:

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

   yc managed-kafka cluster update --help
   

2. To change the disk type and storage size of broker hosts, run this command (the storage size must not be less than the disk_size cluster setting):

   yc managed-kafka cluster update <cluster_name_or_ID> \
      --disk-type <disk_type> \
      --disk-size <storage_size>
   

   If you specify no size units, gigabytes are used.

   Warning

   You can change the disk type of broker hosts only for an Apache Kafka® highly available cluster.

3. To change the storage size of ZooKeeper hosts, run this command (the storage size must not be less than the disk_size cluster setting):

   yc managed-kafka cluster update <cluster_name_or_ID> \
      --zookeeper-disk-size <disk_size>
   

   If you specify no size units, gigabytes are used.

   You cannot change the disk type for ZooKeeper hosts after they are created.

To change the disk type and expand the storage size for a cluster:

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

   For information on how to create this file, see Creating a cluster Apache Kafka®.

2. Update the following settings in your Managed Service for Apache Kafka® cluster description:

   • disk_size and disk_type_id in the kafka.resources section for Apache Kafka® broker hosts.

     Warning

     You can change the disk type of broker hosts only for an Apache Kafka® highly available cluster.

   • disk_size in the zookeeper.resources section for ZooKeeper hosts.

   resource "yandex_mdb_kafka_cluster" "<cluster_name>" {
     ...
     kafka {
       resources {
         disk_type_id = "<disk_type>"
         disk_size = <storage_size_in_GB>
         ...
       }
       ...
     }
     zookeeper {
       resources {
         disk_size = <storage_size_in_GB>
         ...
       }
     }
   }
   

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_kafka_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 into 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-kafka/v1/clusters/<cluster_ID>' \
       --data '{
                 "updateMask": "configSpec.kafka.resources.diskTypeId,configSpec.kafka.resources.diskSize,configSpec.zookeeper.resources.diskSize",
                 "configSpec": {
                   "kafka": {
                     "resources": {
                       "diskTypeId": "<disk_type>",
                       "diskSize": "<storage_size_in_bytes>"
                     }
                   },
                   "zookeeper": {
                     "resources": {
                       "diskSize": "<storage_size_in_bytes>"
                     }
                   }
                 }
               }'
   

   Where:

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

     Specify the relevant parameters:

     • configSpec.kafka.resources.diskTypeId: To change the disk type for broker hosts.

       Warning

       You can change the disk type of broker hosts only for an Apache Kafka® highly available cluster.

     • configSpec.kafka.resources.diskSize: To resize the broker host storage.

     • configSpec.zookeeper.resources.diskSize: To resize the ZooKeeper host storage. Use only for Apache Kafka® 3.5 clusters.

   • configSpec.kafka.resources.diskSize: Broker host storage size, in bytes.

   • configSpec.zookeeper.resources.diskSize: ZooKeeper host storage size, in bytes. Use only for Apache Kafka® 3.5 clusters.

   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 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/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/kafka/v1/cluster_service.proto \
       -rpc-header "Authorization: Bearer $IAM_TOKEN" \
       -d '{
             "cluster_id": "<cluster_ID>",
             "update_mask": {
               "paths": [
                 "config_spec.kafka.resources.disk_type_id",
                 "config_spec.kafka.resources.disk_size",
                 "config_spec.zookeeper.resources.disk_size"
               ]
             },
             "config_spec": {
               "kafka": {
                 "resources": {
                   "disk_type_id": "<disk_type>",
                   "disk_size": "<storage_size_in_bytes>"
                 }
               },
               "zookeeper": {
                 "resources": {
                   "disk_size": "<storage_size_in_bytes>"
                 }
               }
             }
           }' \
       mdb.api.cloud.yandex.net:443 \
       yandex.cloud.mdb.kafka.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.kafka.resources.disk_type_id: To change the disk type for broker hosts.

       Warning

       You can change the disk type of broker hosts only for an Apache Kafka® highly available cluster.

     • config_spec.kafka.resources.disk_size: To resize the broker host storage.

     • config_spec.brokers_count: To resize the ZooKeeper host storage. Use only for Apache Kafka® 3.5 clusters.

   • config_spec.kafka.resources.disk_size: Broker host storage size, in bytes.

   • config_spec.zookeeper.resources.disk_size: ZooKeeper host storage size, in bytes. Use only for Apache Kafka® 3.5 clusters.

   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.

4. Check 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 set up automatic storage expansion:

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

   yc managed-kafka cluster update --help
   

2. Run this command, specifying the maximum storage size and the conditions for expansion:

   yc managed-kafka cluster update <cluster_ID_or_name> \
      --disk-size-autoscaling planned-usage-threshold=<scheduled_expansion_percentage>,`
                             `emergency-usage-threshold=<immediate_expansion_percentage>,`
                             `disk-size-limit=<maximum_storage_size_in_bytes>
   

   Where:

   • planned-usage-threshold: Storage usage percentage to trigger a storage expansion during the next maintenance window.

     Use a value between 0 and 100%. The default value is 0, i.e., automatic expansion is disabled.

     If you set this condition, configure the maintenance schedule.

   • emergency-usage-threshold: Storage usage percentage to trigger an immediate storage expansion.

     Use a value between 0 and 100%. The default value is 0, i.e., automatic expansion is disabled. The value of this setting must be greater than or equal to planned-usage-threshold.

   • disk-size-limit: Maximum storage size, in bytes, that can be set when storage usage reaches one of the specified thresholds.

     If you set it to 0, automatic storage expansion will be disabled.

1. Get an IAM token for API authentication and put it into 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-kafka/v1/clusters/<cluster_ID>' \
       --data '{
                 "updateMask": "configSpec.diskSizeAutoscaling.plannedUsageThreshold,configSpec.diskSizeAutoscaling.plannedUsageThreshold,configSpec.diskSizeAutoscaling.plannedUsageThreshold",
                 "configSpec": {
                   "diskSizeAutoscaling": {
                     "plannedUsageThreshold": "<scheduled_expansion_percentage>",
                     "emergencyUsageThreshold": "<immediate_expansion_percentage>",
                     "diskSizeLimit": "<maximum_storage_size_in_bytes>"
                   }
                 }
               }'
   

   Where:

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

     Specify the relevant parameters:

     • configSpec.diskSizeAutoscaling.plannedUsageThreshold: To change the storage usage percentage to trigger a scheduled expansion.
     • configSpec.diskSizeAutoscaling.emergencyUsageThreshold: To change the storage usage percentage to trigger a non-scheduled expansion.
     • configSpec.diskSizeAutoscaling.diskSizeLimit: To change the maximum storage size during automatic expansion.

   • plannedUsageThreshold: Storage usage percentage to trigger a storage expansion during the next maintenance window.

     Use a value between 0 and 100%. The default value is 0, i.e., automatic expansion is disabled.

     If you set this condition, configure the maintenance window schedule.

   • emergencyUsageThreshold: Storage usage percentage to trigger an immediate storage expansion.

     Use a value between 0 and 100%. The default value is 0, i.e., automatic expansion is disabled. The value of this setting must be greater than or equal to plannedUsageThreshold.

   • diskSizeLimit: Maximum storage size, in bytes, that can be set when storage usage reaches one of the specified thresholds.

   You can request 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 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/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/kafka/v1/cluster_service.proto \
       -rpc-header "Authorization: Bearer $IAM_TOKEN" \
       -d '{
             "cluster_id": "<cluster_ID>",
             "update_mask": {
               "paths": [
                 "config_spec.disk_size_autoscaling.planned_usage_threshold",
                 "config_spec.disk_size_autoscaling.emergency_usage_threshold",
                 "config_spec.disk_size_autoscaling.disk_size_limit"
               ]
             },
             "config_spec": {
               "disk_size_autoscaling": {
                   "planned_usage_threshold": "<scheduled_expansion_percentage>",
                   "emergency_usage_threshold": "<immediate_expansion_percentage>",
                   "disk_size_limit": "<maximum_storage_size_in_bytes>"
               }
             }
           }' \
       mdb.api.cloud.yandex.net:443 \
       yandex.cloud.mdb.kafka.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.disk_size_autoscaling.planned_usage_threshold: To change the storage usage percentage to trigger a scheduled expansion.
     • config_spec.disk_size_autoscaling.emergency_usage_threshold: To change the storage usage percentage to trigger a non-scheduled expansion.
     • config_spec.disk_size_autoscaling.disk_size_limit: To change the maximum storage size during automatic expansion.

   • planned_usage_threshold: Storage usage percentage to trigger a storage expansion during the next maintenance window.

     Use a value between 0 and 100%. The default value is 0, i.e., automatic expansion is disabled.

     If you set this condition, configure the maintenance window schedule.

   • emergency_usage_threshold: Storage usage percentage to trigger an immediate storage expansion.

     Use a value between 0 and 100%. The default value is 0, i.e., automatic expansion is disabled. The value of this setting must be greater than or equal to planned_usage_threshold.

   • disk_size_limit: Maximum storage size, in bytes, that can be set when storage usage reaches one of the specified thresholds.

   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.

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