NFS backup driver

The backup driver for the NFS back end backs up volumes of any type to an NFS exported backup repository.

To enable the NFS backup driver, include the following option in the [DEFAULT] section of the cinder.conf file:

backup_driver = cinder.backup.drivers.nfs.NFSBackupDriver

The following configuration options are available for the NFS back-end backup driver.

Description of NFS backup driver configuration options

Configuration option = Default value


backup_container = None

(String) Custom directory to use for backups.

backup_enable_progress_timer = True

(Boolean) Enable or Disable the timer to send the periodic progress notifications to Ceilometer when backing up the volume to the backend storage. The default value is True to enable the timer.

backup_file_size = 1999994880

(Integer) The maximum size in bytes of the files used to hold backups. If the volume being backed up exceeds this size, then it will be backed up into multiple files. backup_file_size also determines the buffer size used to build backup files, so should be scaled according to available RAM and number of workers. backup_file_size must be a multiple of backup_sha_block_size_bytes.

backup_mount_attempts = 3

(Integer(min=1)) The number of attempts to mount NFS shares before raising an error.

backup_mount_options = None

(String) Mount options passed to the NFS client. See NFS man page for details.

backup_mount_point_base = $state_path/backup_mount

(String) Base dir containing mount point for NFS share.

backup_posix_path = $state_path/backup

(String) Path specifying where to store backups.

backup_sha_block_size_bytes = 32768

(Integer) The size in bytes that changes are tracked for incremental backups. backup_file_size has to be multiple of backup_sha_block_size_bytes.

backup_share = None

(String) NFS share in hostname:path, ipv4addr:path, or “[ipv6addr]:path” format.