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

The support cost includes:

• Managed Service for OpenSearch cluster fee: Using computing resources allocated to hosts (including hosts with the MANAGER role) and disk space (see Managed Service for OpenSearch pricing).
• Fee for public IP address assignment on 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 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 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-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 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.

      • profile_name: Name of your CLI profile.

        If you do not have the Yandex Cloud CLI installed 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 its resources and data sources.

   6. Make sure the Terraform configuration files are correct 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.

3. Install the following tools:

   • 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. Optionally, in the source cluster, create a role with the create_index and write privileges for all indexes (*).

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

Prepare the test dataPrepare the test data

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

   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 <source_cluster_username>:<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 <source_cluster_username>:<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. 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_OpenSearch_host_with_DATA_role>:9200/people/_search?pretty'
   

Configure the target clusterConfigure the target cluster

1. Obtain an SSL certificate for secure access 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.

Set up and activate the transferSet up 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 endpoints you created.
   2. Activate the transfer.

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

      • source_endpoint_id: Source endpoint ID.
      • target_endpoint_id: ID of the target endpoint.
      • transfer_enabled: 1 (create a transfer).

   2. Make sure the Terraform configuration files are correct 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.

      The transfer will activate automatically upon creation.

Test the transferTest the transfer

1. Wait for the transfer status to change to Completed.

2. Make sure the Managed Service for OpenSearch cluster's people index contains the sent data:

   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 the source and target endpoints.

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

   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.

      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.