[Yandex Cloud documentation](../../index.md) > [Yandex Data Transfer](../index.md) > [Tutorials](index.md) > Delivering data from queues > Apache Kafka® to OpenSearch

# Delivering data from an Apache Kafka® queue to OpenSearch

# Delivering data from an Apache Kafka® queue to 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:

1. [Prepare your test data](#prepare-data).
1. [Configure the target cluster](#configure-target).
1. [Prepare and activate your transfer](#prepare-transfer).
1. [Test the transfer](#verify-transfer).

If you no longer need the resources you created, [delete them](#clear-out).


## Required paid resources {#paid-resources}

* Managed Service for Apache Kafka® cluster: use of computing resources allocated to hosts and storage size (see [Managed Service for Apache Kafka® pricing](../../managed-kafka/pricing.md)).
* Managed Service for OpenSearch cluster: use of computing resources, storage and backup size (see [Managed Service for OpenSearch pricing](../../managed-opensearch/pricing.md)).
* Public IP addresses if public access is enabled for cluster hosts (see [Yandex Virtual Private Cloud pricing](../../vpc/pricing.md)).


## Getting started {#before-you-begin}

1. Set up your data delivery infrastructure:

    {% list tabs group=instructions %}

    - Manually {#manual}

        {% note info %}
        
        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.
        
        {% endnote %}

        1. [Create a Managed Service for Apache Kafka®](../../managed-kafka/operations/cluster-create.md) source cluster with your preferred configuration. For connections to the cluster from the user's local machine, rather than the Yandex Cloud network, enable public access to the cluster when creating it.

        1. [In the source cluster, create a topic](../../managed-kafka/operations/cluster-topics.md#create-topic) named `sensors`.

        1. [In the source cluster, create a user](../../managed-kafka/operations/cluster-accounts.md#create-account) named `mkf-user` with the `ACCESS_ROLE_PRODUCER` and `ACCESS_ROLE_CONSUMER` permissions for the new topic.

        1. [Create a Managed Service for OpenSearch target cluster](../../managed-opensearch/operations/cluster-create.md#create-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 `DATA` role.


        
        1. To connect to the cluster from your local machine, configure the security groups as follows:

            * [Managed Service for Apache Kafka®](../../managed-kafka/operations/connect/index.md#configuring-security-groups).
            * [Managed Service for OpenSearch](../../managed-opensearch/operations/connect/index.md#security-groups).


    - Terraform {#tf}

        1. If you do not have Terraform yet, [install it](../../tutorials/infrastructure-management/terraform-quickstart.md#install-terraform).
        1. [Get the authentication credentials](../../tutorials/infrastructure-management/terraform-quickstart.md#get-credentials). You can add them to environment variables or specify them later in the provider configuration file.
        1. [Configure and initialize a provider](../../tutorials/infrastructure-management/terraform-quickstart.md#configure-provider). There is no need to create a provider configuration file manually, you can [download it](https://github.com/yandex-cloud-examples/yc-terraform-provider-settings/blob/main/provider.tf).
        1. Place the configuration file in a separate working directory and [specify the parameter values](../../tutorials/infrastructure-management/terraform-quickstart.md#configure-provider). If you did not add the authentication credentials to environment variables, specify them in the configuration file.
        1. Download the [data-transfer-mkf-mos.tf](https://github.com/yandex-cloud-examples/yc-data-transfer-from-kafka-to-opensearch/blob/main/data-transfer-mkf-mos.tf) configuration file to the same working directory.

            This file describes:

            * [Network](../../vpc/concepts/network.md#network).
            * [Subnet](../../vpc/concepts/network.md#subnet).
            * [Security group](../../vpc/concepts/security-groups.md) 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-user` with the `ACCESS_ROLE_PRODUCER` and `ACCESS_ROLE_CONSUMER` access permissions to the `sensors` topic.
            * Managed Service for OpenSearch target cluster.
            * Transfer.

        1. In the `data-transfer-mkf-mos.tf` file, specify these variables:

            * `kf_version`: Apache Kafka® version in the source cluster.
            * `kf_user_password`: `mkf-user` user password.
            * `os_version`: OpenSearch version in the source cluster.
            * `os_user_password`: `admin` user password.
            * `transfer_enabled`: Set to `0` to ensure that no transfer is created until you [create endpoints manually](#prepare-transfer).

        1. Validate your Terraform configuration files using this command:

            ```bash
            terraform validate
            ```

            Terraform will display any configuration errors detected in your files.

        1. Create the required infrastructure:

            1. Run this command to view the planned changes:
            
               ```bash
               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.
            
            1. If everything looks correct, apply the changes:
               1. Run this command:
            
                  ```bash
                  terraform apply
                  ```
            
               1. Confirm updating the resources.
               1. 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](https://console.yandex.cloud).

    {% endlist %}

1. Install the following tools:

    - [kafkacat](https://github.com/edenhill/kcat): For reading from and writing to Apache Kafka® topics.

        ```bash
        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](../../managed-kafka/operations/connect/clients.md#bash-zsh).

    - [jq](https://stedolan.github.io/jq/): For stream processing of JSON files.

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

## Prepare your test data {#prepare-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:

{% cut "sample.json" %}

```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
}
```

{% endcut %}

## Configure the target cluster {#configure-target}

{% note 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](../../managed-opensearch/operations/cluster-users.md).

{% endnote %}

1. [Create a role](https://opensearch.org/docs/latest/security-plugin/access-control/users-roles/#create-roles) with the `create_index` and `write` privileges for all indexes (`*`).

1. [Create a user](../../managed-opensearch/operations/cluster-users.md) and assign this role to them.

## Prepare and activate a transfer {#prepare-transfer}

1. [Create](../operations/endpoint/index.md#create) an [`Apache Kafka®` source endpoint](../operations/endpoint/source/kafka.md):

    **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.

        * **Topic full name**: `sensors`.

    * **Advanced settings** → **Conversion rules**:

        * **Conversion rules**: `json`.
            * **Data scheme**: `JSON specification`.

                Paste the data schema in JSON format:

                {% cut "json" %}

                ```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"
                    }
                ]
                ```

                {% endcut %}

1. [Create an endpoint](../operations/endpoint/index.md#create) for the [`OpenSearch`](../operations/endpoint/target/opensearch.md) target:

    **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.

1. Create a transfer:

    {% list tabs group=instructions %}

    - Manually {#manual}

        1. [Create a transfer](../operations/transfer.md#create) of the **_Replication_**-type that will use the endpoints you created.
        1. [Activate the transfer](../operations/transfer.md#activate) and wait for its status to change to **Replicating**.

    - Terraform {#tf}

        1. In the `data-transfer-mkf-mos.tf` file, specify these variables:

            * `source_endpoint_id`: Source endpoint ID.
            * `target_endpoint_id`: Target endpoint ID.
            * `transfer_enabled`: Set to `1` to create a transfer.

        1. Validate your Terraform configuration files using this command:

            ```bash
            terraform validate
            ```

            Terraform will display any configuration errors detected in your files.

        1. Create the required infrastructure:

            1. Run this command to view the planned changes:
            
               ```bash
               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.
            
            1. If everything looks correct, apply the changes:
               1. Run this command:
            
                  ```bash
                  terraform apply
                  ```
            
               1. Confirm updating the resources.
               1. Wait for the operation to complete.

        1. The transfer will be activated automatically. Wait for its status to change to **Replicating**.

    {% endlist %}

## Test the transfer {#verify-transfer}

Check that data from the Managed Service for Apache Kafka® source cluster’s topic is transferred to the Managed Service for OpenSearch cluster:

1. Send data from `sample.json` to the Managed Service for Apache Kafka® `sensors` topic using `jq` and `kafkacat`:

    ```bash
    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 -Z
    ```

    To learn more about setting up an SSL certificate and using `kafkacat`, see [Connecting to an Apache Kafka® cluster from applications](../../managed-kafka/operations/connect/clients.md).

1. Check that the Managed Service for OpenSearch cluster's `sensors` index contains the data you sent:

    {% list tabs group=programming_language %}

    - Bash {#bash}

        Run this command:

        ```bash
        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'
        ```

    - OpenSearch Dashboards {#opensearch}

        1. [Connect](../../managed-opensearch/operations/connect/clients.md#dashboards) to the target cluster using OpenSearch Dashboards.
        1. Select the `Global` tenant.
        1. Open the management panel by clicking ![os-dashboards-sandwich](../../_assets/console-icons/bars.svg).
        1. Under **OpenSearch Dashboards**, select **Discover**.
        1. In the **CHANGE INDEX PATTERN** field, select the `sensors` index.

    {% endlist %}

## Delete the resources you created {#clear-out}

{% note info %}

Before deleting any resources, [deactivate the transfer](../operations/transfer.md#deactivate).

{% endnote %}

To minimize resource consumption, delete the resources you no longer need:

1. [Delete the transfer](../operations/transfer.md#delete).
1. [Delete the source and target endpoints](../operations/endpoint/index.md#delete).
1. Delete other resources, applying the same method used for their creation:

   {% list tabs group=instructions %}

   - Manually {#manual}

       1. [Delete the Managed Service for OpenSearch cluster](../../managed-opensearch/operations/cluster-delete.md).
       1. [Delete the Managed Service for Apache Kafka® cluster](../../managed-kafka/operations/cluster-delete.md).

   - Using Terraform {#tf}

       1. In the terminal window, go to the directory containing the infrastructure plan.
       
           {% note 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.
       
           {% endnote %}
       
       1. Delete resources:
       
           1. Run this command:
       
               ```bash
               terraform destroy
               ```
       
           1. Confirm deleting the resources and wait for the operation to complete.
       
           All the resources described in the Terraform manifests will be deleted.

   {% endlist %}