Apache Kafka® cluster mirroring

You can transfer your data from Apache Kafka® topics between one Apache Kafka® cluster and another in real time. Among others, the following migration types are supported:

• Between different Apache Kafka® versions, e.g., you can migrate topics from version 2.8 to version 3.1.
• Between different availability zones: you can migrate a cluster with a single host from one zone to another.

Apache Kafka® cluster mirroring allows you to:

• Set up topic replication in the management console interface or in Terraform.
• Track the migration process using the transfer monitoring.
• Avoid creating an intermediate VM or granting online access to your target cluster.

To migrate data:

1. Prepare and activate the transfer.
2. Test the transfer.

If you no longer need the resources you created, delete them.

Getting startedGetting started

1. Prepare the data transfer infrastructure:

   Manually

   Terraform

   1. Create a source and target Managed Service for Apache Kafka® cluster with public access from the internet in any suitable configuration.
   2. In the source cluster, create a topic named sensors.
   3. In the source cluster, create a user with the ACCESS_ROLE_PRODUCER and ACCESS_ROLE_CONSUMER permissions for the created topic.
   4. In the target cluster, create a user with the ACCESS_ROLE_PRODUCER and ACCESS_ROLE_CONSUMER permissions for all the topics.

   1. If you do not have Terraform yet, install it.

   2. Get the authentication credentials. You can add them to environment variables or specify them later in the provider configuration file.

   3. Configure and initialize a provider. There is no need to create a provider configuration file manually, you can download it.

   4. Place the configuration file in a separate working directory and specify the parameter values. If you did not add the authentication credentials to environment variables, specify them in the configuration file.

   5. Download the data-transfer-mkf-mkf.tf configuration file to the same working directory.

      This file describes:

      • Network.
      • Subnet.
      • Security group and the rule required to connect to a Managed Service for Apache Kafka® cluster.
      • Managed Service for Apache Kafka® source cluster with public access from the internet.
      • Apache Kafka® topic for the source cluster.
      • Apache Kafka® user for the source cluster.
      • Managed Service for Apache Kafka® target cluster.
      • Apache Kafka® topic for the target cluster.
      • Apache Kafka® user for the target cluster.
      • Transfer.

   6. In the data-transfer-mkf-mkf.tf file, specify the values of parameters:

      • source_kf_version: Apache Kafka® version in the source cluster.
      • source_user_name: Username for establishing a connection to the Apache Kafka® topic.
      • source_user_password: User password.
      • target_kf_version: Apache Kafka® version in the target cluster.
      • transfer_enabled: Set to 0 to ensure that no transfer is created until you manually create the source and target endpoints.

   7. Make sure the Terraform configuration files are correct using this command:

      terraform validate
      

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

   8. Create the required infrastructure:

      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.

      All the required resources will be created in the specified folder. You can check resource availability and their settings in the management console.

   The created Apache Kafka® sensors topic in the source cluster will receive test data from car sensors in JSON format, for example:

   {
       "device_id":"iv9a94th6rzt********",
       "datetime":"2020-06-05 17:27:00",
       "latitude":"55.70329032",
       "longitude":"37.65472196",
       "altitude":"427.5",
       "speed":"0",
       "battery_voltage":"23.5",
       "cabin_temperature":"17",
       "fuel_level":null
   }
   

2. Install the utilities:

   • kafkacat to read and write data to Apache Kafka® topics.

     sudo apt update && sudo apt install --yes kafkacat
     

     Check that you can use it to connect to the Managed Service for Apache Kafka® source cluster over SSL.

   • jq for JSON file stream processing.

     sudo apt update && sudo apt-get install --yes jq
     

Prepare and activate the transferPrepare and activate the transfer

1. Create a target endpoint:

   • Database type: Kafka.

   • Endpoint parameters:

     • Connection settings: Managed Service for Apache Kafka cluster.

       Select a target cluster from the list and specify its connection settings.

     • Topic:

       • Topic full name: measurements.

2. Create a source endpoint:

   • Database type: Kafka.
   • Endpoint parameters:

     • Connection type: Managed Service for Apache Kafka cluster.

       Select a source cluster from the list and specify its connection settings.

     • Topic full name: sensors.

3. Create a transfer:

   Manually

   Terraform

   1. Create a transfer of the Replication type that will use the created endpoints.
   2. Activate your transfer.

   1. In the data-transfer-mkf-mkf.tf file, specify the values of parameters:

      • source_endpoint_id: ID of the source endpoint.
      • target_endpoint_id: ID of the target endpoint.
      • transfer_enabled: Set to 1 to enable transfer creation.

   2. Make sure the Terraform configuration files are correct using this command:

      terraform validate
      

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

   3. Create the required infrastructure:

      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.

      Once created, your transfer will be activated automatically.

Test the transferTest the transfer

1. Wait for the transfer status to change to Replicating.

2. Make sure that the data from the topic in the source cluster move to the topic in the target Managed Service for Apache Kafka® cluster:

   1. Create a sample.json file with the following test data:

      {
          "device_id": "iv9a94th6rzt********",
          "datetime": "2020-06-05 17:27:00",
          "latitude": 55.70329032,
          "longitude": 37.65472196,
          "altitude": 427.5,
          "speed": 0,
          "battery_voltage": 23.5,
          "cabin_temperature": 17,
          "fuel_level": null
      }
      
      {
          "device_id": "rhibbh3y08qm********",
          "datetime": "2020-06-06 09:49:54",
          "latitude": 55.71294467,
          "longitude": 37.66542005,
          "altitude": 429.13,
          "speed": 55.5,
          "battery_voltage": null,
          "cabin_temperature": 18,
          "fuel_level": 32
      }
      
      {
          "device_id": "iv9a94th6rzt********",
          "datetime": "2020-06-07 15:00:10",
          "latitude": 55.70985913,
          "longitude": 37.62141918,
          "altitude": 417.0,
          "speed": 15.7,
          "battery_voltage": 10.3,
          "cabin_temperature": 17,
          "fuel_level": null
      }
      

   2. Send data from the sample.json file to the sensors topic in the source Managed Service for Apache Kafka® cluster using jq and kafkacat:

      jq -rc . sample.json | kafkacat -P \
         -b <source_cluster_broker_FQDN>:9091 \
         -t sensors \
         -k key \
         -X security.protocol=SASL_SSL \
         -X sasl.mechanisms=SCRAM-SHA-512 \
         -X sasl.username="<username_in_the_source_cluster>" \
         -X sasl.password="<user_password_in_the_source_cluster>" \
         -X ssl.ca.location=/usr/local/share/ca-certificates/Yandex/YandexInternalRootCA.crt -Z
      

      The data is sent on behalf of the created user. To learn more about setting up an SSL certificate and working with kafkacat, see Connecting to an Apache Kafka® cluster from applications.

   3. Use the kafkacat utility to make sure that the data from the source cluster has moved to the target Managed Service for Apache Kafka® cluster:

      kafkacat -C \
               -b <target_cluster_broker_FQDN>:9091 \
               -t measurements \
               -X security.protocol=SASL_SSL \
               -X sasl.mechanisms=SCRAM-SHA-512 \
               -X sasl.username="<username_in_the_target_cluster>" \
               -X sasl.password="<user_password_in_the_target_cluster>" \
               -X ssl.ca.location=/usr/local/share/ca-certificates/Yandex/YandexInternalRootCA.crt -Z -K:
      

Delete the resources you createdDelete the resources you created

Some resources are not free of charge. To avoid paying for them, delete the resources you no longer need:

1. Delete the transfer.
2. Delete endpoints for both the source and target.

Delete the other resources depending on how they were created: