Migrating a Yandex StoreDoc cluster from version 4.4 to 6.0 using Yandex Data Transfer
You can migrate a sharded production database under load from a Yandex StoreDoc cluster version 4.4 to version 6.0.
To transfer data:
- Prepare the source cluster.
- Prepare the target cluster.
- Set up the transfers.
- Activate the transfers.
- Test the transfer.
If you no longer need the resources you created, delete them.
Required paid resources
- Yandex StoreDoc cluster: computing resources allocated to hosts, storage and backup size (see Yandex StoreDoc pricing).
- Public IP addresses if public access is enabled for cluster hosts (see Virtual Private Cloud pricing).
- Per transfer: Computing resources used and the number of data rows transferred (see Data Transfer pricing).
Getting started
Create a Yandex StoreDoc target cluster running version 6.0, identical to the version 4.4 cluster.
-
Create a Yandex StoreDoc (Managed Service for MongoDB) target cluster identical to the source cluster with the following settings:
- Cluster version:
6.0. - Database name:
db1. - Username:
user1. - Access to cluster hosts: Public.
Note
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.
- Cluster version:
-
If you are using security groups in a cluster, make sure they are configured correctly and allow connections to it.
-
Grant the
readWriterole on the databasedb1touser1. -
Enable cluster sharding and add the required number of shards.
-
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.
-
In your current working directory, create a
.tffile with the following contents:resource "yandex_mdb_mongodb_cluster" "old" { } -
Save the Yandex StoreDoc cluster ID for version 4.4 to an environment variable:
export MONGODB_CLUSTER_ID=<cluster_ID>You can get the cluster ID from the list of clusters in your folder.
-
Import the Yandex StoreDoc cluster settings for version 4.4 into the Terraform configuration:
terraform import yandex_mdb_mongodb_cluster.old ${MONGODB_CLUSTER_ID} -
Get the imported configuration:
terraform show -
Copy it from your terminal and paste it into the
.tffile. -
Create a new directory
imported-clusterand move your configuration file there. -
Modify the configuration so that you can use it to create a new cluster:
- Specify the new cluster name in the
resourcestring and in thenameargument. - Set
versionto6.0. - Delete the
created_at,health,id,sharded, andstatusarguments. - In the
hostsections, delete thehealthandnamearguments. - If the
maintenance_windowsection containstype = "ANYTIME", delete thehourargument. - Delete all
usersections. Useyandex_mdb_mongodb_userresource to add database users. - Delete all
databasesections. You can add databases using a separateyandex_mdb_mongodb_databaseresource. - Optionally, you can customize the configuration further as needed.
- Specify the new cluster name in the
-
Add the database resource to the configuration file:
resource "yandex_mdb_mongodb_database" "db1" { cluster_id = yandex_mdb_mongodb_cluster.<cluster_name>.id name = "db1" }Where
<cluster_name>is the name of your new cluster as specified in theyandex_mdb_mongodb_clusterresource. -
Add the resource for creating a user named
user1to the configuration file:resource "yandex_mdb_mongodb_user" "user1" { cluster_id = yandex_mdb_mongodb_cluster.<cluster_name>.id name = "user1" password = "<user_password>" permission { database_name = "db1" roles = ["readWrite"] } depends_on = [ yandex_mdb_mongodb_database.db1 ] }Where
<cluster_name>is the name of your new cluster as specified in theyandex_mdb_mongodb_clusterresource. -
Navigate to the
imported-clusterdirectory and get the authentication credentials. -
In the same directory, configure and initialize the provider. Instead of manually creating the provider configuration file, you can download it
. -
Move the configuration file to the
imported-clusterdirectory and specify the arguments. If you have not added the authentication credentials to environment variables, specify them in the configuration file. -
Validate your Terraform configuration:
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
. -
Timeouts
The Terraform provider sets the following timeouts for Yandex StoreDoc cluster operations:
- Creating a cluster, including by restoring one from a backup: 30 minutes.
- Editing a cluster: 60 minutes.
Operations exceeding the set timeout are interrupted.
How do I change these limits?
Add the timeouts block to the cluster description, for example:
resource "yandex_mdb_mongodb_cluster" "<cluster_name>" {
...
timeouts {
create = "1h30m" # An hour and a half
update = "2h" # Two hours
}
}
Prepare the source cluster
-
Create a user with the
readWriterole for the source database you want to replicate. -
Delete unused collections from the database.
-
Disable the unique constraints of indexes in the collections. They will be automatically reenabled after data migration.
-
Evaluate your database workload. If it exceeds 10,000 writes per second, schedule multiple transfers.
- Identify collections under high load.
- Distribute your collections across multiple transfers.
-
Allocate oplog storage with a 15-20% margin over the cluster disk size. This will allow Data Transfer to read changes from the source cluster throughout the data copy process.
Prepare the target cluster
If the source database has sharded collections, prepare the target database. Do not enable unique constraints for indexes.
Set up the transfers
-
Create source endpoints for each scheduled transfer and specify their settings:
-
Database type:
MongoDB. -
Connection type:
Yandex StoreDoc cluster. -
Yandex StoreDoc cluster:
<Yandex_StoreDoc_source_cluster_name>from the drop-down list. -
Authentication source:
<source_cluster_database_name>. -
User:
<username>. -
Password:
<password>. -
Included collections: For each endpoint, specify the list of included collections according to your transfer distribution plan.
-
Excluded collections: Specify
Time Seriescollections if your database has any. Data Transfer does not support migration of such collections.
-
-
Create target endpoints for each scheduled transfer and specify their settings:
-
Database type:
MongoDB. -
Connection type:
Yandex StoreDoc cluster. -
Yandex StoreDoc cluster:
<Yandex_StoreDoc_target_cluster_name>from the drop-down list. -
Authentication source:
db1. -
User:
user1. -
Password:
<password>. -
Database:
db1.
If your target database contains sharded collections, select either the
Do not cleanorTRUNCATEcleanup policy.Selecting the
DROPpolicy will result in the service deleting all the data from the target database, including sharded collections, and replacing them with new unsharded ones when a transfer is activated. -
-
Create Snapshot and replication-type transfers configured to use the previously created endpoints.
To speed up copying of large collections (over 1 GB), enable parallel copy in the transfer settings:
- Number of workers:
5or more - Number of threads:
8or more
The collection will be split into the specified number of parts that will be copied concurrently.
For parallel copy to work properly, the data type of the
_idfield must be the same for all documents in the same collection. If a transfer detects a type mismatch, the collection will not be split but transferred in a single thread instead. If needed, remove documents with mismatched data types from the collection prior to transfer.Note
If a document with a different data type is added to the collection after the transfer starts, the transfer will migrate it at the replication stage after parallel copying. However, when reactivated, the transfer will not be able to split the collection into parts because the
_idfield type requirement will not be met for some of the documents in the collection. - Number of workers:
Activate the transfers
- Activate the transfers.
- Wait for the transfer status to change to Replicating.
- Switch the source cluster to read-only mode.
- If you disabled unique constraints for indexes in the source database, enable them in the target database.
- Transfer the workload over to the target cluster.
- On the transfer monitoring page, wait for the Maximum data transfer delay metric to drop to zero for each transfer. This indicates that the target cluster now contains all changes made in the source cluster after the data copy completed.
- Deactivate the transfers and wait for their status to change to Stopped.
Test the transfer
-
Connect to the database
db1in the Yandex StoreDoc target cluster. -
Verify that the data collections have appeared in the
db1database:show collections db.<collection_name>.find()
Delete the resources you created
To minimize resource consumption, delete the resources you no longer need:
-
Delete the Yandex StoreDoc cluster version
6.0applying the same method used for its creation:ManuallyUsing Terraform-
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.
-
-