Delivering data from Yandex Managed Service for Apache Kafka® using Yandex Data Transfer
A Yandex StoreDoc cluster can ingest data from Apache Kafka® topics in real time.
To run data delivery:
If you no longer need the resources you created, delete them.
Required paid resources
The support cost includes:
- Managed Service for Apache Kafka® cluster fee: Covers the use of computational resources allocated to hosts (including ZooKeeper hosts) and disk storage (see Apache Kafka® pricing).
- Yandex StoreDoc cluster fee: using computing resources allocated to hosts and disk space (see Yandex StoreDoc pricing).
- Fee for public IP addresses if public access is enabled for cluster hosts (see Virtual Private Cloud pricing).
- Per-transfer fee: using computing resources and the number of transferred data rows (see Data Transfer pricing).
Getting started
-
Set up your data pipeline infrastructure:
ManuallyTerraform-
Create a Managed Service for Apache Kafka® source cluster with any suitable configuration. Enable public access to the cluster during creation so you can connect to it from your local machine. Connections from within the Yandex Cloud network are enabled by default.
-
In the source cluster, create a topic named
sensors. -
In the source cluster, create a user named
mkf-userwith theACCESS_ROLE_PRODUCERandACCESS_ROLE_CONSUMERpermissions for the new topic. -
Create a target Yandex StoreDoc cluster with any suitable configuration, using the following settings:
- Database name:
db1. - Username:
mmg-user. - In the same availability zone as the source cluster.
- To connect to the cluster from the user's local machine instead of the Yandex Cloud cloud network, enable public access to the cluster hosts.
- Database name:
-
To connect to the cluster from the user's local machine, configure security groups:
-
If you do not have Terraform yet, install it.
-
Get the authentication credentials. You can add them to environment variables or specify them later in the provider configuration file.
-
Configure and initialize a provider. There is no need to create a provider configuration file manually, you can download it
. -
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.
-
Download the data-transfer-mkf-mmg.tf
configuration file to the same working directory.This file describes:
- Network.
- Subnet.
- Security group and rules allowing inbound connections to the Managed Service for Apache Kafka® and Yandex StoreDoc clusters.
- Managed Service for Apache Kafka® source cluster.
- Apache Kafka® topic named
sensors. - Apache Kafka® user named
mkf-userwith theACCESS_ROLE_PRODUCERandACCESS_ROLE_CONSUMERaccess permissions to thesensorstopic. - Yandex StoreDoc target cluster.
- Yandex StoreDoc database named
db1. - Yandex StoreDoc user named
mmg-userwith thereadWriteaccess permissions for thedb1database. - Transfer.
-
In the
data-transfer-mkf-mmg.tffile, specify these variables:source_kf_version: Apache Kafka® version in the source cluster.source_user_password:mkf-userpassword in the source cluster.target_mg_version: Yandex StoreDoc version in the target cluster.target_user_password:mmg-userpassword in the target cluster.transfer_enabled: Set to0to ensure that no transfer is created until you create endpoints manually.
-
Make sure the Terraform configuration files are correct using this command:
terraform validateTerraform will display any configuration errors detected in your files.
-
Create the required infrastructure:
-
Run this command to view the planned changes:
terraform planIf 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.
-
If everything looks correct, apply the changes:
-
Run this command:
terraform apply -
Confirm updating the resources.
-
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
. -
-
-
Install the following tools:
-
kafkacat
: For reading from and writing to Apache Kafka® topics.sudo apt update && sudo apt install --yes kafkacatMake sure you can use it to connect to the Managed Service for Apache Kafka® source cluster over SSL.
-
jq
for stream processing of JSON files.sudo apt update && sudo apt-get install --yes jq
-
Prepare the test data
Let's assume the Apache Kafka® sensors topic in the source cluster receives data from car sensors in JSON format.
Create a local sample.json file with the following test data:
sample.json
{
"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
}
Set up and activate the transfer
-
Create an endpoint for the
Apache Kafka®source:Endpoint parameters:
-
Connection settings:
-
Connection type:
Managed Service for Apache Kafka cluster.-
Managed Service for Apache Kafka cluster: Select the source cluster from the list.
-
Authentication:
SASL.- Username:
mkf-user. - Password: Enter the user password.
- Username:
-
-
Topic full name:
sensors.
-
-
Advanced settings → Conversion rules:
- Conversion rules:
json.-
Data scheme:
JSON specification.Insert the data schema in JSON format:
json
[ { "name": "device_id", "type": "utf8", "key": true }, { "name": "datetime", "type": "utf8" }, { "name": "latitude", "type": "double" }, { "name": "longitude", "type": "double" }, { "name": "altitude", "type": "double" }, { "name": "speed", "type": "double" }, { "name": "battery_voltage", "type": "double" }, { "name": "cabin_temperature", "type": "uint16" }, { "name": "fuel_level", "type": "uint16" } ]
-
- Conversion rules:
-
-
Create an endpoint for the
MongoDBtarget:Endpoint parameters:
-
Connection settings:
-
Connection type:
Yandex StoreDoc cluster.- Yandex StoreDoc cluster: Select the source cluster from the list.
-
Authentication source:
db1. -
User:
mmg-user. -
Password: Enter the user password.
-
-
Database:
db1.
-
-
Create a transfer:
ManuallyTerraform- Create a transfer of the Replication type that will use the created endpoints.
- Activate the transfer and wait for its status to change to Replicating.
-
In the
data-transfer-mkf-mmg.tffile, specify these variables:source_endpoint_id: ID of the source endpoint.target_endpoint_id: ID of the target endpoint.transfer_enabled:1to create a transfer.
-
Make sure the Terraform configuration files are correct using this command:
terraform validateTerraform will display any configuration errors detected in your files.
-
Create the required infrastructure:
-
Run this command to view the planned changes:
terraform planIf 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.
-
If everything looks correct, apply the changes:
-
Run this command:
terraform apply -
Confirm updating the resources.
-
Wait for the operation to complete.
-
-
-
The transfer will activate automatically upon creation. Wait for its status to change to Replicating.
Test your transfer
Make sure the data from the topic in the source Managed Service for Apache Kafka® cluster is being moved to the Yandex StoreDoc cluster:
-
Send data from
sample.jsonto the Managed Service for Apache Kafka®sensorstopic usingjqandkafkacat:jq -rc . sample.json | kafkacat -P \ -b <broker_host_FQDN>:9091 \ -t sensors \ -k key \ -X security.protocol=SASL_SSL \ -X sasl.mechanisms=SCRAM-SHA-512 \ -X sasl.username="mkf-user" \ -X sasl.password="<user_password_in_source_cluster>" \ -X ssl.ca.location=/usr/local/share/ca-certificates/Yandex/YandexInternalRootCA.crt -ZTo learn more about setting up an SSL certificate and using
kafkacat, see Connecting to a Apache Kafka® cluster from applications. -
Make sure that the Yandex StoreDoc cluster's
sensorscollection contains the data that was sent:-
Get the contents of the
sensorscollection using the query below:db.sensors.find()
Delete the resources you created
Note
Before deleting the resources, deactivate the transfer.
Some resources are not free of charge. To avoid paying for them, delete the resources you no longer need:
Delete other resources using the same method used for their creation:
-
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.
-
Delete resources:
-
Run this command:
terraform destroy -
Confirm deleting the resources and wait for the operation to complete.
All the resources described in the Terraform manifests will be deleted.
-