Creating a disk snapshot schedule

If you do not have the Yandex Cloud CLI installed yet, install and initialize it.

By default, the CLI uses the folder specified when creating the profile. To change the default folder, use the yc config set folder-id <folder_ID> command. You can also set a different folder for any specific command using the --folder-name or --folder-id parameter.

1. See the description of the CLI commands for managing schedules:

   yc compute snapshot-schedule --help
   yc compute snapshot-schedule create --help
   

2. Create a schedule using a cron expression:

   yc compute snapshot-schedule create <schedule_name> \
     --expression <cron_expression>
   

   Note

   The snapshot creation time is specified in UTC±00:00.

   If you need to configure a snapshot retention policy, specify the --snapshot-count or --retention-period parameter, such as follows:

   • --snapshot-count 5: Retain 5 latest snapshots.
   • --retention-period 72h: Retain snapshots for the last 3 days.

   To add the start date for a schedule, specify the --start-at parameter. Here is an example:

   • --start-at "2022-12-31T16:39:00+05:00": Schedule starts at 16:39 UTC+5 on December 31, 2022.
   • --start-at "2h": Schedule starts two hours before the current time point.

   For more information about the yc compute snapshot-schedule create command, see the CLI reference.

3. To add disks to your schedule, get disk IDs:

   yc compute disk list --format yaml
   

   Result:

   - id: epdcq9g3co9s********
     folder_id: e1ea8s8l71li********
     created_at: "2022-10-13T14:37:44Z"
   ...
     instance_ids:
       - fhm1c7u23aiq********
     disk_placement_policy: {}
   

4. Add disks to the schedule:

   yc compute snapshot-schedule add-disks <schedule_name_or_ID> \
     --disk-id <disk_1_ID>,<disk_2_ID>
   

   Result:

   done (3s)
   id: fc8e52mvchb2********
   folder_id: e1ea8s8l71li********
   ...
     expression: 36 14 */1 * *
   snapshot_count: "3"
   snapshot_spec: {}
   

If you do not have Terraform yet, install it and configure the Yandex Cloud provider.

1. In the Terraform configuration file, define the parameters of the resource you want to create:

   resource "yandex_compute_snapshot_schedule" "default" {
     name = "<schedule_name>"
   
     schedule_policy {
       expression = "<cron_expression>"
     }
   
     snapshot_count = <number_of_snapshots_per_disk>
   
     snapshot_spec {
       description = "<snapshot_description>"
       labels = {
         <snapshot_label_key> = "<snapshot_label_value>"
       }
     }
   
     disk_ids = ["<disk_1_ID>", "<disk_2_ID>"]
   }
   

   Where:

   • name: Schedule name. This is a required parameter.
   • schedule_policy: Section with schedule parameters. It contains the expression field with a cron expression. This is a required parameter.
   • snapshot_count: Maximum number of snapshots per disk. This is an optional parameter.
   • snapshot_spec: Section with additional snapshot parameters. This is an optional parameter. It may contain the following fields:
     • description: Snapshot description.
     • labels: Snapshot label in <key> = "<value>" format.
   • disk_ids: IDs of disks to create snapshots for. This is a required parameter.

   For more information about yandex_compute_snapshot_schedule properties, see this Terraform provider article.

2. Create the resources:

   1. In the terminal, go to the directory where you edited the configuration file.

   2. Make sure the configuration file is correct using this command:

      terraform validate
      

      If the configuration is correct, you will get this message:

      Success! The configuration is valid.
      

   3. Run this command:

      terraform plan
      

      You will see a detailed list of resources. No changes will be made at this step. If the configuration contains any errors, Terraform will show them.

   4. Apply the changes:

      terraform apply
      

   5. Type yes and press Enter to confirm the changes.

This will create a schedule in the specified folder. You can check the new schedule and its settings using the management console or this CLI command:

yc compute snapshot-schedule get <schedule_name>

1. Get a list of disks using the list REST API method for the Disk resource or the DiskService/List gRPC API call.

   You can create snapshots of network disks and drives, such as HDDs, SSDs, and non-replicated SSDs, as well as ultra high-speed network storages with three replicas (SSD).

   For non-replicated SSDs and ultra high-speed network storages with three replicas (SSD), the snapshot time is not determined.

   To create snapshots of local disks residing on dedicated hosts, use Yandex Cloud Backup. This service supports Ubuntu, CentOS, CentOS Stream, and Windows Server.

2. Create a snapshot schedule using the create REST API method for the SnapshotSchedule resource or the SnapshotScheduleService/Create gRPC API call.