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

Important: The temporary configuration file created in this procedure contains the vCenter Server credentials in plaintext. For security purposes, delete this file after the backup task has been created.

The following items are backed up:

  • Configurations for OpenStack components
  • OpenStack control plane database
  • Deployment secrets

For information about backing up Cinder, see Configure the Backup Service for Cinder.

Prerequisites

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

Procedure

  1. Log in to the Integrated OpenStack Manager as the root user.
    ssh root@mgmt-server-ip
  2. 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
          hostname: vcserver-fqdn
          username: vcserver-admin
          password: vcserver-password
    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.

    vcserver-fqdn

    Enter the FQDN of the vCenter Server instance containing the content library.

    vcserver-admin

    Enter the username of a vCenter Server administrator.

    vcserver-password

    Enter the password of the specified vCenter Server administrator.

  3. Create the backup task with the configuration file.
    viocli create backupschedule -f <configuration-file>

Results

The backup task is created, and backups of your deployment are saved to the content library according to the specified schedule.