Scheduled Backup

You can configure your deployment to be automatically backed up on a regular schedule.

The following items are backed up:

Configurations for OpenStack components
OpenStack control plane database
Deployment secrets

For information about backing up Cinder, see Cinder Volume Backup.

Prerequisites

Create a content library in your vCenter Server instance. For information about content libraries, see Using Content Libraries.

Procedure

In a text editor, create the configuration file for the scheduled backup in YAML format.

Use the following template:

---
namePrefix: backup-name-prefix
description: backup-description
backupSchedule: backup-schedule
retentionPolicy:
  maximumNumberOfBackup: max-backups
target:
   kind: contentLibrary
   contentLibrary:
      name:content-library-name

Option	Description
`backup-name-prefix`	Enter a prefix for the backup files. The alphanumeric string can include the special character (-).
`backup-description`	Enter a description of the backup.
`backup-schedule`	Specify the backup schedule as a five-field cron expression. For example, enter `"5 0 * * *"` to back up every day at 00:05.
`max-backups`	The maximum number of backups to retain. Enter an integer greater than 0.
`content-library-name`	Enter the name of the Content Library for the backup save.

Specify the vCenter Server for the scheduled backup.
```
viocli create vcenter --vc_hostname <hostname> --vc_password <password> --vc_username <username>
```
Or use an alias for the Kubernetes command-line utility to get the vCenter Server from the deployment.
```
osctl get vcenter
```
Create the backup task with the configuration file and the vCenter Server.
```
viocli create backupschedule -f <configuration-file> --content-vcenter <vcenter-name>
```
The backup task is created, and backups of your deployment are saved to the content library according to the specified schedule.

Verify the backup schedule.

viocli get backupschedule

Detail information about the backup cronjob is present in the output when you check scheduled backups.

Example output:

SCHEDULE NAME       STATUS    CREATION DATE                  NAME PREFIX   MAX BACKUPS RETAINED   KIND             LOCATION                          DESCRIPTION
backupschedule322   Unknown   Wed Jun 17 13:53:42 UTC 2020   vio7-backup   2                      ContentLibrary   192.168.111.29:backupcontentlib   Backups for VIO7 deployment

To change the configurations of a scheduled backup, perform the following:
1. Edit the backup schedule.
```
osctl edit backupschedule <backup_schedule_name>
```
2. If you want to change backupSchedule frequency, change backupSchedule field under spec to target frequency.
```
spec:
  backupSchedule: <target-frequency>
```
3. If you want to change retentionPolicy, change maximumNumberOfBackup field under spec to target number.
```
spec:
  retentionPolicy:
    maximumNumberOfBackup: <target-num>
```
4. If you want to change content library name, change name field under contentLibrary to target name.
```
spec:
  target:
    contentLibrary:
      name: <target-contentLibrary-name>
    kind: contentLibrary
```
5. Save the change and exit.
Note: Do not change any other field not mentioned here.

Results

To delete a scheduled backup: viocli delete backupschedule <backup_schedule_name>.

Delete the command using the schedule name from the example: viocli delete backupschedule backupschedule322.