Migrating data from Elasticsearch to Yandex Managed Service for OpenSearch

You can set up data transfer from Elasticsearch to Managed Service for OpenSearch indexes using Data Transfer. Proceed as follows:

1. Set up the source cluster.
2. Prepare your test data.
3. Configure the target cluster.
4. Set up and activate the transfer.
5. Test the transfer.

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

Required paid resourcesRequired paid resources

• Managed Service for OpenSearch cluster: 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 Virtual Private Cloud pricing).

Getting startedGetting started

1. Create a custom Elasticsearch installation.

2. Enable access to the cluster from Yandex Cloud.

3. Create a Managed Service for OpenSearch target cluster:

   Manually

   Terraform

   Create a Managed Service for OpenSearch target cluster using any suitable configuration with publicly accessible hosts.

   1. If you do not have Terraform yet, install it and configure the Yandex Cloud provider.

   2. Download the file with provider settings. Place it in a separate working directory and specify the parameter values.

   3. Download the data-transfer-es-mos.tf configuration file to your current working directory.

      This file describes:

      • Network.
      • Subnet.
      • Security group and rules required to connect to a Managed Service for OpenSearch cluster.
      • Managed Service for OpenSearch target cluster.
      • Transfer.

   4. In the data-transfer-es-mos.tf file, specify the following variables:

      • mos_version: OpenSearch version.
      • mos_admin_password: Managed Service for OpenSearch admin user password.
      • transfer_enabled: Set to 0 to ensure that no transfer is created until you create endpoints manually.

   5. Run the terraform init command in the directory with the configuration file. This command initializes the provider specified in the configuration files and enables you to use its resources and data sources.

   6. Validate your Terraform configuration files using this command:

      terraform validate
      

      Terraform will display any configuration errors detected in your files.

   7. Create the required infrastructure:

      1. Run this command to view the planned changes:

         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.

      2. If everything looks correct, apply the changes:

         1. Run this command:

            terraform apply
            

         2. Confirm updating the 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.

4. Install the following tools:

   • curl to make requests to clusters.

     sudo apt update && sudo apt install --yes curl
     

   • jq: For stream processing of JSON files.

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

Set up the source clusterSet up the source cluster

You can provide data from the Elasticsearch cluster as the admin user with the superuser role; however, it is more secure to create separate users with limited privileges for each task. To do this, create a user to execute the transfer:

1. In the source cluster, create a role with the create_index and write privileges for all indexes (*).

2. In the source cluster, create a user to run the transfer and assign the user the role you created.

Prepare your test dataPrepare your test data

1. In the source cluster, create a test index named people and define its schema:

   curl --user <username_in_source_cluster>:<source_cluster_user_password> \
        --header 'Content-Type: application/json' \
        --request PUT 'https://<address_of_Elasticsearch_host_with_Data_role>:9200/people' && \
   curl --user <source_cluster_user_name>:<source_cluster_user_password> \
        --header 'Content-Type: application/json' \
        --request PUT 'https://<address_of_Elasticsearch_host_with_Data_role>:9200/people/_mapping?pretty' \
        --data'
        {
              "properties": {
                 "name": {"type": "text"},
                 "age": {"type": "integer"}
              }
        }
        '
   

2. Populate the test index with data:

   curl --user <source_cluster_user_name>:<source_cluster_user_password> \
        --header 'Content-Type: application/json' \
        --request POST 'https://<address_of_Elasticsearch_host_with_Data_role>:9200/people/_doc/?pretty' \
        --data'
        {
              "name" : "Alice",
              "age" : "30"
        }
        ' && \
   curl --user <username_in_source_cluster>:<source_cluster_user_password> \
        --header 'Content-Type: application/json' \
        --request POST 'https://<address_of_Elasticsearch_host_with_Data_role>:9200/people/_doc/?pretty' \
        --data'
        {
              "name" : "Robert",
              "age" : "32"
        }
        '
   

3. Optionally, check the data in the test index:

   curl --user <username_in_target_cluster>:<user_password_in_target_cluster> \
        --header 'Content-Type: application/json' \
        --request GET 'https://<address_of_Elasticsearch_host_with_Data_role>:9200/people/_search?pretty'
   

Configure the target clusterConfigure the target cluster

1. Get an SSL certificate to connect to the Managed Service for OpenSearch cluster.

2. Optionally, create a user to execute the transfer.

   You can provide data to the Managed Service for OpenSearch cluster as the admin user with the superuser role; however, it is more secure to create separate users with limited privileges for each task.

   1. Create a role with the create_index and write privileges for all indexes (*).

   2. Create a user and assign this role to them.

Set up and activate the transferSet up and activate the transfer

1. Create an endpoint for the Elasticsearch source.

2. Create an endpoint for the OpenSearch target.

3. Create a transfer:

   Manually

   Terraform

   1. Create a Snapshot-type transfer configured to use the new endpoints.
   2. Activate the transfer and wait for its status to change to Completed.

   1. In the data-transfer-mes-mos.tf file, specify the following variables:

      • source_endpoint_id: Source endpoint ID.
      • target_endpoint_id: Target endpoint ID.
      • transfer_enabled: 1 to create a transfer.

   2. Validate your Terraform configuration files using this command:

      terraform validate
      

      Terraform will display any configuration errors detected in your files.

   3. Create the required infrastructure:

      1. Run this command to view the planned changes:

         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.

      2. If everything looks correct, apply the changes:

         1. Run this command:

            terraform apply
            

         2. Confirm updating the resources.

         3. Wait for the operation to complete.

   4. Activate the transfer and wait for its status to change to Completed.

Test the transferTest the transfer

Check that the Managed Service for OpenSearch cluster's people index contains the data that was sent:

curl --user <username_in_target_cluster>:<user_password_in_target_cluster> \
     --cacert ~/.opensearch/root.crt \
     --header 'Content-Type: application/json' \
     --request GET 'https://<address_of_OpenSearch_host_with_Data_Node_role>:9200/people/_search?pretty'

Delete the resources you createdDelete the resources you created

To reduce the consumption of resources you do not need, delete them:

1. Delete the transfer.

2. Delete the source and target endpoints.

3. Delete other resources using the same method used for their creation:

   Manually

   Terraform

   Delete the Managed Service for OpenSearch cluster.

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

   2. Delete resources:

      1. Run this command:

         terraform destroy
         

      2. Confirm deleting the resources and wait for the operation to complete.

      All the resources described in the Terraform manifests will be deleted.