openstack
/
openstack-manuals
Code Issues Proposed changes

Merge "Update Backup and Restore section for NFS driver"

This commit is contained in:
Jenkins 2015-05-01 15:24:16 +00:00 committed by Gerrit Code Review
parent 5e09a5b4cc c345705eee
commit ae9e099ca3
1 changed files with 51 additions and 2 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

53
doc/admin-guide-cloud/blockstorage/section_volume-backups.xml
View File

@ -1,6 +1,9 @@
<?xml version="1.0" encoding="UTF-8"?>
<section xmlns="http://docbook.org/ns/docbook" xmlns:xi="http://www.w3.org/2001/XInclude"
xmlns:xlink="http://www.w3.org/1999/xlink" version="5.0" xml:id="volume-backup-restore">
<section xmlns="http://docbook.org/ns/docbook"
xmlns:xi="http://www.w3.org/2001/XInclude"
xmlns:xlink="http://www.w3.org/1999/xlink"
version="5.0"
xml:id="volume-backup-restore">
<title>Back up and restore volumes</title>
<para>The <command>cinder</command> command-line interface provides the tools for creating a
volume backup. You can restore a volume from a backup as long as the backup's associated
@ -22,4 +25,50 @@
<para>For more information about how to export and import volume backup metadata, see <xref
linkend="volume-backup-restore-export-import"/>.</para>
</note>
<para>By default, the swift object store is used for the backup repository.</para>
<para>
If instead you want to use an NFS export as the backup repository,
add the following configuration options to the
<literal>[DEFAULT]</literal> section of the
<filename>cinder.conf</filename> file and restart the Block
Storage services:
</para>
<programlisting language="ini">backup_driver = cinder.backup.drivers.nfs
backup_share = <replaceable>HOST</replaceable>:<replaceable>EXPORT_PATH</replaceable></programlisting>
<para>
For the <option>backup_share</option> option, replace
<replaceable>HOST</replaceable> with the DNS resolvable host name or
the IP address of the storage server for the NFS share, and
<replaceable>EXPORT_PATH</replaceable> with the path to that
share. If your environment requires that non-default mount
options be specified for the share, set these as follows:
</para>
<programlisting language="ini">backup_mount_options = <replaceable>MOUNT_OPTIONS</replaceable></programlisting>
<para>
<replaceable>MOUNT_OPTIONS</replaceable> is a comma-separated
string of NFS mount options as detailed in the NFS man page.
</para>
<para>There are several other options whose default values may be overriden as appropriate for your environment:
</para>
<programlisting language="ini">backup_compression_algorithm = zlib
backup_sha_block_size_bytes = 32768
backup_file_size = 1999994880</programlisting>
<para>
The option <option>backup_compression_algorithm</option> can be
set to <literal>bz2</literal> or <literal>None</literal>. The
latter can be a useful setting when the server providing the share
for the backup repository itself performs deduplication or
compression on the backup data.
</para>
<para>
The option <option>backup_file_size</option> must be a multiple of
<option>backup_sha_block_size_bytes</option>. It is effectively
the maximum file size to be used, given your environment, to hold
backup data. Volumes larger than this will be stored in multiple
files in the backup repository. The
<option>backup_sha_block_size_bytes</option> option determines the size
of blocks from the cinder volume being backed up on which digital
signatures are calculated in order to enable incremental
backup capability.
</para>
</section>