Apache Kafka® version upgrade

If you don't 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.

1. Get a list of your Managed Service for Apache Kafka® clusters:

   yc managed-kafka cluster list
   

2. Get information about a cluster and check the version in the config.version parameter:

   yc managed-kafka cluster get <cluster ID or name>
   

3. Start the Apache Kafka® upgrade:

   yc managed-kafka cluster update <cluster ID or name> \
      --version=<new version number>
   

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

   For more information about creating this file, see Creating a Apache Kafka® cluster.

2. Add a version field to the config section of the desired Managed Service for Apache Kafka® cluster or edit the field value if the field already exists:

   resource "yandex_mdb_kafka_cluster" "<cluster name>" {
     ...
     config {
       version = "<Apache Kafka® version>"
     }
   }
   

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 the update of 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
  }
}

Use the update API method and pass the following in the request:

• The cluster ID in the clusterId parameter. You can retrieve it with a list of clusters in the folder.

• The Apache Kafka® version number in the configSpec.version parameter.

• List of cluster configuration fields to be changed in the updateMask parameter.

  Warning

  This API method resets the values of all parameters of the object to update, which aren't passed explicitly in the request. To avoid this, in the updateMask parameter, list the settings you want to change (in a single line, separated by commas).