Managing backups in Managed Service for MySQL
You can create backups and restore clusters from existing backups, including point-in-time recovery. For more information, see Backups in Managed Service for MySQL.
Managed Service for MySQL also creates automatic daily backups. You can set the backup start time.
Getting a list of backups
To get a list of cluster backups:
- Go to the folder page
and select Managed Service for MySQL. - Click the cluster name and select the
To get a list of all backups in a folder:
- Go to the folder page
and select Managed Service for MySQL. - In the left-hand panel, select
If you do not have the Yandex Cloud command line interface yet, install and initialize it.
The folder specified in the CLI profile is used by default. You can specify a different folder using the --folder-name
or --folder-id
parameter.
To get a list of MySQL cluster backups available in the default folder, run the command:
yc managed-mysql backup list
Result:
+--------------------------+---------------------+----------------------+---------------------+
| ID | CREATED AT | SOURCE CLUSTER ID | STARTED AT |
+--------------------------+---------------------+----------------------+---------------------+
| c9qgo11pud7kb3c******** | 2020-08-10 12:00:00 | c9qgo11pud7k******** | 2020-08-10 11:55:17 |
| ... |
+--------------------------+---------------------+----------------------+---------------------+
To get a list of cluster backups, use the listBackups REST API method for the Cluster resource or the ClusterService/ListBackups gRPC API call and provide the cluster ID in the clusterId
request parameter.
To get a list of backups for all the Managed Service for MySQL clusters in the folder, use the list REST API method for the Backup resource or the BackupService/List gRPC API call and provide the folder ID in the folderId
request parameter.
You can fetch the cluster ID with a list of clusters in the folder.
Getting information about backups
To get information about the backup of an existing cluster:
- Go to the folder page
and select Managed Service for MySQL. - Click the cluster name and select the
To get information about the backup of a previously deleted cluster:
- Go to the folder page
and select Managed Service for MySQL. - In the left-hand panel, select
If you do not have the Yandex Cloud command line interface yet, install and initialize it.
The folder specified in the CLI profile is used by default. You can specify a different folder using the --folder-name
or --folder-id
parameter.
To get information about a MySQL cluster backup, run the command:
yc managed-mysql backup get <backup_ID>
You can retrieve the backup ID with a list of backups.
To get information about a backup, use the get REST API method for the Backup resource or the BackupService/Get gRPC API call and provide the backup ID in the backupId
request parameter.
To find out the ID, retrieve a list of backups.
Creating a backup
- Go to the folder page
and select Managed Service for MySQL. - Click the cluster name and select the
- Click Create backup.
The service will start creating a backup without an additional confirmation.
If you do not have the Yandex Cloud command line interface yet, install and initialize it.
The folder specified in the CLI profile is used by default. You can specify a different folder using the --folder-name
or --folder-id
parameter.
To create a cluster backup:
-
View a description of the CLI command to create a MySQL cluster backup:
yc managed-mysql cluster backup --help
-
Request a backup to be created by specifying the cluster name or ID:
yc managed-mysql cluster backup <cluster_name_or_ID>
You can get the cluster ID and name with a list of clusters.
To create a backup, use the backup REST API method for the Cluster resource or the ClusterService/Backup gRPC API call and provide the cluster ID in the clusterId
request parameter.
You can fetch the cluster ID with a list of clusters in the folder.
Warning
While you are creating your backup, the cluster performance might degrade.
In single-host clusters, you create a backup by reading data from the master host while the solution for multi-host clusters is to read one of the replicas. At the same time, you can specify host priorities when creating backups.
Restoring clusters from backups
For a new cluster, you should set all the parameters that are required at creation, except for the cluster type.
To restore an existing cluster from a backup:
-
Go to the folder page
and select Managed Service for MySQL. -
Click the cluster name and select the
-
Click
-
Set up the new cluster. You can select a folder for the new cluster from the Folder list.
-
To restore the cluster state to the required point in time after creating this backup (Point-in-Time-Recovery), configure Date and time of recovery (UTC) as appropriate.
If you do not change the setting, the cluster will be restored to the state when the backup was completed.
-
Click Restore cluster.
To restore a previously deleted cluster from a backup:
-
Go to the folder page
and select Managed Service for MySQL. -
In the left-hand panel, select
-
Find the backup you need using the backup creation time and cluster ID. The Name column contains IDs in
<cluster_ID>:<backup_ID>
format. -
Click
-
Set up the new cluster. You can select a folder for the new cluster from the Folder list.
-
To restore the cluster state to the required point in time after creating this backup, configure Date and time of recovery (UTC) as appropriate. You can enter the value manually or select it from the drop-down calendar.
If you do not change the setting, the cluster will be restored to the state when the backup was completed.
-
Click Restore cluster.
Managed Service for MySQL will launch the operation to create a cluster from the backup.
If you do not have the Yandex Cloud command line interface yet, install and initialize it.
The folder specified in the CLI profile is used by default. You can specify a different folder using the --folder-name
or --folder-id
parameter.
To restore a cluster from a backup:
-
View a description of the CLI restore MySQL cluster command:
yc managed-mysql cluster restore --help
-
Getting a list of available MySQL cluster backups:
yc managed-mysql backup list
Result:
+--------------------------+---------------------+----------------------+---------------------+ | ID | CREATED AT | SOURCE CLUSTER ID | STARTED AT | +--------------------------+---------------------+----------------------+---------------------+ | c9qgo11pud7kb3c******** | 2020-08-10 12:00:00 | c9qgo11pud7k******** | 2020-08-10 11:55:17 | | ... | +--------------------------+---------------------+----------------------+---------------------+
The time when the backup was completed is shown in the
CREATED AT
column with a list of available backups, inyyyy-mm-dd hh:mm:ss
format (2020-08-10 12:00:00
in the example above). You can restore a cluster to any point in time starting with the point when the backup is created. -
Request the creation of a cluster from a backup:
yc managed-mysql cluster restore \ --backup-id=<backup_ID> \ --time=<time> \ --name=<cluster_name> \ --environment=<environment> \ --network-name=<network_name> \ --host zone-id=<availability_zone>,` `subnet-name=<subnet_name>,` `assign-public-ip=<public_access_to_host> \ --resource-preset=<host_class> \ --disk-size=<storage_size_in_GB> \ --disk-type=<disk_type>
Where:
-
--backup-id
: Backup ID. -
--time
: Time point to restore the MySQL cluster to, inyyyy-mm-ddThh:mm:ssZ
format. -
--name
: Cluster name. -
--environment
: Environment:PRESTABLE
: For testing purposes. The prestable environment is similar to the production environment and likewise covered by the SLA, but it is the first to get new functionalities, improvements, and bug fixes. In the prestable environment, you can test compatibility of new versions with your application.PRODUCTION
: For stable versions of your apps.
-
--network-name
: Network name. -
--host
: Host parameters:-
zone-id
: Availability zone. -
subnet-name
: Subnet name. Specify if two or more subnets are created in the selected availability zone. -
assign-public-ip
: Flag to be set if public access to the host is needed:true
orfalse
.
-
-
--resource-preset
: Host class. -
--disk-size
: Storage size in GB. -
disk-type
: Disk type:network-hdd
network-ssd
*local-ssd
network-ssd-nonreplicated
-
Use Terraform to restore:
- Existing cluster from a backup.
- Cluster created and deleted via the management console, CLI, or API.
To restore a cluster, you will need the backup ID. Retrieve a list of available MySQL cluster backups using the CLI:
yc managed-mysql backup list
Result:
+--------------------------+---------------------+----------------------+---------------------+
| ID | CREATED AT | SOURCE CLUSTER ID | STARTED AT |
+--------------------------+---------------------+----------------------+---------------------+
| c9qgo11pud7kb3c******** | 2020-08-10 12:00:00 | c9qgo11pud7k******** | 2020-08-10 11:55:17 |
| ... |
+--------------------------+---------------------+----------------------+---------------------+
To restore an existing cluster from a backup:
-
Create a Terraform configuration file for the new cluster.
Do not use resources of the databases (
yandex_mdb_mysql_database
) and users (yandex_mdb_mysql_user
). They will be restored from the backup. -
Add a block named
restore
to this configuration file:resource "yandex_mdb_mysql_cluster" "<cluster_name>" { ... restore { backup_id = "<backup_name>" time = "<time>" } }
In the
time
parameter, specify the time point, in theyyyy-mm-ddThh:mm:ss
format, to which you want to restore the MySQL cluster, starting from the creation of the selected backup.Note
The
time
parameter is optional. If you do not specify it, the cluster will be restored to the state when the recovery process was started. -
Make sure the settings are correct.
-
Using the command line, navigate to the folder that contains the up-to-date Terraform configuration files with an infrastructure plan.
-
Run the command:
terraform validate
If there are errors in the configuration files, Terraform will point to them.
-
-
Confirm updating the resources.
-
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.
-
If you are happy with the planned changes, apply them:
-
Run the command:
terraform apply
-
Confirm the update of resources.
-
Wait for the operation to complete.
-
-
Terraform will create a copy of the existing cluster. The databases and users are deployed from the selected backup.
Time limits
A Terraform provider sets the timeout for Managed Service for MySQL cluster operations:
- Creating a cluster, including by restoring one from a backup: 15 minutes.
- Editing a cluster, including the MySQL version update: 60 minutes.
- Deleting a cluster: 15 minutes.
Operations exceeding the set timeout are interrupted.
Add the timeouts
block to the cluster description, for example:
resource "yandex_mdb_mysql_cluster" "<cluster_name>" {
...
timeouts {
create = "1h30m" # 1 hour 30 minutes
update = "2h" # 2 hours
delete = "30m" # 30 minutes
}
}
To restore a previously deleted cluster from a backup:
-
Create a Terraform configuration file for the new cluster.
Do not use resources of the databases (
yandex_mdb_mysql_database
) and users (yandex_mdb_mysql_user
). They will be restored from the backup. -
In the configuration file, add a
restore
block with the name of the backup to restore the cluster from:resource "yandex_mdb_mysql_cluster" "<cluster_name>" { ... restore { backup_id = "<backup_ID>" } }
-
Make sure the settings are correct.
-
Using the command line, navigate to the folder that contains the up-to-date Terraform configuration files with an infrastructure plan.
-
Run the command:
terraform validate
If there are errors in the configuration files, Terraform will point to them.
-
-
Confirm updating the resources.
-
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.
-
If you are happy with the planned changes, apply them:
-
Run the command:
terraform apply
-
Confirm the update of resources.
-
Wait for the operation to complete.
-
-
Terraform will create the new cluster. The databases and users are deployed from the backup.
For more information, see the Terraform provider documentation
Time limits
A Terraform provider sets the timeout for Managed Service for MySQL cluster operations:
- Creating a cluster, including by restoring one from a backup: 15 minutes.
- Editing a cluster, including the MySQL version update: 60 minutes.
- Deleting a cluster: 15 minutes.
Operations exceeding the set timeout are interrupted.
Add the timeouts
block to the cluster description, for example:
resource "yandex_mdb_mysql_cluster" "<cluster_name>" {
...
timeouts {
create = "1h30m" # 1 hour 30 minutes
update = "2h" # 2 hours
delete = "30m" # 30 minutes
}
}
To restore a cluster from a backup, use the restore REST API method for the Cluster resource or the ClusterService/Restore gRPC API call and provide the following in the request:
- Backup ID in the
backupId
parameter. To find out the ID, retrieve a list of cluster backups. - Time point to which you want to restore the cluster, in the
time
parameter. - Name of the new cluster that will contain the data recovered from the backup, in the
name
parameter. It must be unique within the folder.
Setting the backup start time
In the management console
If you do not have the Yandex Cloud command line interface yet, install and initialize it.
The folder specified in the CLI profile is used by default. You can specify a different folder using the --folder-name
or --folder-id
parameter.
To set the backup start time in an existing cluster, use the update
command:
yc managed-mysql cluster update <cluster_name_or_ID> \
--backup-window-start=<time>
Where backup-window-start
is the backup start UTC time in HH:MM:SS
format.
You can get the cluster ID and name with a list of clusters.
-
Open the current Terraform configuration file with an infrastructure plan.
For more information about creating this file, see Creating a MySQL cluster.
-
Add a block named
backup_window_start
to the Managed Service for MySQL cluster description:resource "yandex_mdb_mysql_cluster" "<cluster_name>" { ... backup_window_start { hours = <hour> minutes = <minute> } }
Where:
hours
: Backup start hour (UTC).minutes
: Backup start minute (UTC).
-
Make sure the settings are correct.
-
Using the command line, navigate to the folder that contains the up-to-date Terraform configuration files with an infrastructure plan.
-
Run the command:
terraform validate
If there are errors in the configuration files, Terraform will point to them.
-
-
Confirm updating the resources.
-
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.
-
If you are happy with the planned changes, apply them:
-
Run the command:
terraform apply
-
Confirm the update of resources.
-
Wait for the operation to complete.
-
-
For more information, see the Terraform provider documentation
Time limits
A Terraform provider sets the timeout for Managed Service for MySQL cluster operations:
- Creating a cluster, including by restoring one from a backup: 15 minutes.
- Editing a cluster, including the MySQL version update: 60 minutes.
- Deleting a cluster: 15 minutes.
Operations exceeding the set timeout are interrupted.
Add the timeouts
block to the cluster description, for example:
resource "yandex_mdb_mysql_cluster" "<cluster_name>" {
...
timeouts {
create = "1h30m" # 1 hour 30 minutes
update = "2h" # 2 hours
delete = "30m" # 30 minutes
}
}
To set the backup start time, use the update REST API method for the Cluster resource or the ClusterService/Update gRPC API call and provide the following in the request:
- Cluster ID in the
clusterId
parameter. You can get it together with a list of clusters in the folder. - New backup start time in the
configSpec.backupWindowStart
parameter. - List of cluster configuration fields to be updated in the
updateMask
parameter (in this case,configSpec.backupWindowStart
).
Warning
This API method overrides all parameters of the object being modified that were not explicitly passed in the request to the default values. To avoid this, list the settings you want to change in the updateMask
parameter (one line separated by commas).
Setting host priorities when creating backup
The minimum host priority when creating backups is 0
, the maximum is 100
, and the default is 0
. A replicated host with the highest priority serves as the backup source. For more information, see Creating backups.
In the management console
If you do not have the Yandex Cloud command line interface yet, install and initialize it.
The folder specified in the CLI profile is used by default. You can specify a different folder using the --folder-name
or --folder-id
parameter.
To set the backup priority of a selected host, run this command:
yc managed-mysql host update <host_name> \
--cluster-name=<cluster_name> \
--backup-priority=<host_backup_priority>
Where backup-priority
is host backup priority, between 0
and 100
.
You can request the host name with a list of cluster hosts, and the cluster name, with a list of clusters in the folder.
To set the host priority, use the updateHosts REST API method for the Cluster resource or the ClusterService/UpdateHosts gRPC API call and provide the following in the request:
- Cluster ID in the
clusterId
parameter. You can retrieve it with a list of clusters in the folder. - Host name in the
updateHostSpecs.hostName
parameter. It may be retrieved with a list of hosts in the cluster. - New host priority value in the
updateHostSpecs.backupPriority
parameter. - List of cluster configuration fields to update (here,
updateHostSpecs.hostName
andupdateHostSpecs.backupPriority
) in theupdateMask
parameter.
Warning
This API method overrides all parameters of the object being modified that were not explicitly passed in the request to the default values. To avoid this, list the settings you want to change in the updateMask
parameter (one line separated by commas).