Upgrading a Managed Service for Apache Kafka® cluster to migrate from ZooKeeper to KRaft

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. Initiate updating Apache Kafka® in your cluster with the following command:

   yc managed-kafka cluster update <cluster_name_or_ID> \
      --version=3.6
   

2. Repeat the command for the remaining versions in the given order.

1. Open the current Terraform configuration file that defines your infrastructure.

2. In the config section of the Managed Service for Apache Kafka® cluster, set 3.6 in the version field as the new Apache Kafka® version:

   resource "yandex_mdb_kafka_cluster" "<cluster_name>" {
     ...
     config {
       version = "3.6"
     }
   }
   

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.

5. Repeat the steps for the remaining Apache Kafka® versions in the given order.

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

   export IAM_TOKEN="<IAM_token>"
   

2. Use the Cluster.update method and send the following request, e.g., via cURL:

   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.version",
                 "configSpec": {
                   "version": "3.6"
                 }
               }'
   

   Where:

   • updateMask: List of parameters to update as a single string, separated by commas.

     Here only one parameter is specified: configSpec.version.

   • configSpec.version: Apache Kafka® version.

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

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

4. Repeat the steps for the remaining Apache Kafka® versions in the given order.

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

   export IAM_TOKEN="<IAM_token>"
   

2. Use the ClusterService/Update call and send the following request, e.g., via gRPCurl:

   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.version"
               ]
             },
             "config_spec": {
               "version": "3.6"
             }
           }' \
       mdb.api.cloud.yandex.net:443 \
       yandex.cloud.mdb.kafka.v1.ClusterService.Update
   

   Where:

   • update_mask: List of parameters to update as an array of paths[] strings.

     Here only one parameter is specified: config_spec.version.

   • config_spec.version: Apache Kafka® version.

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

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

4. Repeat the steps for the remaining Apache Kafka® versions in the given order.

Run this command to start the cluster migration:

yc managed-kafka cluster update <cluster_name_or_ID> \
   --controller-resource-preset "<KRaft_host_class>" \
   --controller-disk-size <storage_size> \
   --controller-disk-type <disk_type>

Where:

• --controller-resource-preset: KRaft host class.
• --controller-disk-type: Disk type of KRaft hosts.

To find out the cluster name or ID, get a list of clusters in the folder.

1. Open the current Terraform configuration file that defines your infrastructure.

2. Delete the config.zookeeper section of the Managed Service for Apache Kafka® cluster.

3. Add the config.kraft section with the KRaft controller resource description:

   resource "yandex_mdb_kafka_cluster" "<cluster_name>" {
     ...
     config {
       ...
       kraft {
         resources {
           disk_size          = <storage_size_in_GB>
           disk_type_id       = "<disk_type>"
           resource_preset_id = "<KRaft_host_class>"
         }
       }
     }
   }
   

   Where:

   • kraft.resources.resource_preset_id: KRaft host class.
   • kraft.resources.disk_type_id: Disk type of KRaft hosts.

   Note

   For KRaft controllers:

   • Only the network-ssd and network-ssd-nonreplicated disk types are available.
   • The Intel Broadwell platform is not available.

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.

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

   export IAM_TOKEN="<IAM_token>"
   

2. Use the Cluster.update method and send the following request, e.g., via cURL:

   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.kraft.resources.resourcePresetId,configSpec.kraft.resources.diskSize,configSpec.kraft.resources.diskTypeId",
                 "configSpec": {
                   "kraft": {
                     "resources": {
                       "resourcePresetId": "<KRaft_host_class>",
                       "diskSize": "<storage_size_in_bytes>",
                       "diskTypeId": "<disk_type>"
                     }
                   }
                 }
               }'
   

   Where:

   • updateMask: List of parameters to update as a single string, separated by commas.

     Here you need to specify all parameters of the resources you want to add: configSpec.kraft.resources.resourcePresetId, configSpec.kraft.resources.diskSize, configSpec.kraft.resources.diskTypeId.

   • configSpec.kraft: KRaft controller configuration:

     • resources.resourcePresetId: Host class ID. You can request the list of available host classes with their IDs using the ResourcePreset.list method.
     • resources.diskSize: Disk size in bytes.
     • resources.diskTypeId: Disk type.

     Note

     For KRaft controllers:

     • Only the network-ssd and network-ssd-nonreplicated disk types are available.
     • The Intel Broadwell platform is not available.

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

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

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

   export IAM_TOKEN="<IAM_token>"
   

2. Use the ClusterService/Update call and send the following request, e.g., via gRPCurl:

   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.kraft.resources.resource_preset_id",
                 "config_spec.kraft.resources.disk_size",
                 "config_spec.kraft.resources.disk_type_id"
               ]
             },
             "config_spec": {
               "kraft": {
                 "resources": {
                   "resource_preset_id": "<KRaft_host_class>",
                   "disk_size": "<storage_size_in_bytes>",
                   "disk_type_id": "<disk_type>"
                 }
               }
             }
           }' \
       mdb.api.cloud.yandex.net:443 \
       yandex.cloud.mdb.kafka.v1.ClusterService.Update
   

   Where:

   • update_mask: List of parameters to update as an array of paths[] strings.

     Here you need to specify all parameters of the resources you want to add: config_spec.kraft.resources.resource_preset_id, config_spec.kraft.resources.disk_size, config_spec.kraft.resources.disk_type_id.

   • config_spec.kraft: KRaft controller configuration:

     • resources.resource_preset_id: Host class ID. You can request the list of available host classes with their IDs using the ResourcePreset.list method.
     • resources.disk_size: Disk size in bytes.
     • resources.disk_type_id: Disk type.

     Note

     For KRaft controllers:

     • Only the network-ssd and network-ssd-nonreplicated disk types are available.
     • The Intel Broadwell platform is not available.

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

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

1. In the terminal window, go to the directory containing the infrastructure plan.

   Warning

   Make sure the directory has no Terraform manifests with the resources you want to keep. Terraform deletes all resources that were created using the manifests in the current directory.

2. Delete resources:

   1. Run this command:

      terraform destroy
      

   2. Confirm deleting the resources and wait for the operation to complete.

   All the resources described in the Terraform manifests will be deleted.