Delivering data to Yandex Managed Service for OpenSearch using Yandex Data Transfer
A Yandex Managed Service for OpenSearch cluster can ingest data from Apache Kafka® topics in real time.
To start data delivery:
- Prepare your test data.
- Configure the target cluster.
- Prepare and activate your transfer.
- Test the transfer.
If you no longer need the resources you created, delete them.
Required paid resources
- Managed Service for Apache Kafka® cluster, which includes computing resources allocated to hosts, storage and backup size (see Managed Service for Apache Kafka® pricing).
- Managed Service for OpenSearch cluster, which includes the use of computing resources and storage size (see Managed Service for OpenSearch pricing).
- Public IP addresses if public access is enabled for cluster hosts (see Yandex Virtual Private Cloud pricing).
Getting started
-
Set up your data delivery infrastructure:
ManuallyTerraformNote
Public access to cluster hosts is required if you plan to connect to the cluster via the internet. This connection option is simpler and is recommended for the purposes of this guide. You can connect to non-public hosts as well but only from Yandex Cloud virtual machines located in the same cloud network as the cluster.
-
Create a Managed Service for Apache Kafka® source cluster with your preferred 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 Managed Service for OpenSearch target cluster in any suitable configuration with the following settings:
- In the same availability zone as the source cluster.
- With public access to hosts with the
DATArole.
-
To connect to the cluster from your local machine, configure the security groups as follows:
-
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-mos.tf
configuration file to the same working directory.This file describes:
- Network.
- Subnet.
- Security group and the rules allowing connections to the Managed Service for Apache Kafka® and Managed Service for OpenSearch 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. - Managed Service for OpenSearch target cluster.
- Transfer.
-
In the
data-transfer-mkf-mos.tffile, specify these variables:kf_version: Apache Kafka® version in the source cluster.kf_user_password:mkf-useruser password.os_version: OpenSearch version in the source cluster.os_user_password:adminuser password.transfer_enabled: Set to0to ensure that no transfer is created until you create endpoints manually.
-
Validate your Terraform configuration files 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 kafkacatCheck that 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 your test data
Suppose the Apache Kafka® sensors topic in the source cluster receives JSON-formatted data from car sensors.
On your local machine, create a 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
}
Configure the target cluster
Tip
You can deliver data to the Managed Service for OpenSearch cluster as admin with the superuser role; however, a more secure strategy is to create dedicated users with limited privileges for each job. For more information, see Managing OpenSearch users.
-
Create a role
with thecreate_indexandwriteprivileges for all indexes (*). -
Create a user and assign this role to them.
Prepare and activate your transfer
-
Create an
Apache Kafka®source endpoint: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.Paste 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
OpenSearchtarget:Endpoint parameters → Connection:
-
Connection type:
Managed Service for OpenSearch cluster.- Managed Service for OpenSearch cluster: Select the source cluster from the list.
-
User: Enter the username.
-
Password: Enter the user password.
-
-
Create a transfer:
ManuallyTerraform- Create a transfer of the Replication-type that will use the endpoints you created.
- Activate the transfer and wait for its status to change to Replicating.
-
In the
data-transfer-mkf-mos.tffile, specify these variables:source_endpoint_id: Source endpoint ID.target_endpoint_id: Target endpoint ID.transfer_enabled: Set to1to create a transfer.
-
Validate your Terraform configuration files 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 be activated automatically. Wait for its status to change to Replicating.
Test the transfer
Check that data from the Managed Service for Apache Kafka® source cluster’s topic is transferred to the Managed Service for OpenSearch 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 an Apache Kafka® cluster from applications. -
Check that the Managed Service for OpenSearch cluster's
sensorsindex contains the data you sent:BashOpenSearch DashboardsRun this command:
curl \ --user <username_in_target_cluster>:<user_password_in_target_cluster> \ --cacert ~/.opensearch/root.crt \ --header 'Content-Type: application/json' \ --request GET 'https://<ID_of_OpenSearch_host_with_DATA_role>.rw.mdb.yandexcloud.net:9200/sensors/_search?pretty'- Connect to the target cluster using OpenSearch Dashboards.
- Select the
Globaltenant. - Open the management panel by clicking
. - Under OpenSearch Dashboards, select Discover.
- In the CHANGE INDEX PATTERN field, select the
sensorsindex.
Delete the resources you created
Note
Before deleting any resources, deactivate the transfer.
To minimize resource consumption, delete the resources you no longer need:
-
Delete other resources, applying the same method used for their creation:
ManuallyUsing Terraform-
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.
-
-