Backup policies
Resource backups are created in Cloud Backup automatically according to backup policies.
You can start creating the policies after you activate Cloud Backup.
Note
You can create or update a policy using the Yandex Cloud management console, Terraform, or a JSON specification via the Yandex Cloud CLI or API.
The Yandex Cloud management console does not support some parameters from the JSON specification for policies.
After activation, the system automatically creates the following backup policies:
Default daily: Daily incremental backup with the last 15 backups retained.Default weekly: Weekly incremental backup with the last 15 backups retained.Default monthly: Monthly incremental backup with the last 15 backups retained.
By default, resources in Cloud Backup are not linked to any backup policies. To start creating backups, link your resource to one or more policies.
The backup policy specifies:
-
Backup type: Full or incremental. For more information, see Backup types.
Note
If you are using a policy with the
fastBackupEnabledoption and have run an antivirus scan prior to creating an incremental backup, the backup time may increase significantly. Read more in Interaction with an antivirus. -
Schedule type and settings:
Fixed schedule: Backup frequency in hours, days, weeks, or months. Use UTC±00:00 time.Interval between backups: Interval, in hours or days, between the end of the previous backup and the start of the new one.
-
Backup retention settings.
Note
Backups are created based on the local time of the resource. There may be a slight delay from the schedule depending on how loaded the service currently is.
Storing backups
You can set up backup storage for the policy. For each resource linked to a policy, you can store:
- All backups created under this policy.
- Only the last several backups.
- Only the backups younger than a certain age, e.g., those created during the last few days.
The settings apply to all resources linked to the policy.
Note
You cannot restore a VM backup to a server or a server backup to a VM. However, you can restore an external server backup to a Yandex BareMetal server.
If you make changes to the backup retention rules, by default they will take effect as soon as you create another backup. For more on the backup retention rule settings, see the next section.
Backup policy specification
In Cloud Backup, you can create or update backup policies based on a specification in JSON format by using the Yandex Cloud command line or making an API request.
The complete backup policy specification for Cloud Backup is detailed below. You can also view the current specification version in the REST API reference.
{
"compression": "string",
"format": "string",
"multiVolumeSnapshottingEnabled": bool,
"preserveFileSecuritySettings": bool,
"runLater": bool,
"sectorBySector": bool,
"validationEnabled": bool,
"lvmSnapshottingEnabled": bool,
"fileFilters": {
"exclusionMasks": [
"string"
],
"inclusionMasks": [
"string"
]
},
"reattempts": {
"enabled": bool,
"interval": {
"type": "string",
"count": "string"
},
"maxAttempts": "string"
},
"silentModeEnabled": bool,
"splitting": {
"size": "string"
},
"vmSnapshotReattempts": {
"enabled": bool,
"interval": {
"type": "string",
"count": "string"
},
"maxAttempts": "string"
},
"vss": {
"enabled": bool,
"provider": "string"
},
"archive": {
"name": "string"
},
"performanceWindow": {
"enabled": bool
},
"retention": {
"rules": [
{
"backupSet": [
"string"
],
"maxAge": {
"type": "string",
"count": "string"
},
"maxCount": "string",
}
],
"beforeBackup": bool
},
"scheduling": {
"backupSets": [
{
"time": {
"weekdays": [
"string"
],
"repeatAt": [
{
"hour": "string",
"minute": "string"
}
],
"repeatEvery": {
"type": "string",
"count": "string"
},
"timeFrom": {
"hour": "string",
"minute": "string"
},
"timeTo": {
"hour": "string",
"minute": "string"
},
"monthdays": [
"string"
],
"months": [
"string"
],
"type": "string"
},
"sinceLastExecTime": {
"delay": {
"type": "string",
"count": "string"
}
},
}
],
"enabled": bool,
"maxParallelBackups": "string",
"randMaxDelay": {
"type": "string",
"count": "string"
},
"scheme": "string",
"weeklyBackupDay": "string"
},
"cbt": "string",
"fastBackupEnabled": bool,
"quiesceSnapshottingEnabled": bool,
"prePostCommands": [
{
"cmd": "string",
"args": "string",
"enabled": bool,
"stopOnError": bool,
"type": "string",
"wait": bool,
"workdir": "string"
}
]
}
Specification description:
| Attribute | Description | Possible values |
|---|---|---|
compression |
Backup compression ratio. |
|
format |
Backup format. |
|
multiVolumeSnapshottingEnabled |
Backing up multiple volumes at the same time. |
|
preserveFileSecuritySettings |
Retaining file security settings. The parameter is no longer supported. |
|
runLater |
If the resource was Stopped during a scheduled backup, all skipped backup jobs will be executed after that resource starts. |
|
sectorBySector |
Sector-by-sector backup. Backs up all disk or volume sectors, including empty areas and unallocated space. For disks with unsupported file systems, this mode applies automatically. You cannot recover app data from a backup like that. |
|
validationEnabled |
Checks the possibility of recovering data from the new backup. During procedure, a checksum is calculated for each section available for recovery, so it can take a while. |
|
lvmSnapshottingEnabled |
Uses LVM to create a volume snapshot. If the snapshot cannot be created using LVM, it will be created using the Cloud Backup agent. |
|
cbt |
Changed Block Tracking (configuration for tracking backup contents). |
|
fastBackupEnabled |
Fast backup: setting for tracking changes to files. When enabled, file changes are detected by the file size and timestamp. When disabled, files are checked for changes by comparing their contents to backed up files. |
|
quiesceSnapshottingEnabled |
Using quiescing when creating backups. The parameter is no longer supported. |
|
Attribute sections with multiple nested values.
Setting up backup reattempts in the event of failures.
| Attribute | Description | Possible values |
|---|---|---|
reattempts.enabled |
Retry creating a backup if a noncritical error occur (e.g., failure to connect to a target disk). |
|
reattempts.interval.type |
Unit of time used to set the reattempt interval. |
|
reattempts.interval.count |
Interval between reattempts. | Integer |
reattempts.maxAttempts |
Maximum number of reattempts. If reached, the operation is considered failed. | Integer |
silentModeEnabled |
Silent mode to reduce the number of user interactions wherever possible. Disabled by default. |
|
splitting.size |
Splitting a backup into volumes of a preset size in bytes. If no value is specified, a backup is saved as a single file. | Integer |
Configuring backup reattempts in the event of failure.
| Attribute | Description | Possible values |
|---|---|---|
vmSnapshotReattempts.enabled |
Retry creating a backup if errors occur. |
|
vmSnapshotReattempts.interval.type |
Unit of time used to set the reattempt interval. |
|
vmSnapshotReattempts.interval.count |
Interval between reattempts. | Integer |
vmSnapshotReattempts.maxAttempts |
Maximum number of reattempts. If reached, the operation is considered failed. | Integer |
Volume Shadow Copy Service (VSS) setup. The service notifies applications with VSS support of the upcoming backup start. The applications save information from memory to disk, which ensures data integrity during backup.
| Attribute | Description | Possible values |
|---|---|---|
vss.enabled |
Enable VSS. |
|
vss.provider |
Choosing a VSS provider. |
|
archive.name |
Name of the archive being created. | String that may contain the following variables: [Machine Name], [Plan ID], [Plan Name], [Unique ID], and [Virtualization Server Type]. |
performanceWindow |
Enable a performance window to limit the impact of backups and storage maintenance on performance. |
|
Setting up rules for storing backups. The maxAge and maxCount attributes are mutually exclusive, i.e., the use of one makes it impossible to use the other.
| Attribute | Description | Possible values |
|---|---|---|
retention.rules.backupSet |
Set of backups for which the retention settings are specified. | String |
retention.rules.maxAge.type |
Setting a backup retention rule to delete outdated backups depending on their age in specified time units. |
|
retention.rules.maxAge.count |
Maximum backup retention period in time units set by the maxAge.type attribute. |
Integer |
retention.rules.maxCount |
Setting a backup retention rule to delete outdated backups depending on the specified maximum number of stored backups. | Integer |
retention.beforeBackup |
Applying backup retention rules before the end of the backup. When creating a policy by default or via the management console, the beforeBackup=false rule is set. The backup retention rule settings will take effect as soon as another backup is created. |
|
Setting up a backup schedule. The time (based on preset time) and sinceLastExecTime (with preset interval between backups) attributes are mutually exclusive, i.e., the use of one makes it impossible to use the other.
|
Attribute |
Description |
Possible values |
|
|
Days of the week to create backups on. You can specify multiple values separated by commas. |
|
|
|
Time to repeat backups at: hours. |
Integer from 0 to 23. |
|
|
Time to repeat backups at: minutes. |
Integer from 0 to 59. |
|
|
Units of time used to set the repeat backup interval. |
|
|
|
Backup reattempt interval in units set by the |
Integer. |
|
|
Start time for the backup interval (from): hours. |
Integer from 0 to 23. |
|
|
Start time for the backup interval (from): minutes. |
Integer from 0 to 59. |
|
|
End time for the backup interval (to): hours. |
Integer from 0 to 23. |
|
|
End time for the backup interval (to): minutes. |
Integer from 0 to 59. |
|
|
Day of the month to create backups on. You can specify multiple values separated by commas. |
Integer from 1 to 31. |
|
|
Making backups on the last day of each month. Warning If set to |
|
|
|
Months to create backups in. You can specify multiple values separated by commas. |
Integer from 1 to 12. |
|
|
Backup frequency. |
|
|
|
Units of time used to set the interval between backups. |
|
|
|
Interval between backups in time units set by the |
Integer. |
|
|
Scheduled backup. |
|
|
|
Maximum number of parallel backups; unlimited if no value is specified. |
Integer. |
|
|
Units of time used to set the maximum delay before running parallel jobs. |
|
|
|
Maximum delay before running parallel jobs in time units set by the |
Integer. |
|
|
Backup schedule scheme. |
|
|
|
Day of the week for the weekly backup. |
Integer from 1 to 7 |
Setting up filters. You can exclude files and folders from backups or, conversely, create backups of only specific elements of the file system.
To include or exclude files, add some criteria, e.g., file names, paths, or masks. * and ? wildcards are supported. Use a new line for each criterion. Criteria are case-insensitive.
Exclusion filters take precedence over inclusion filters.
| Attribute | Description | Value (example) |
|---|---|---|
exclusionMasks |
Criterion for files to exclude from the backup. | /tmp |
inclusionMasks |
Criterion for files to include into the backup. | /home/user* |
Setting actions Cloud Backup will perform before and after the backup.
| Attribute | Description | Value (example) |
|---|---|---|
cmd |
Command or path to the executable file that needs to be executed (run). | /usr/bin/myapp |
args |
Command line parameters to apply when executing the command (running the file). | -d -rw |
enabled |
Enabling or disabling the command execution (running the file). |
|
stopOnError |
Stopping the backup if there is an error during command execution (running the file). |
|
type |
Time of command execution (running the file). |
PRE_COMMAND, POST_COMMAND, PRE_DATA_COMMAND, and POST_DATA_COMMAND.The PRE_DATA_COMMAND and POST_DATA_COMMAND commands run in immediate proximity to the snapshot, while PRE_COMMAND and POST_COMMAND run at the very beginning and end of the entire backup process. |
wait |
Waiting for the command execution (file running) to complete before starting the backup. |
|
workdir |
Working directory to execute the command (run the file) in. | /etc/myapp/ |