Migrating data from a third-party OpenSearch cluster using Yandex Data Transfer

With Data Transfer, you can transfer data from a third-party OpenSearch source cluster's indexes to Managed Service for OpenSearch indexes. To do this:

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

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

Getting startedGetting started

1. Enable access to the source OpenSearch cluster from Yandex Cloud.

2. Create a Managed Service for OpenSearch target cluster:

   Manually

   Terraform

   Create a Managed Service for OpenSearch target cluster in any suitable configuration with publicly available hosts.

   1. If you don't have Terraform, 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-os-mos.tf configuration file to the same 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-os-mos.tf file, specify these variables:

      • os_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.

      • profile_name: Your YC CLI profile name.

        If you do not have the Yandex Cloud command line interface yet, install and initialize it.

   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 the provider resources and data sources.

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

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

3. Install the utilities:

   • curl to make requests to clusters.

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

   • jq for JSON file stream processing.

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

Set up the source clusterSet up the source cluster

Create a user to execute the transfer.

You can provide data from the 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. (Optional) In the source cluster, create a role with the create_index and write privileges for all indexes (*).

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

Prepare the test dataPrepare the test data

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

   curl --user <username_in_source_cluster>:<user_password_in_source_cluster> \
        --header 'Content-Type: application/json' \
        --request PUT 'https://<address_of_OpenSearch_host_with_DATA_role>:9200/people' && \
   curl --user <username_in_source_cluster>:<user_password_in_source_cluster> \
        --header 'Content-Type: application/json' \
        --request PUT 'https://<address_of_OpenSearch_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 <username_in_source_cluster>:<user_password_in_source_cluster> \
        --header 'Content-Type: application/json' \
        --request POST 'https://<address_of_OpenSearch_host_with_DATA_role>:9200/people/_doc/?pretty' \
        --data'
        {
              "name": "Alice",
              "age": "30"
        }
        ' && \
   curl --user <username_in_source_cluster>:<user_password_in_source_cluster> \
        --header 'Content-Type: application/json' \
        --request POST 'https://<address_of_OpenSearch_host_with_DATA_role>:9200/people/_doc/?pretty' \
        --data'
        {
              "name": "Robert",
              "age": "32"
        }
        '
   

3. (Optional) 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_OpenSearch_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. (Optional) 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.

Prepare and activate the transferPrepare and activate the transfer

1. Create an endpoint for the source OpenSearch cluster.

2. Create an endpoint for the target Managed Service for OpenSearch cluster.

3. Create a transfer:

   Manually

   Terraform

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

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

      • source_endpoint_id: ID of the source endpoint.
      • target_endpoint_id: Target endpoint ID.
      • transfer_enabled: 1 to create a transfer.

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

2. Check that the people index in the Managed Service for OpenSearch cluster contains the data you sent:

   Bash

   OpenSearch Dashboards

   Run 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://<FQDN_of_OpenSearch_host_with_DATA_role>:9200/people/_search?pretty'
   

   1. Connect to the target cluster using OpenSearch Dashboards.
   2. Select the Global tenant.
   3. Open the control panel by clicking .
   4. Under OpenSearch Dashboards, select Discover.
   5. In the CHANGE INDEX PATTERN field, select the people index.

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.

3. Delete the other resources depending on how they were created:

   Manually

   Terraform

   1. Delete the Managed Service for OpenSearch cluster.

   2. Delete the subnet and network.

   1. In the terminal window, go to the directory containing the infrastructure plan.

   2. Delete the data-transfer-os-mos.tf configuration file.

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

   4. Confirm updating the resources.

      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 resources described in the data-transfer-os-mos.tf configuration file will be deleted.