Managing disk space in a Managed Service for Apache Kafka® cluster

If you do not have the Yandex Cloud command line interface yet, install and initialize it.

The folder specified in the CLI profile is used by default. You can specify a different folder using the --folder-name or --folder-id parameter.

To increase the hosts' storage size:

1. View the description of the update cluster CLI command:

   yc managed-kafka cluster update --help
   

2. To change the size of the broker host storage, run the command:

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

   If no size units are specified, gigabytes are used.

3. To change the size of the ZooKeeper host storage, run the command:

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

   If no size units are specified, gigabytes are used.

You cannot change the disk type for an Apache Kafka® cluster once you create it.

To increase the cluster storage size:

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

   For more information about creating this file, see Creating clusters.

2. In the Managed Service for Apache Kafka® cluster description, change the value of the disk_size parameter in the kafka.resources and zookeeper.resources sections for Apache Kafka® and ZooKeeper hosts, respectively:

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

   You cannot change the disk type for an Apache Kafka® cluster once you create it.

3. Make sure the settings are correct.

   1. Using the command line, navigate to the folder that contains the up-to-date Terraform configuration files with an infrastructure plan.

   2. Run the command:

      terraform validate
      

      If there are errors in the configuration files, Terraform will point to them.

4. Confirm updating the resources.

   1. Run the command to view planned changes:

      terraform plan
      

      If the resource configuration descriptions are correct, the terminal will display a list of the resources to modify and their parameters. This is a test step. No resources are updated.

   2. If you are happy with the planned changes, apply them:

      1. Run the command:

         terraform apply
         

      2. Confirm the update of resources.

      3. Wait for the operation to complete.

For more information, see the Terraform provider documentation.

resource "yandex_mdb_kafka_cluster" "<cluster_name>" {
  ...
  timeouts {
    create = "1h30m" # 1 hour 30 minutes
    update = "2h"    # 2 hours
    delete = "30m"   # 30 minutes
  }
}

To increase the cluster storage size, use the update REST API method for the Cluster resource or the ClusterService/Update gRPC API call and provide the following in the request:

• Cluster ID, in the clusterId parameter. To find out the cluster ID, get a list of clusters in the folder.
• New storage settings in the configSpec.kafka.resources parameter (configSpec.zookeeper.resources for ZooKeeper hosts).
• List of settings to update, in the updateMask parameter.

You cannot change the disk type for an Apache Kafka® cluster once you create it.

If you do not have the Yandex Cloud command line interface yet, install and initialize it.

The folder specified in the CLI profile is used by default. You can specify a different folder using the --folder-name or --folder-id parameter.

To set up automatic increase of storage size:

1. View the description of the update cluster CLI command:

   yc managed-kafka cluster update --help
   

2. Set the maximum storage size and conditions for its increase in the update cluster command:

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

   Where:

   • planned-usage-threshold: Storage utilization percentage to trigger a storage increase in the next maintenance window.

     Use a percentage value between 0 and 100. The default value is 0 (automatic increase is disabled).

     If you set this parameter, configure the maintenance schedule.

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

     Use a percentage value between 0 and 100. The default value is 0 (automatic increase is disabled). This parameter value must be greater than or equal to planned-usage-threshold.

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

     If the value is 0, automatic increase of storage size will be disabled.

To enable automatic increase of storage size, use the update REST API method for the Cluster resource or the ClusterService/Update gRPC API call and provide the following in the request:

• Storage utilization percentage to trigger a storage increase in the next maintenance window, in the configSpec.diskSizeAutoscaling.plannedUsageThreshold parameter.

  Use a value between 0 and 100%. The default value is 0 (automatic increase is disabled).

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

• Storage utilization percentage to trigger an immediate storage increase, in the configSpec.diskSizeAutoscaling.emergencyUsageThreshold parameter.

  Use a value between 0 and 100%. The default value is 0 (automatic increase is disabled). This parameter value must be greater than or equal to configSpec.diskSizeAutoscaling.plannedUsageThreshold.

• Maximum storage size, in bytes, that can be set when utilization reaches one of the specified percentages, in the configSpec.diskSizeAutoscaling.diskSizeLimit parameter.