Copying data from Managed Service for OpenSearch to Managed Service for ClickHouse® using Yandex Data Transfer
Data Transfer enables you to transfer data from a Managed Service for OpenSearch source cluster to Managed Service for ClickHouse®.
To transfer data:
If you no longer need the resources you created, delete them.
Required paid resources
- Managed Service for OpenSearch cluster: Use of computing resources and storage size (see Managed Service for OpenSearch pricing).
- Managed Service for ClickHouse® cluster: Use of computing resources allocated to hosts, storage and backup size (see Managed Service for ClickHouse® pricing).
- Public IP addresses if public access is enabled for cluster hosts (see Virtual Private Cloud pricing).
Getting started
Set up your data delivery infrastructure:
-
Create a Managed Service for OpenSearch source cluster with your preferred configuration, ensuring its hosts are publicly accessible.
-
In the same availability zone, create a Managed Service for ClickHouse® target cluster with any suitable configuration and publicly accessible hosts.
To connect to the cluster via Yandex WebSQL, enable WebSQL access in the cluster settings.
-
Get an SSL certificate to connect to the Managed Service for OpenSearch cluster.
-
Make sure the Managed Service for OpenSearch and Managed Service for ClickHouse® cluster security groups allow connecting from the internet.
-
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 opensearch-to-clickhouse.tf
configuration file to the same working directory.This file describes:
- Network.
- Subnet.
- Security group and rules allowing inbound connections to the Managed Service for OpenSearch and Managed Service for ClickHouse® clusters.
- Managed Service for OpenSearch source cluster and its
adminaccount. - Managed Service for ClickHouse® target cluster, its user account, and a database.
- Target endpoint.
- Transfer.
-
In the
opensearch-to-clickhouse.tffile, specify the following settings:-
source_admin_password: Managed Service for OpenSearch clusteradminpassword. -
mos_version: OpenSearch version. -
mch_db_name: Managed Service for ClickHouse® cluster database name. -
mch_username: Managed Service for ClickHouse® cluster user name. -
mch_user_password: Managed Service for ClickHouse® cluster user password. -
source_endpoint_id: Source endpoint ID. -
profile_name: Name of your CLI profile.If you do not have the Yandex Cloud CLI installed yet, install and initialize it.
-
-
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
. -
Prepare your test data
-
In the source cluster, create a test index named
peopleand define its schema:curl --cacert ~/.opensearch/root.crt \ --user <source_cluster_user_name>:<source_cluster_user_password> \ --header 'Content-Type: application/json' \ --request PUT 'https://<address_of_OpenSearch_host_with_DATA_role>:9200/people' && \ curl --cacert ~/.opensearch/root.crt \ --user <source_cluster_user_name>:<source_cluster_user_password> \ --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"} } } ' -
Populate the test index with data:
curl --cacert ~/.opensearch/root.crt \ --user <source_cluster_user_name>:<source_cluster_user_password> \ --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 --cacert ~/.opensearch/root.crt \ --user <source_cluster_user_name>:<source_cluster_user_password> \ --header 'Content-Type: application/json' \ --request POST 'https://<address_of_OpenSearch_host_with_DATA_role>:9200/people/_doc/?pretty' \ --data' { "name": "Robert", "age": "32" } ' -
Optionally, check the data in the test index:
curl --cacert ~/.opensearch/root.crt \ --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'
Set up and activate the transfer
-
Create a source endpoint for your pre-configured Managed Service for OpenSearch cluster using the following settings:
- Database type:
OpenSearch. - Connection settings:
- Connection type:
Managed Service for OpenSearch cluster. - Managed Service for OpenSearch cluster: Select the Managed Service for OpenSearch cluster from the list.
- User:
admin. - Password:
adminpassword.
- Connection type:
- Database type:
-
Create a target endpoint and set up the transfer:
ManuallyTerraform-
- Database type:
ClickHouse. - Endpoint parameters:
- Connection type: Select
Managed cluster. - Managed cluster: Select the Managed Service for ClickHouse® cluster from the list.
- User: Enter the Managed Service for ClickHouse® cluster user name.
- Password: Enter the Managed Service for ClickHouse® cluster user password.
- Database: Enter the Managed Service for ClickHouse® cluster database name.
- Connection type: Select
- Database type:
-
Create a Snapshot-type transfer configured to use the new endpoints.
-
Activate the transfer.
-
In the
opensearch-to-clickhouse.tffile, specify the following settings:source_endpoint_id: Source endpoint ID.transfer_enabled:1to create a target endpoint and 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 activate automatically upon creation.
-
-
Test your transfer
-
Wait for the transfer status to change to Completed.
-
Make sure that the data has been transferred from the source Managed Service for OpenSearch cluster to the Managed Service for ClickHouse® database:
Yandex WebSQLCLI-
Create a connection to the database in the Managed Service for ClickHouse® cluster.
-
Make sure the database contains the
peopletable populated with test data by running the following query via the connection you created:SELECT * FROM people;
-
Get an SSL certificate to connect to the Managed Service for ClickHouse® cluster.
-
If you do not have
clickhouse-client, install it. -
Connect to the database in the Managed Service for ClickHouse® cluster.
-
Check that the database contains the
peopletable populated with test data:SELECT * FROM people;
-
Delete the resources you created
To reduce the consumption of resources you do not need, delete them:
-
Delete other resources depending on how they were created:
ManuallyTerraform-
Delete the Managed Service for ClickHouse® cluster.
Yandex WebSQL will automatically delete the database connection in the Managed Service for ClickHouse® cluster.
-
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.
-
ClickHouse® is a registered trademark of ClickHouse, Inc